org.trianacode.gui.toolmaker

Class GUIPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.trianacode.gui.toolmaker.GUIPanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListSelectionListener, WizardPanel

public class GUIPanel
extends javax.swing.JPanel
implements WizardPanel, java.awt.event.ItemListener, java.awt.event.ActionListener, javax.swing.event.ListSelectionListener

A tool wizard panel for specifying the tools graphical interface.

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
protected ParamsPanelInterface	parampanel the panel defining the parameter that the GUI is built for

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GUIPanel() Constructs a GUI Panel for the GUI Editor
	GUIPanel(ParamsPanelInterface parampanel) Constructs a GUIPanel that builds an interface for the parameters defined in the specified parameter panel.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event)
java.lang.String	getCustomPanelName()
java.lang.String	getCustomPanelPackage()
java.lang.String	getDefaultValue(java.lang.String param)
java.lang.String[]	getGUIBuilderLines()
java.lang.String	getQualifiedCustomPanelName()
WizardInterface	getWizardInterface()
protected void	initLayout() layout the panel
boolean	isFinishEnabled()
boolean	isGenerateCustomPanel()
boolean	isNextEnabled()
boolean	isUsingCustomPanel()
boolean	isUsingGUIBuilder()
void	itemStateChanged(java.awt.event.ItemEvent event)
void	panelDisplayed() Called when the panel is displayed in the wizard
void	panelHidden() Called when the panel is hidden in the wizard
void	setCustomPanel(java.lang.String panelname) Sets the parameter package name, setting isUsingCustomPanel to true
void	setDefaultValue(java.lang.String param, java.lang.String value) Sets the default value for the given parameter, updating that defined in the parameter panel
void	setGUIBuilderLines(java.lang.String[] lines) Sets the gui builder lines, setting isUsingGUIBuilder yo true
void	setNoInterface() Sets isUsingGUIBuilder and isUsingCustomPanel to false
void	setWizardInterface(WizardInterface wizard) Sets the interface to the underlying wizard
void	updateGUIComponent(java.lang.String component) updates the currently selected GUI parameter to be associated with the specified component
protected void	updateParameterList()
void	valueChanged(javax.swing.event.ListSelectionEvent event)

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

Field Detail

parampanel

protected ParamsPanelInterface parampanel

the panel defining the parameter that the GUI is built for

Constructor Detail

GUIPanel

public GUIPanel(ParamsPanelInterface parampanel)

Constructs a GUIPanel that builds an interface for the parameters defined in the specified parameter panel.

GUIPanel

protected GUIPanel()

Constructs a GUI Panel for the GUI Editor

Method Detail

initLayout

protected void initLayout()

layout the panel

setWizardInterface

public void setWizardInterface(WizardInterface wizard)

Description copied from interface: WizardPanel

Sets the interface to the underlying wizard

Specified by:

setWizardInterface in interface WizardPanel

getWizardInterface

public WizardInterface getWizardInterface()

Specified by:

getWizardInterface in interface WizardPanel

Returns:

the interface to the underlying wizard

isFinishEnabled

public boolean isFinishEnabled()

Specified by:

isFinishEnabled in interface WizardPanel

Returns:

a flag inidcating whether this panel is in a finishable state (i.e. whether a meaningful result would be generated if finish was pressed). Note that notifyButtonStateChanged() should be called on the wizard interface when the return state changes.

isNextEnabled

public boolean isNextEnabled()

Specified by:

isNextEnabled in interface WizardPanel

Returns:

a flag inidcating whether this panel is next enabled state (i.e. whether a meaningful result would be generated if next was pressed). Note that notifyButtonStateChanged() should be called on the wizard interface when the return state changes.

isUsingGUIBuilder

public boolean isUsingGUIBuilder()

Returns:

true if a gui builder panel is being used

isUsingCustomPanel

public boolean isUsingCustomPanel()

Returns:

true if a custom panel is being used

getGUIBuilderLines

public java.lang.String[] getGUIBuilderLines()

Returns:

an array of gui builder lines for each parameter

getCustomPanelName

public java.lang.String getCustomPanelName()

Returns:

the custom panel name specified (does not include package qualifier)

getCustomPanelPackage

public java.lang.String getCustomPanelPackage()

Returns:

the . qualifier for this panel

setGUIBuilderLines

public void setGUIBuilderLines(java.lang.String[] lines)

Sets the gui builder lines, setting isUsingGUIBuilder yo true

setCustomPanel

public void setCustomPanel(java.lang.String panelname)

Sets the parameter package name, setting isUsingCustomPanel to true

setNoInterface

public void setNoInterface()

Sets isUsingGUIBuilder and isUsingCustomPanel to false

getQualifiedCustomPanelName

public java.lang.String getQualifiedCustomPanelName()

Returns:

the full custom panel class specified including package qualifier

isGenerateCustomPanel

public boolean isGenerateCustomPanel()

Returns:

true if the user wants a template for their custom panel class to be generated

getDefaultValue

public java.lang.String getDefaultValue(java.lang.String param)

Returns:

the default value for the given parameter (as defined in the parameter panel)

setDefaultValue

public void setDefaultValue(java.lang.String param,
                   java.lang.String value)

Sets the default value for the given parameter, updating that defined in the parameter panel

updateGUIComponent

public void updateGUIComponent(java.lang.String component)

updates the currently selected GUI parameter to be associated with the specified component

panelDisplayed

public void panelDisplayed()

Called when the panel is displayed in the wizard

Specified by:

panelDisplayed in interface WizardPanel

updateParameterList

protected void updateParameterList()

panelHidden

public void panelHidden()

Called when the panel is hidden in the wizard

Specified by:

panelHidden in interface WizardPanel

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent event)

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent event)

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener