org.trianacode.gui.panels

Class ParameterPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.trianacode.gui.panels.ParameterPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

AddParameterNodePanel, ArrayViewerPanel, BasicIWIRPanel, ClassPathPanel, CompilePanel, CondorPanel, CondorSubmitDescriptionPanel, ConstViewPanel, DBExplorePanel, EventViewerPanel, FilePanel, GnuplotGrapherPanel, GroupEditor, GroupParameterPanel, GUICreaterPanel, HetdyneFpanel, HistogrammerPanel, HTMLViewPanel, ImagePanel, ImportGSMPanel, InOutPanel, IsPanel, IwirCreatorPanel, JPlotterPanel, LoadMoviePanel, LoadMP3Panel, LoadSoundPanel, LoopPanel, NodeConfigPanel, NodeEditor, OptionsPanel, PanelHolder, ParameterPanelImp, ParamNameChangePanel, ParamViewPanel, PastePanel, SaveHistoryPanel, SequenceBufferPanel, SerializePanel, SettingObjectOutputPanel, SGTGrapherPanel, SGTTimeFreqPanel, StringEditorPanel, StringGenPanel, StringViewPanel, TextAreaPanel, ToolBoxPanel, TriggerButtonPanel, UnitPanel, UnknownToolBoxTypePanel

public abstract class ParameterPanel
extends javax.swing.JPanel
implements WindowButtonConstants, TaskListener

A base panel that provides methods for updating task parameters.

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 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.windows.WindowButtonConstants

NO_BUTTONS, OK_BUTTON, OK_CANCEL_APPLY_BUTTONS, OK_CANCEL_BUTTONS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ParameterPanel() Creates a Triana parameter panel associated with the specified task.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyClicked() Called when the apply button is clicked on the parameter window.
void	cancelClicked() Called when the cancel button is clicked on the parameter window.
abstract void	dispose() This method is called when the panel is finished with.
void	disposePanel() Disposes of the parameter panel, calls dispose on the subclassing panel
javax.swing.JMenuBar	getMenuBar()
java.lang.Object	getParameter(java.lang.String name) Returns the value of a parameter in the associated task
byte	getPreferredButtons() This method returns WindowButtonConstants.OK_CANCEL_APPLY_BUTTONS by default.
Task	getTask()
protected java.awt.Window	getWindow() Convinence method that returns the window the panel is in.
ParameterWindowInterface	getWindowInterface()
abstract void	init() This method is called when the task is set for this panel.
boolean	isAlwaysOnTopPreferred() This method returns true by default.
boolean	isAutoCommit()
boolean	isAutoCommitByDefault() This method returns false by default.
boolean	isAutoCommitVisible() This method returns true by default.
boolean	isParameterName(java.lang.String name) Returns true if a value is set for a parameter in the associated task
void	nodeAdded(TaskNodeEvent event) Called when a data input node is added.
void	nodeRemoved(TaskNodeEvent event) Called before a data input node is removed.
void	okClicked() Called when the ok button is clicked on the parameter window.
void	parameterUpdate(java.lang.String paramname, java.lang.Object value) This method is called when a parameter in the associated task is updated.
void	parameterUpdated(ParameterUpdateEvent event) Called when the value of a parameter is changed, including when a parameter is removed.
void	removeParameter(java.lang.String name) Removes a paremeter in the associated task.
abstract void	reset() This method is called when the panel is reset or cancelled.
void	setMenuBar(javax.swing.JMenuBar menubar) Sets the menu bar for this component
void	setParameter(java.lang.String name, java.lang.Object value) Sets a paremeter in the associated task to the specified value.
void	setTask(Task task)
void	setWindowInterface(ParameterWindowInterface comp) Sets the component that determines whether parameter changes are committed automatically
void	taskDisposed(TaskDisposedEvent event) Called before the task is disposed
void	taskPropertyUpdate(TaskPropertyEvent event) Called when the core properties of a task change i.e.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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

Constructor Detail

ParameterPanel

public ParameterPanel()

Creates a Triana parameter panel associated with the specified task.

Method Detail

setTask

public void setTask(Task task)

getTask

public Task getTask()

Returns:

the Task associated with this ParameterPanel

setParameter

public void setParameter(java.lang.String name,
                java.lang.Object value)

Sets a paremeter in the associated task to the specified value.

