Package repast.simphony.visualization.gui

Class StyleClassStep

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

repast.simphony.visualization.gui.StyleClassStep

All Implemented Interfaces:

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

public class StyleClassStep
extends StyleStep

Style editor step for displays that use style classes to style agents.

Author:

Nick Collier, Eric Tatara TODO Add a slider on the agent list

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class repast.simphony.visualization.gui.StyleStep

StyleStep.AgentTypeElement

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 Color	backgroundColor
protected JButton	bgcolorBtn
protected JButton	buildStyleButton
protected Map<String,String>	editedStyleFileMap
protected JComboBox<String>	styleBox
protected static Map<Class<?>,List<String>>	styleCache
protected DefaultComboBoxModel<String>	styleModel

Fields inherited from class repast.simphony.visualization.gui.StyleStep

ADD_ICON, agentList, agentListModel, classFld, currentIndex, DOWN_ICON, EDIT_ICON, model, REMOVE_ICON, reordering, 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
StyleClassStep()

Method Summary

Modifier and Type	Method	Description
protected void	agentListChanged(StyleStep.AgentTypeElement element)	Do something whenever the agent list changes to a new value through selection.
void	applyChanges()	Apply the editor changes to the DisplayDescriptor.
protected boolean	checkForStyleEditor(DisplayDescriptor descriptor)	Returns true if the display type in the descriptor supports edited styles.
protected List<String>	findStylesFor(Class<?> styleInterface, String defaultStyle)	Provides a list of available style classes (including default) for the specified interface.
protected List<String>	findStylesForDisplay(DisplayDescriptor descriptor)	Finds all classes that implement the style interface for the type in the descriptor.
protected Color	getDefaultBackgroundColorForDisplay(DisplayDescriptor descriptor)
protected String	getDefaultStyle(DisplayDescriptor descriptor)	Provides the default style class name for the display defined in the descriptor.
protected String	getEditedStyleClassForDisplay(DisplayDescriptor descriptor, EditedStyleData editedStyledata)	Returns the class name for edited styles based on the display type in the descriptor.
protected JPanel	getStylePanel()	Provide a JPanel with style editing capabilities.
void	initialize()	Initialize sub classes.
void	setBackgroundColor(Color backgroundColor)
protected void	setCurrentElementValues()	Set the values of the current element in the agent list when another element in the list is selected.
void	setShowBackgroundButton(boolean showBackgroundButton)

Methods inherited from class repast.simphony.visualization.gui.StyleStep

applyState, getContentPanel, init, prepare

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

styleModel

protected DefaultComboBoxModel<String> styleModel

buildStyleButton

protected JButton buildStyleButton

bgcolorBtn

protected JButton bgcolorBtn

styleBox

protected JComboBox<String> styleBox

editedStyleFileMap

protected Map<String,String> editedStyleFileMap

backgroundColor

protected Color backgroundColor

styleCache

protected static Map<Class<?>,List<String>> styleCache

Constructor Detail

StyleClassStep

public StyleClassStep()

Method Detail

getStylePanel

protected JPanel getStylePanel()

Description copied from class: StyleStep

Provide a JPanel with style editing capabilities.

Specified by:

getStylePanel in class StyleStep

Returns:

the style editor panel

agentListChanged

protected void agentListChanged(StyleStep.AgentTypeElement element)

Description copied from class: StyleStep

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

Specified by:

agentListChanged in class StyleStep

setCurrentElementValues

protected void setCurrentElementValues()

Description copied from class: StyleStep

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

Specified by:

setCurrentElementValues in class StyleStep

applyChanges

public void applyChanges()

Description copied from class: StyleStep

Apply the editor changes to the DisplayDescriptor.

Specified by:

applyChanges in class StyleStep

initialize

public void initialize()

Description copied from class: StyleStep

Initialize sub classes.

Specified by:

initialize in class StyleStep

checkForStyleEditor

protected boolean checkForStyleEditor(DisplayDescriptor descriptor)

Returns true if the display type in the descriptor supports edited styles.

Parameters:

descriptor -

Returns:

findStylesForDisplay

protected List<String> findStylesForDisplay(DisplayDescriptor descriptor)

Finds all classes that implement the style interface for the type in the descriptor.

Parameters:

descriptor -

Returns:

getDefaultStyle

protected String getDefaultStyle(DisplayDescriptor descriptor)

Provides the default style class name for the display defined in the descriptor.

Parameters:

descriptor -

Returns:

getDefaultBackgroundColorForDisplay

protected Color getDefaultBackgroundColorForDisplay(DisplayDescriptor descriptor)

getEditedStyleClassForDisplay

protected String getEditedStyleClassForDisplay(DisplayDescriptor descriptor,
                                               EditedStyleData editedStyledata)

Returns the class name for edited styles based on the display type in the descriptor.

Parameters:

descriptor -

Returns:

findStylesFor

protected List<String> findStylesFor(Class<?> styleInterface,
                                     String defaultStyle)

Provides a list of available style classes (including default) for the specified interface.

Parameters:

styleInterface -

Returns:

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

setShowBackgroundButton

public void setShowBackgroundButton(boolean showBackgroundButton)