org.openbp.cockpit.modeler.paramvaluewizard
Class ParamValueWizard

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.openbp.swing.components.wizard.WizardImpl
                      org.openbp.cockpit.modeler.paramvaluewizard.ParamValueWizard

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ChangeListener, Wizard

public class ParamValueWizard
extends WizardImpl

Parameter value wizard. This wizard displays all entry parameters of a newly created node that the user can preset with constant values.
These are parameters that have their NodeParam.setParamValueWizard(java.lang.String) property set. This property determines the type of wizard page that is used to enter the value. For each parameter, there will be one wizard page.

Author:

Heiko Erhardt

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

static java.awt.Dimension

DEFAULT_SIZE Default size of the dialog

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

ParamValueWizard(Node node, java.util.List valueParams, ConfigurationBean configurationBean, java.lang.String paramName)
Default constructor.

Method Summary

protected WizardPage	createBooleanPage(NodeParam param) Creates a wizard page for parameters of type 'boolean'.
protected WizardPage	createDataTypePage(NodeParam param) Creates a wizard page for parameters of type 'data type'.
protected WizardPage	createIntegerPage(NodeParam param) Creates a wizard page for parameters of type 'integer'.
protected WizardPage	createStringPage(NodeParam param) Creates a wizard page for parameters of type 'string'.
static void	displayParameterValueWizard(Modeler modeler, NodeFigure nodeFigure, java.lang.String socketName, java.lang.String paramName) Display the parameter value wizard.
protected boolean	fireWizardEvent(WizardEvent event) Fires a wizard event.
static boolean	isParameterValueWizardApplyable(Modeler modeler, NodeFigure nodeFigure, java.lang.String socketName) Checks if the parameter value wizard can be applied to the given node.
protected void	setupPages() Sets up the wizard pages.
boolean	showWizardDialog() Shows the wizard dialog.

Methods inherited from class org.openbp.swing.components.wizard.WizardImpl

addAndLinkPage, addPage, addWizardListener, canCancel, cancel, canFinish, canMoveBackward, canMoveForward, clearPages, close, displayBack, displayFirst, displayNext, displayPage, finish, fireWizardEvent, getDataModel, getDefaultBackgroundImage, getDefaultWizardImage, getManager, getPage, getPageNames, getPageResourcePrefix, getPageResourceString, getPages, getResource, getResultPageName, hasBackward, hasForward, hideWizard, removePage, removeWizardListener, setDataModel, setDefaultBackgroundImage, setDefaultWizardImage, setManager, setPageResourcePrefix, setResultPage, setResultPageName, setShowHelp, setWizardResource, stateChanged, updateNavigator

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, 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, transferFocusBackward, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE

public static final java.awt.Dimension DEFAULT_SIZE

Default size of the dialog

Constructor Detail

ParamValueWizard

public ParamValueWizard(Node node,
                        java.util.List valueParams,
                        ConfigurationBean configurationBean,
                        java.lang.String paramName)

Default constructor.

Parameters:

node - The node we refer to

valueParams - List of NodeParam objects to display in the dialog

configurationBean - Configuration bean of the node

paramName - Name of the parameter to display by default or null for the first parameter

Method Detail

isParameterValueWizardApplyable

public static boolean isParameterValueWizardApplyable(Modeler modeler,
                                                      NodeFigure nodeFigure,
                                                      java.lang.String socketName)

Checks if the parameter value wizard can be applied to the given node.

Parameters:

modeler - Modeler in charge

nodeFigure - The new node

socketName - Name of the socket to edit or null for the default entry socket

Returns:

true: There are parameters or setting values that can be edited by the wizard.
false: No wizard hints have been defined for the parameters and there is no setting object to edit.

displayParameterValueWizard

public static void displayParameterValueWizard(Modeler modeler,
                                               NodeFigure nodeFigure,
                                               java.lang.String socketName,
                                               java.lang.String paramName)

Display the parameter value wizard. Called after a node has been inserted in the workspace or if the user clicked the 'Display paramete value' menu item. Checks if the parameters of the default entry socket contain parameter wizard hints or if there is a setting object associated with the node that can be edited. If so, it displays the parameter wizard.

Parameters:

modeler - Modeler in charge

nodeFigure - The new node

socketName - Name of the socket to edit or null for the default entry socket

paramName - Name of the parameter to display by default or null for the first parameter

showWizardDialog

public boolean showWizardDialog()

Shows the wizard dialog.

Returns:

true: The dialog was ended using the 'Finish' button.
false: The dialog was cancelled.

setupPages

protected void setupPages()

Sets up the wizard pages.

fireWizardEvent

protected boolean fireWizardEvent(WizardEvent event)

Fires a wizard event.

Overrides:

fireWizardEvent in class WizardImpl

Parameters:

event - Event to fire

Returns:

true: Processing can be continued.
false: The cancel flag of the event has been set by an event listener.

createStringPage

protected WizardPage createStringPage(NodeParam param)

Creates a wizard page for parameters of type 'string'.

Parameters:

param - Parameter to edit

Returns:

The new page or null on error

createIntegerPage

protected WizardPage createIntegerPage(NodeParam param)

Creates a wizard page for parameters of type 'integer'.

Parameters:

param - Parameter to edit

Returns:

The new page or null on error

createBooleanPage

protected WizardPage createBooleanPage(NodeParam param)

Creates a wizard page for parameters of type 'boolean'.

Parameters:

param - Parameter to edit

Returns:

The new page or null on error

createDataTypePage

protected WizardPage createDataTypePage(NodeParam param)

Creates a wizard page for parameters of type 'data type'.

Parameters:

param - Parameter to edit

Returns:

The new page or null on error