org.trianacode.gui.hci

Class GUIEnv

java.lang.Object

org.trianacode.gui.hci.GUIEnv

public class GUIEnv
extends java.lang.Object

Class GUIEnv sets stores classes which are accessed from other GUI objects e.g. a number of object need access to the main ApplicationFrame

Constructor Summary

Constructors

Constructor and Description
GUIEnv()

Method Summary

Methods

Modifier and Type	Method and Description
static java.applet.Applet	getApplet()
static ApplicationFrame	getApplicationFrame()
static java.awt.Color	getCableColour(java.lang.Class type) Returns the colour of the cable for this class type.
static java.awt.Color	getCableColour(java.lang.String type) Returns the colour of the cable for this type.
static java.util.TreeMap	getCableColours()
static java.util.Hashtable	getColorTable()
static ColorTableEntry[]	getColorTableEntries()
static DesktopView	getDesktopViewFor(TaskGraph group)
static java.lang.String	getHTMLEditorCommand()
static java.lang.String	getHTMLViewerCommand()
static javax.swing.ImageIcon	getIcon(java.lang.String file)
static java.awt.Image	getImage(java.lang.String file)
static java.lang.String	getJavaEditorCommand()
static java.awt.event.MouseListener	getMouseListener() Sets the action listener to the one specified
static DesktopView	getSelectedDesktopView()
static boolean	getTipOfTheDay() Gets the tip of the day dialof off or on.
static TrianaClient	getTrianaClientFor(Task task)
static javax.swing.ImageIcon	getTrianaIcon()
static java.awt.Image	getTrianaImage() Returns an image to use as the icon when TrianaWindow is iconified.
static boolean	isAutoConnect()
static boolean	isSmoothCables()
static void	loadDefaultColours() loads default colours for the types from the system's type file.
static void	openURL(java.lang.String url) Static method to display an HTML page using the default web browser.
static void	removeTaskGraphContainer(DesktopView cont) Remove the specified main triana from the workspace
static boolean	restoreLast()
static void	setApplet(boolean mode, java.lang.String homeDir, java.applet.Applet appl) Called when we are running Triana as an applet.
static void	setAsApplet(java.lang.String homeDir, java.applet.Applet applet) Called when we are running Triana as an applet.
static void	setAutoConnect(boolean state) Sets whether auto connecting of tasks is enabled
static void	setCableColor(java.lang.String type, java.awt.Color color)
static void	setColorTableEntry(ColorTableEntry entry) Sets the Color Table property so it can be saved
static void	setExtendedDescriptions(boolean state) Set whether or not to display extended tool tips.
static void	setHTMLEditorCommand(java.lang.String cmd) sets the HTML editor command i.e.
static void	setHTMLViewerCommand(java.lang.String cmd) sets the HTML viewer command i.e.
static void	setJavaEditorCommand(java.lang.String cmd) sets the java editor command i.e.
static void	setMouseListener(java.awt.event.MouseListener m) Sets the mouse listener for the tools to the one specified
static void	setNodeEditIcons(boolean state) Set whether or not to display extended tool tips.
static void	setPopUpDescriptions(boolean state) Enables/disables the showing of popup desciptions
static void	setRestoreLast(boolean state) Sets whether restore from last state at startup is set
static void	setSmoothCables(boolean state) Sets whether smooth cables is enabled
static void	setTipOfTheDay(boolean state) Sets the tip of the day dialof to off or on.
static void	setTipOfTheDay(int num) Sets the tip of the day number.
static void	showEditorFor(java.lang.String editor, java.lang.String filename) Runs the given editor (the editor string is the command-line for the editor) for the particular fileName.
static boolean	showExtendedDescriptions()
static boolean	showNodeEditIcons()
static boolean	showPopUpDescriptions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GUIEnv

public GUIEnv()

Method Detail

getApplicationFrame

public static ApplicationFrame getApplicationFrame()

Returns:

a reference to the main Triana application window

getSelectedDesktopView

public static DesktopView getSelectedDesktopView()

removeTaskGraphContainer

public static void removeTaskGraphContainer(DesktopView cont)

Remove the specified main triana from the workspace

getDesktopViewFor

public static DesktopView getDesktopViewFor(TaskGraph group)

getTrianaClientFor

public static TrianaClient getTrianaClientFor(Task task)

Returns:

the TrianaClient for the specified task (null if unknown)

setAutoConnect

public static void setAutoConnect(boolean state)

Sets whether auto connecting of tasks is enabled

isAutoConnect

public static boolean isAutoConnect()