If the panel is attached to a group then parameter names of the form taskname.paramname or groupname.taskname.paramname will set the parameter within the specified sub task. If the panel isn't attached to a group then the groupname.taskname section is ignored.

Parameters:

name - the name of the parameter to be set

value - the value the parameter is set to

removeParameter

public void removeParameter(java.lang.String name)

Removes a paremeter in the associated task.

Parameters:

name - the name of the parameter to be removed

getParameter

public java.lang.Object getParameter(java.lang.String name)

Returns the value of a parameter in the associated task

Parameters:

name - the name of the parameter to return

Returns:

the parameter value

isParameterName

public boolean isParameterName(java.lang.String name)

Returns true if a value is set for a parameter in the associated task

Parameters:

name - the name of the parameter

Returns:

true if a value is set for the parameter

getPreferredButtons

public byte getPreferredButtons()

This method returns WindowButtonConstants.OK_CANCEL_APPLY_BUTTONS by default. It should be overridden if the panel has different preferred set of buttons.

Returns:

the panels preferred button combination (as defined in Windows Constants).

isAlwaysOnTopPreferred

public boolean isAlwaysOnTopPreferred()

This method returns true by default. It should be overridden if the panel prefers to be allowed to be hidden behind the main triana window.

Returns:

true by default

isAutoCommitVisible

public boolean isAutoCommitVisible()

This method returns true by default. It should be overridden if the panel does not want the user to be able to change the auto commit state

isAutoCommitByDefault

public boolean isAutoCommitByDefault()

This method returns false by default. It should be overridden if the panel wants parameter changes to be commited automatically

setWindowInterface

public void setWindowInterface(ParameterWindowInterface comp)

Sets the component that determines whether parameter changes are committed automatically

getWindowInterface

public ParameterWindowInterface getWindowInterface()

Returns:

the component that determines whether parameter changes are committed automatically

isAutoCommit

public boolean isAutoCommit()

Returns:

true if parameters are automatically committed

init

public abstract void init()

This method is called when the task is set for this panel. It is overridden to create the panel layout.

reset

public abstract void reset()

This method is called when the panel is reset or cancelled. It should reset all the panels components to the values specified by the associated task, e.g. a component representing a parameter called "noise" should be set to the value returned by a getTool().getParameter("noise") call.

dispose

public abstract void dispose()

This method is called when the panel is finished with. It should dispose of any components (e.g. windows) used by the panel.

disposePanel

public void disposePanel()

Disposes of the parameter panel, calls dispose on the subclassing panel

parameterUpdate

public void parameterUpdate(java.lang.String paramname,
                   java.lang.Object value)

This method is called when a parameter in the associated task is updated. It should be overridden to update the GUI in response to the parameter update

okClicked

public void okClicked()

Called when the ok button is clicked on the parameter window. Calls applyClicked by default to commit any parameter changes.

cancelClicked

public void cancelClicked()

Called when the cancel button is clicked on the parameter window. Parameter changes are not commited.

applyClicked

public void applyClicked()

Called when the apply button is clicked on the parameter window. Commits any parameter changes.

getWindow

protected java.awt.Window getWindow()

Convinence method that returns the window the panel is in.

getMenuBar

public javax.swing.JMenuBar getMenuBar()

Returns:

the menu bar for this panel (null if none)

setMenuBar

public void setMenuBar(javax.swing.JMenuBar menubar)

Sets the menu bar for this component

taskPropertyUpdate

public void taskPropertyUpdate(TaskPropertyEvent event)

Called when the core properties of a task change i.e. its name, whether it is running continuously etc.

Specified by:

taskPropertyUpdate in interface TaskListener

parameterUpdated

public void parameterUpdated(ParameterUpdateEvent event)

Called when the value of a parameter is changed, including when a parameter is removed.

Specified by:

parameterUpdated in interface TaskListener

nodeRemoved

public void nodeRemoved(TaskNodeEvent event)

Called before a data input node is removed.

Specified by:

nodeRemoved in interface TaskListener

nodeAdded

public void nodeAdded(TaskNodeEvent event)

Called when a data input node is added.

Specified by:

nodeAdded in interface TaskListener

taskDisposed

public void taskDisposed(TaskDisposedEvent event)

Called before the task is disposed

Specified by:

taskDisposed in interface TaskListener