Package repast.simphony.ui.plugin.editor
Class AbstractWizardEditor<T extends ControllerAction>
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
repast.simphony.ui.plugin.editor.OptionsDialog
repast.simphony.ui.plugin.editor.OptionsEditorDialog
repast.simphony.ui.plugin.editor.AbstractWizardEditor<T>
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,EventListener
,Accessible
,ChangeListener
,Editor
- Direct Known Subclasses:
DataLoaderEditor
,FreezerEditor
This is an abstract
Editor
implementation that is to be used for ui's where the editor is
based on a set of PanelWizardStep
s. This uses a OptionsEditorDialog
for its
editor, and steps from implementations paths for the content.- Author:
- Jerry Vos
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields inherited from class repast.simphony.ui.plugin.editor.OptionsEditorDialog
defaultTitle, wizards
Fields inherited from class repast.simphony.ui.plugin.editor.OptionsDialog
dialog, DIALOG_HEIGHT, DIALOG_WIDTH
Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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
ConstructorDescriptionAbstractWizardEditor
(T action, Scenario scenario, Object contextId, String title) Constructs this with the specified action to work on, the title for any created editors and the label for displaying for actions. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
buildEditor
(Scenario scenario, Object contextId) Creates and returns anOptionsEditorDialog
whose content is the steps fromgetPath()
whose model is from#getWizardModel(SimplePath, Scenario, Object, ScenarioTreeEvent)
, and whose title is this wizard's title.protected void
cancel()
void
Display this Editor with the specified component as a parent.void
Display this Editor with the specified component as a parent.protected abstract org.pietschy.wizard.models.SimplePath
getPath()
Retrieves the path that contains steps that will be the content for the dialog.protected abstract org.pietschy.wizard.WizardModel
getWizardModel
(org.pietschy.wizard.models.SimplePath path, Scenario scenario, Object contextId) Retrieves theWizardModel
to be used when creating the wizard used when adding steps to the created dialog.protected void
ok()
Methods inherited from class repast.simphony.ui.plugin.editor.OptionsEditorDialog
addContent, addContent, create, wasCanceled
Methods inherited from class repast.simphony.ui.plugin.editor.OptionsDialog
actionPerformed, addContent, apply, displayInit, isCanceled, showDialog, showDialog, stateChanged
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, hide, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
action
-
scenario
-
contextId
-
-
Constructor Details
-
AbstractWizardEditor
Constructs this with the specified action to work on, the title for any created editors and the label for displaying for actions.- Parameters:
action
- the action this UI representstitle
- the title for any editorsscenario
- the scenario being worked oncontextId
- the id of the context the action is in
-
-
Method Details
-
getPath
protected abstract org.pietschy.wizard.models.SimplePath getPath()Retrieves the path that contains steps that will be the content for the dialog. This path will be the one passed to the#getWizardModel(SimplePath, repast.simphony.scenario.Scenario, Object, ScenarioTreeEvent)
method.- Returns:
- a path of PanelWizardSteps
-
getWizardModel
protected abstract org.pietschy.wizard.WizardModel getWizardModel(org.pietschy.wizard.models.SimplePath path, Scenario scenario, Object contextId) Retrieves theWizardModel
to be used when creating the wizard used when adding steps to the created dialog.- Parameters:
path
- the path for the wizard (created withgetPath()
)scenario
- the scenariocontextId
- the context id- Returns:
- the model to be used when creating the editor
-
display
Display this Editor with the specified component as a parent. The resulting display should be modal. If this editor's steps have not yet been added they will be added at this time.- Specified by:
display
in interfaceEditor
- Overrides:
display
in classOptionsEditorDialog
- Parameters:
parent
- the parent of the dialog
-
display
Display this Editor with the specified component as a parent. The resulting display should be modal. If this editor's steps have not yet been added they will be added at this time.- Specified by:
display
in interfaceEditor
- Overrides:
display
in classOptionsEditorDialog
- Parameters:
parent
- the parent of the dialog
-
buildEditor
Creates and returns anOptionsEditorDialog
whose content is the steps fromgetPath()
whose model is from#getWizardModel(SimplePath, Scenario, Object, ScenarioTreeEvent)
, and whose title is this wizard's title. -
ok
protected void ok()- Overrides:
ok
in classOptionsEditorDialog
-
cancel
protected void cancel()- Overrides:
cancel
in classOptionsEditorDialog
-