org.trianacode.gui.main.imp

Class TrianaTool

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.trianacode.gui.main.imp.TrianaTool

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, TrianaColorConstants

Direct Known Subclasses:

ForShowTool, TrianaTask

public abstract class TrianaTool
extends javax.swing.JPanel
implements TrianaColorConstants

The graphical representation of a tool.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NAME_LENGTH the width of the graphical component in terms of the number of letters displayed by default
static int	STRIPE_ANGLE_OFFSET
static java.lang.String	SUB_NAME
static java.lang.String	SUB_NAME_VALUE
static int	THICK_STRIPE_OFFSET
static int	THICK_STRIPE_WIDTH
static int	THIN_STRIPE_OFFSET
static int	THIN_STRIPE_WIDTH

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.trianacode.gui.hci.color.TrianaColorConstants

BACKGROUND_COLOR, CABLE_COLOR, CONTROL_CABLE_COLOR, DEFAULT_ERROR_COLOR, ERROR_NODE_COLOR, ERROR_TOOL_COLOR, GROUP_TOOL_COLOR, NAME_COLOR, NAME_ELEMENT, NODE_COLOR, PROGRESS_COLOR, PROGRESS_ELEMENT, SHOW_TOOL_CONNECTED_COLOR, SHOW_TOOL_CONNECTED_ELEMENT, SHOW_TOOL_UNCONNECTED_COLOR, SHOW_TOOL_UNCONNECTED_ELEMENT, STRIPE_ELEMENT, TOOL_COLOR, TOOL_ELEMENT, TRIGGER_NODE_COLOR

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TrianaTool(Tool tool)
TrianaTool(Tool tool, java.awt.LayoutManager layout)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotify()
void	clearError() Clears the current error state
void	dispose() Disposes of the tool and its associated windows
protected void	drawRectangle(java.awt.Graphics graphs, java.awt.Color color, java.awt.Color orig) Paints the main tool rectangle
protected void	drawStripes(java.awt.Graphics graphs, java.awt.Color col, int width, int offset) Paints stripes on the main tool rectangle of a certain color, width and slant (offset)
java.lang.String	getErrorMessage()
protected java.awt.Component	getMainComponent() Initialises the main icon
NodeComponent	getNodeComponent(Node node)
java.awt.Color	getStripeColor()
int	getStripeOffset()
int	getStripeWidth()
Tool	getTool()
java.awt.Color	getToolColor()
java.lang.String	getToolName() Gets the name of the task
void	invalidateSize() Notifies that the size of the tool should be changed when the tool is repainted
boolean	isErrorState()
boolean	isSelected() Returns true if the particular tool is selected
void	paintComponent(java.awt.Graphics graphs) Paints the Triana Tool by rendering its name in the middle of the icon.
protected void	removeNodeComponent(Node node) Removes the input node at the specified index
void	removeNotify()
void	setError(java.lang.String message) Sets the tool into an error state with the specified message
protected void	setMainComponent(java.awt.Component comp) Initialises the main icon
protected void	setNodeComponent(Node node, NodeComponent comp) Inserts an input node component at the specified index
void	setSelected(boolean state) Sets the triana tool as selected (i.e.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME_LENGTH

public static int DEFAULT_NAME_LENGTH

the width of the graphical component in terms of the number of letters displayed by default

THICK_STRIPE_WIDTH

public static int THICK_STRIPE_WIDTH

THICK_STRIPE_OFFSET

public static int THICK_STRIPE_OFFSET

THIN_STRIPE_WIDTH

public static int THIN_STRIPE_WIDTH

THIN_STRIPE_OFFSET

public static int THIN_STRIPE_OFFSET

STRIPE_ANGLE_OFFSET

public static int STRIPE_ANGLE_OFFSET

SUB_NAME

public static final java.lang.String SUB_NAME

See Also:

Constant Field Values

SUB_NAME_VALUE

public static final java.lang.String SUB_NAME_VALUE

See Also:

Constant Field Values

Constructor Detail

TrianaTool

public TrianaTool(Tool tool)

TrianaTool

public TrianaTool(Tool tool,
          java.awt.LayoutManager layout)

Method Detail

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JComponent

getTool

public Tool getTool()

Returns:

the Task which this triana task represents.

setMainComponent

protected void setMainComponent(java.awt.Component comp)

Initialises the main icon

getMainComponent

protected java.awt.Component getMainComponent()

Initialises the main icon

setNodeComponent

protected void setNodeComponent(Node node,
                    NodeComponent comp)

Inserts an input node component at the specified index

removeNodeComponent

protected void removeNodeComponent(Node node)

Removes the input node at the specified index

getNodeComponent

public NodeComponent getNodeComponent(Node node)

Returns:

the input node component at the specified index

getToolName

public java.lang.String getToolName()

Gets the name of the task

setError

public void setError(java.lang.String message)

Sets the tool into an error state with the specified message

clearError

public void clearError()

Clears the current error state

isErrorState

public boolean isErrorState()

Returns:

true if the tool is currently in an error state

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

the error message for the error state (null if not in error state)

invalidateSize

public void invalidateSize()

Notifies that the size of the tool should be changed when the tool is repainted

getToolColor

public java.awt.Color getToolColor()

Returns:

the unselected color for this tool (mainTrianaNormal by default). Should be overridden to change to tool color.

getStripeColor

public java.awt.Color getStripeColor()

Returns:

the color of the stripe on the tool, or the standard tool color if no stipes

getStripeWidth

public int getStripeWidth()

Returns:

the color of the stripe on the tool, or the standard tool color if no stipes

getStripeOffset

public int getStripeOffset()

Returns:

the color of the stripe on the tool, or the standard tool color if no stipes

setSelected

public void setSelected(boolean state)

Sets the triana tool as selected (i.e. it appears depressed)

isSelected

public boolean isSelected()

Returns true if the particular tool is selected

paintComponent

public void paintComponent(java.awt.Graphics graphs)

Paints the Triana Tool by rendering its name in the middle of the icon. Note that the size of the icon is not determined until this class is extended to produce a ToolImp, ToolBox or a TrianaTool.

Overrides:

paintComponent in class javax.swing.JComponent

drawRectangle

protected void drawRectangle(java.awt.Graphics graphs,
                 java.awt.Color color,
                 java.awt.Color orig)

Paints the main tool rectangle

drawStripes

protected void drawStripes(java.awt.Graphics graphs,
               java.awt.Color col,
               int width,
               int offset)

Paints stripes on the main tool rectangle of a certain color, width and slant (offset)

dispose

public void dispose()

Disposes of the tool and its associated windows