org.ascape.view.vis
Class HostedAgentView

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.ascape.view.vis.PanelView
                      org.ascape.view.vis.BufferView
                          org.ascape.view.vis.AgentView
                              org.ascape.view.vis.AgentSizedView
                                  org.ascape.view.vis.CellView
                                      org.ascape.view.vis.HostedAgentView

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, java.util.Observer, javax.accessibility.Accessible, ScapeListener, HasName, ComponentView

Direct Known Subclasses:

Overhead2DView

public abstract class HostedAgentView
extends CellView

A base class for drawing a collection of agents upon a collection of cells. By default, a base agent cell view draws agents as ovals, but any other draw behavior can be used by adding and selecting it.

Since:

1.0

Version:

1.2.6

Author:

Miles Parker

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

DrawFeature	agents_fill_cells_draw_feature Draws the provided object, assumed to be a cell with an occupant, by filling any unoccupied cells using the cell color feature interpretation, and filling any occupied cells using the agent color feature on the occupant.
DrawFeature	agents_image_cells_draw_feature Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, and filling an oval using the agent color feature on the occupant.
DrawFeature	agents_oval_cells_boundary_draw_feature Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, and filling an oval using the agent color feature on the occupant.
DrawFeature	agents_oval_cells_desc_draw_feature Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, filling an oval using the agent color feature on the occupant, and printing a descriptive string next to any agents.
DrawFeature	agents_oval_cells_draw_feature Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, and filling an oval using the agent color feature on the occupant.

Fields inherited from class org.ascape.view.vis.CellView

borderSize, cells_fill_draw_feature, cells_fill_draw_inset_feature

Fields inherited from class org.ascape.view.vis.AgentSizedView

agentSize

Fields inherited from class org.ascape.view.vis.AgentView

agentColorFeature, agentCustomizer, clearBackgroundAutomatically, drawSelection, updateAllRequested

Fields inherited from class org.ascape.view.vis.BufferView

bufferedGraphics, bufferedImage

Fields inherited from class org.ascape.view.vis.PanelView

delegate, iterationsPerRedraw, name, scape

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

HostedAgentView()

Method Summary

void	build() Builds the view.
ColorFeature	getHostedAgentColorFeature() Returns the color feature that will be used for determining agent color.
ColorFeature	getPrimaryAgentColorFeature() Returns the color feature that will be used for determining agent color.
void	readExternal(java.io.ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	setHostedAgentColorFeature(ColorFeature agentColorFeature) Set the color feature that will be used for determining agent color.
void	setHostedAgentImageFeature(ImageFeature agentImageFeature) Set the image feature that will be used for determining agent image.
void	setPrimaryAgentColorFeature(ColorFeature cellColorFeature) Set the color feature that will be used for determining agent color.
void	writeExternal(java.io.ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class org.ascape.view.vis.CellView

getBorderSize, getCellColorFeature, getCellSize, getIcon, scapeRemoved, setBorderSize, setCellColorFeature, setCellSize

Methods inherited from class org.ascape.view.vis.AgentSizedView

addNotify, calculateAgentSizeForViewSize, calculateViewSizeForAgentSize, getAgentSize, getPreferredSizeWithin, scapeAdded, setAgentSize, setBounds

Methods inherited from class org.ascape.view.vis.AgentView

addDrawFeature, createAgentCustomizer, createAgentCustomizerPanel, displayAgentCustomizer, displayCustomizer, drawSelectedAgent, drawSelectedAgent, getAgentAtPixel, getAgentColorFeature, getAgentCustomizer, getDrawFeatures, getDrawFeaturesObservable, getDrawSelection, isClearBackground, paintComponent, removeAgentCustomizer, removeCustomizer, removeDrawFeature, requestUpdateAll, scapeStarted, setAgentColorFeature, setAgentCustomizer, setClearBackground, setCustomizeAgent, update, updateScapeGraphics

Methods inherited from class org.ascape.view.vis.BufferView

buildGraphicsBuffer, finalize, getBufferedImage, imageUpdate, setBufferedImage

Methods inherited from class org.ascape.view.vis.PanelView

clone, environmentQuiting, forceScapeNotify, getDelegate, getIterationsPerRedraw, getName, getScape, getViewFrame, iconUpdated, isGraphic, isLifeOfScape, notifyScapeUpdated, onChangeIterationsPerRedraw, scapeClosing, scapeDeserialized, scapeInitialized, scapeIterated, scapeNotification, scapeSetup, scapeStopped, setDelegate, setIterationsPerRedraw, setMovieRecorder, setName, setViewFrame, toString

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

agents_oval_cells_draw_feature

public final DrawFeature agents_oval_cells_draw_feature

Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, and filling an oval using the agent color feature on the occupant.

agents_oval_cells_boundary_draw_feature

public final DrawFeature agents_oval_cells_boundary_draw_feature

Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, and filling an oval using the agent color feature on the occupant.

agents_oval_cells_desc_draw_feature

public final DrawFeature agents_oval_cells_desc_draw_feature

Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, filling an oval using the agent color feature on the occupant, and printing a descriptive string next to any agents.

agents_fill_cells_draw_feature

public final DrawFeature agents_fill_cells_draw_feature

Draws the provided object, assumed to be a cell with an occupant, by filling any unoccupied cells using the cell color feature interpretation, and filling any occupied cells using the agent color feature on the occupant.

agents_image_cells_draw_feature

public final DrawFeature agents_image_cells_draw_feature

Draws the provided object, assumed to be a cell with an occupant, by filling the cell using the cell color feature interpretation, and filling an oval using the agent color feature on the occupant.

Constructor Detail

HostedAgentView

public HostedAgentView()

Method Detail

build

public void build()

Builds the view. Sets the color feature defaults, adds the default oval and fill draw features, and selects the draw agents as ovals feature.

Specified by:

build in interface ComponentView

Overrides:

build in class CellView

getPrimaryAgentColorFeature

public ColorFeature getPrimaryAgentColorFeature()

Returns the color feature that will be used for determining agent color. The default color feature is simply the getColor() method of the agent.

Overrides:

getPrimaryAgentColorFeature in class CellView

Returns:

the primary agent color feature

setPrimaryAgentColorFeature

public void setPrimaryAgentColorFeature(ColorFeature cellColorFeature)

Set the color feature that will be used for determining agent color. The default color feature is simply the getColor() method of the agent.

Overrides:

setPrimaryAgentColorFeature in class CellView

Parameters:

cellColorFeature - the color feature, whose object is assumed to be a cell living on this lattice

getHostedAgentColorFeature

public ColorFeature getHostedAgentColorFeature()

Returns the color feature that will be used for determining agent color. The default color feature is simply the getColor() method of the agent.

Returns:

the hosted agent color feature

setHostedAgentColorFeature

public void setHostedAgentColorFeature(ColorFeature agentColorFeature)

Set the color feature that will be used for determining agent color. The default color feature is simply the getColor() method of the agent.

Parameters:

agentColorFeature - the color feature, whose object is assumed to be a cell living on this lattice

setHostedAgentImageFeature

public void setHostedAgentImageFeature(ImageFeature agentImageFeature)

Set the image feature that will be used for determining agent image. The default image feature is simply the getImage() method of the agent.

Parameters:

agentImageFeature - the image feature, whose object is assumed to be a cell living on this lattice

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Description copied from class: CellView

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class CellView

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Description copied from class: CellView

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class CellView

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

java.lang.ClassNotFoundException - the class not found exception