Package repast.simphony.ui.plugin.editor

Class OptionsEditorDialog

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener, Editor

Direct Known Subclasses:

AbstractWizardEditor, DisplayOptionsDialog

public class OptionsEditorDialog
extends OptionsDialog
implements Editor

An extension of OptionsDialog that adapts it to a Editor and adds some helper methods for using wizard steps in the editor.

Author:

Jerry Vos

See Also:

Serialized Form

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

Modifier and Type	Field	Description
protected String	defaultTitle
protected HashSet<org.pietschy.wizard.Wizard>	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

Constructors

Constructor	Description
OptionsEditorDialog()
OptionsEditorDialog(String title)

Method Summary

Modifier and Type	Method	Description
void	addContent(String name, Icon icon, org.pietschy.wizard.PanelWizardStep step, org.pietschy.wizard.Wizard wizard)	Adds a wizard step as content for this wizard.
void	addContent(Icon icon, org.pietschy.wizard.PanelWizardStep step, org.pietschy.wizard.Wizard wizard)	Adds a wizard step as content for this wizard.
protected void	cancel()
static OptionsEditorDialog	create(org.pietschy.wizard.WizardModel model, org.pietschy.wizard.models.Path steps, String title)	Creates a dialog whose content is specified by the steps in the given path.
void	display(JDialog parent)	Display this Editor with the specified component as a parent.
void	display(JFrame parent)	Display this Editor with the specified component as a parent.
protected void	ok()
boolean	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

Methods inherited from class java.lang.Object

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

Field Detail

defaultTitle

protected String defaultTitle

wizards

protected HashSet<org.pietschy.wizard.Wizard> wizards

Constructor Detail

OptionsEditorDialog

public OptionsEditorDialog()

OptionsEditorDialog

public OptionsEditorDialog(String title)

Method Detail

display

public void display(JDialog parent)

Display this Editor with the specified component as a parent. The resulting display should be modal.

Specified by:

display in interface Editor

Parameters:

parent - the parent of the dialog

display

public void display(JFrame parent)

Display this Editor with the specified component as a parent. The resulting display should be modal.

Specified by:

display in interface Editor

Parameters:

parent - the parent of the dialog

wasCanceled

public boolean wasCanceled()

Specified by:

wasCanceled in interface Editor

Returns:

true if the editing was canceled, otherwise false.

addContent

public void addContent(String name,
                       Icon icon,
                       org.pietschy.wizard.PanelWizardStep step,
                       org.pietschy.wizard.Wizard wizard)

Adds a wizard step as content for this wizard. This is the same as step.init(wizard.getModel()); addContent(name, icon, new OptionsContentWizardStepAdapter(wizard, step));

Parameters:

name - the name of the content

icon - the icon for the content

step - the step for the options

wizard - the wizard the step is in

addContent

public void addContent(Icon icon,
                       org.pietschy.wizard.PanelWizardStep step,
                       org.pietschy.wizard.Wizard wizard)

Adds a wizard step as content for this wizard. This is the same as addContent(step.getName(), icon, new OptionsContentWizardStepAdapter(wizard, step));

Parameters:

icon - the icon for the content

step - the step for the options

wizard - the wizard the step is in

ok

protected void ok()

Overrides:

ok in class OptionsDialog

cancel

protected void cancel()

Overrides:

cancel in class OptionsDialog

create

public static OptionsEditorDialog create(org.pietschy.wizard.WizardModel model,
                                         org.pietschy.wizard.models.Path steps,
                                         String title)

Creates a dialog whose content is specified by the steps in the given path. The path must only contain PanelWizardSteps, otherwise a ClassCastException will be thrown.

Parameters:

model - the model for the wizard and steps

steps - the steps that will be the content

title - the title of the dialog

Returns:

a new editor dialog