Returns:

true if auto connecting of tasks is enabled

setSmoothCables

public static void setSmoothCables(boolean state)

Sets whether smooth cables is enabled

isSmoothCables

public static boolean isSmoothCables()

Returns:

whether cables are smooth

setRestoreLast

public static void setRestoreLast(boolean state)

Sets whether restore from last state at startup is set

restoreLast

public static boolean restoreLast()

Returns:

whether restore from last state at startup is set, defaults to false

setMouseListener

public static void setMouseListener(java.awt.event.MouseListener m)

Sets the mouse listener for the tools to the one specified

getMouseListener

public static java.awt.event.MouseListener getMouseListener()

Sets the action listener to the one specified

openURL

public static void openURL(java.lang.String url)

Static method to display an HTML page using the default web browser.

showEditorFor

public static void showEditorFor(java.lang.String editor,
                 java.lang.String filename)

Runs the given editor (the editor string is the command-line for the editor) for the particular fileName.

showPopUpDescriptions

public static boolean showPopUpDescriptions()

Returns:

the state of popup desciptions

setPopUpDescriptions

public static void setPopUpDescriptions(boolean state)

Enables/disables the showing of popup desciptions

showExtendedDescriptions

public static boolean showExtendedDescriptions()

Returns:

whether or not to show extended tool tips

setExtendedDescriptions

public static void setExtendedDescriptions(boolean state)

Set whether or not to display extended tool tips.

showNodeEditIcons

public static boolean showNodeEditIcons()

Returns:

whether or not to show extended tool tips

setNodeEditIcons

public static void setNodeEditIcons(boolean state)

Set whether or not to display extended tool tips.

getJavaEditorCommand

public static java.lang.String getJavaEditorCommand()

Returns:

the java editor command i.e. the editor chosen by the user

setJavaEditorCommand

public static void setJavaEditorCommand(java.lang.String cmd)

sets the java editor command i.e. the editor chosen by the user

getHTMLEditorCommand

public static java.lang.String getHTMLEditorCommand()

Returns:

the HTML editor command i.e. the editor chosen by the user

getHTMLViewerCommand

public static java.lang.String getHTMLViewerCommand()

Returns:

the HTML viewer command i.e. the editor chosen by the user

setHTMLEditorCommand

public static void setHTMLEditorCommand(java.lang.String cmd)

sets the HTML editor command i.e. the editor chosen by the user

setHTMLViewerCommand

public static void setHTMLViewerCommand(java.lang.String cmd)

sets the HTML viewer command i.e. the editor chosen by the user

setTipOfTheDay

public static void setTipOfTheDay(boolean state)

Sets the tip of the day dialof to off or on.

setColorTableEntry

public static void setColorTableEntry(ColorTableEntry entry)

Sets the Color Table property so it can be saved

Parameters:

entry -

getColorTableEntries

public static ColorTableEntry[] getColorTableEntries()

getColorTable

public static java.util.Hashtable getColorTable()

Returns:

the color table map.

getTipOfTheDay

public static boolean getTipOfTheDay()

Gets the tip of the day dialof off or on.

setTipOfTheDay

public static void setTipOfTheDay(int num)

Sets the tip of the day number.

setApplet

public static void setApplet(boolean mode,
             java.lang.String homeDir,
             java.applet.Applet appl)

Called when we are running Triana as an applet.

setAsApplet

public static void setAsApplet(java.lang.String homeDir,
               java.applet.Applet applet)

Called when we are running Triana as an applet.

getApplet

public static java.applet.Applet getApplet()

Returns:

the refernce to the applet object if this run is an applet, null otherwise.

getCableColours

public static java.util.TreeMap getCableColours()

Returns:

a hashtable containing each Triana type and its associated colour. These are taken from the system types file or from the users configuration file

getCableColour

public static java.awt.Color getCableColour(java.lang.String type)

Returns the colour of the cable for this type.

setCableColor

public static void setCableColor(java.lang.String type,
                 java.awt.Color color)

getCableColour

public static java.awt.Color getCableColour(java.lang.Class type)

Returns the colour of the cable for this class type.

loadDefaultColours

public static void loadDefaultColours()

loads default colours for the types from the system's type file. This is used when Triana is first run.

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String file)

getImage

public static java.awt.Image getImage(java.lang.String file)

getTrianaImage

public static java.awt.Image getTrianaImage()

Returns an image to use as the icon when TrianaWindow is iconified.

Returns:

image to use.

getTrianaIcon

public static javax.swing.ImageIcon getTrianaIcon()