Package repast.simphony.visualization.gui

Class StyleStep

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.pietschy.wizard.PanelWizardStep

repast.simphony.ui.plugin.editor.PluginWizardStep

repast.simphony.visualization.gui.StyleStep

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, org.pietschy.wizard.WizardStep, PluginWizardStepListener

Direct Known Subclasses:

StyleClassStep

public abstract class StyleStep
extends PluginWizardStep

Abstract style step for display wizards that provides basic agent selection. Implementing subclasses should provide a style editing panel.

Author:

Nick Collier, Eric Tatara

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StyleStep.AgentTypeElement	Stores agent name, class and style attributes in the list entries

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
static String	ADD_ICON
protected JList<StyleStep.AgentTypeElement>	agentList
protected DefaultListModel<StyleStep.AgentTypeElement>	agentListModel
protected JTextField	classFld
protected int	currentIndex
static String	DOWN_ICON
static String	EDIT_ICON
protected DisplayWizardModel	model
static String	REMOVE_ICON
protected boolean	reordering
static String	UP_ICON

Fields inherited from class repast.simphony.ui.plugin.editor.PluginWizardStep

CONTENT_PANEL_HEIGHT, CONTENT_PANEL_WIDTH, stepListeners

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

Fields inherited from interface org.pietschy.wizard.WizardStep

_ID_

Constructor Summary

Constructors

Constructor	Description
StyleStep(String name, String description)

Method Summary

Modifier and Type	Method	Description
protected abstract void	agentListChanged(StyleStep.AgentTypeElement element)	Do something whenever the agent list changes to a new value through selection.
protected abstract void	applyChanges()	Apply the editor changes to the DisplayDescriptor.
void	applyState()
protected JPanel	getContentPanel()	Subclasses must provide a JPanel with the wizard contents.
protected abstract JPanel	getStylePanel()	Provide a JPanel with style editing capabilities.
void	init(org.pietschy.wizard.WizardModel wizardModel)
protected abstract void	initialize()	Initialize sub classes.
void	prepare()
protected abstract void	setCurrentElementValues()	Set the values of the current element in the agent list when another element in the list is selected.

Methods inherited from class repast.simphony.ui.plugin.editor.PluginWizardStep

addStepListener, updateListeners, updateStep

Methods inherited from class org.pietschy.wizard.PanelWizardStep

abortBusy, getIcon, getSummary, getView, isBusy, isComplete, setBusy, setComplete, setIcon, setSummary

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

Methods inherited from interface org.pietschy.wizard.WizardStep

addPropertyChangeListener, addPropertyChangeListener, getName, getPreferredSize, removePropertyChangeListener, removePropertyChangeListener

Field Detail

UP_ICON

public static final String UP_ICON

See Also:

Constant Field Values

DOWN_ICON

public static final String DOWN_ICON

See Also:

Constant Field Values

EDIT_ICON

public static final String EDIT_ICON

See Also:

Constant Field Values

ADD_ICON

public static final String ADD_ICON

See Also:

Constant Field Values

REMOVE_ICON

public static final String REMOVE_ICON

See Also:

Constant Field Values

model

protected DisplayWizardModel model

agentList

protected JList<StyleStep.AgentTypeElement> agentList

agentListModel

protected DefaultListModel<StyleStep.AgentTypeElement> agentListModel

reordering

protected boolean reordering

currentIndex

protected int currentIndex

classFld

protected JTextField classFld

Constructor Detail

StyleStep

public StyleStep(String name,
                 String description)

Method Detail

getContentPanel

protected JPanel getContentPanel()

Description copied from class: PluginWizardStep

Subclasses must provide a JPanel with the wizard contents.

Specified by:

getContentPanel in class PluginWizardStep

Returns:

the content panel

getStylePanel

protected abstract JPanel getStylePanel()

Provide a JPanel with style editing capabilities.

Returns:

the style editor panel

setCurrentElementValues

protected abstract void setCurrentElementValues()

Set the values of the current element in the agent list when another element in the list is selected.

agentListChanged

protected abstract void agentListChanged(StyleStep.AgentTypeElement element)

Do something whenever the agent list changes to a new value through selection.

applyChanges

protected abstract void applyChanges()

Apply the editor changes to the DisplayDescriptor.

initialize

protected abstract void initialize()

Initialize sub classes.

init

public void init(org.pietschy.wizard.WizardModel wizardModel)

Specified by:

init in interface org.pietschy.wizard.WizardStep

Overrides:

init in class org.pietschy.wizard.PanelWizardStep

applyState

public void applyState()
                throws org.pietschy.wizard.InvalidStateException

Specified by:

applyState in interface org.pietschy.wizard.WizardStep

Overrides:

applyState in class org.pietschy.wizard.PanelWizardStep

Throws:

org.pietschy.wizard.InvalidStateException

prepare

public void prepare()

Specified by:

prepare in interface org.pietschy.wizard.WizardStep

Overrides:

prepare in class org.pietschy.wizard.PanelWizardStep