All Superinterfaces:

Descriptor

All Known Implementing Classes:

BasicDisplayDescriptor, CartesianDisplayDescriptor, DefaultDisplayDescriptor, GISDisplayDescriptor
```
public interface DisplayDescriptor
extends Descriptor
```
Descriptor for displays.

Author:

Nick Collier, Eric Tatara

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addEditedStyle(String objClassname, String userStyleName)`
`void`	`addLayerOrder(String objClassname, int order)`
`void`	`addNetworkEditedStyle(Object networkID, String networkClassName)`
`void`	`addNetworkStyle(Object networkID, String networkClassName)`
`void`	`addProjection(ProjectionData proj, ProjectionDescriptor descriptor)`	Adds the data for a projection for which this is the display info.
`void`	`addScenarioChangedListener(ScenarioChangedListener listener)`
`void`	`addStyle(String objClassname, String styleClassName)`
`Iterable<String>`	`agentClassEditedStyleNames()`
`Iterable<String>`	`agentClassLayerOrders()`
`Iterable<String>`	`agentClassStyleNames()`
`void`	`clearProjectionDescriptors()`	Removes any added projection descriptors.
`void`	`clearProjections()`
`Color`	`getBackgroundColor()`	Gets the background color of the display.
`BoundingBox`	`getBoundingBox()`	Gets the Bounding Box for the display.
`Class<?>[]`	`getDefaultNetStyles()`
`Class<?>[]`	`getDefaultStyles()`
`String`	`getDisplayType()`
`String`	`getEditedStyleName(String objClassName)`
`Map<String,String>`	`getEditedStyles()`
`Integer`	`getLayerOrder(String objClassName)`
`Map<String,Integer>`	`getLayerOrders()`
`String`	`getLayoutClassName()`
`IDisplay.LayoutFrequency`	`getLayoutFrqeuency()`
`int`	`getLayoutInterval()`
`String`	`getLayoutProjection()`	Gets the name of the projection associated with the layout.
`VisualizationProperties`	`getLayoutProperties()`
`String`	`getNetworkEditedStyleName(Object networkID)`
`String`	`getNetworkStyleClassName(Object networkID)`
`int`	`getProjectionCount()`	Gets the number of projections in this display descriptor.
`ProjectionDescriptor`	`getProjectionDescriptor(String name)`	Gets the ProjectionDescriptor for the named projection.
`Iterable<ProjectionDescriptor>`	`getProjectionDescriptors()`
`Iterable<ProjectionData>`	`getProjections()`	Gets the data for all the projections for which this is the display info.
`Object`	`getProperty(String name)`	Gets the named property.
`ScheduleParameters`	`getScheduleParameters()`	Retrieves the parameters for when to activate the display update.
`String`	`getStyleClassName(String objClassName)`
`Map<String,String>`	`getStyles()`
`DisplayDescriptor`	`makeCopy()`	Returns a deep copy of the descriptor.
`Iterable<Object>`	`networkEditedStyleIDs()`
`Iterable<Object>`	`networkStyleIDs()`
`Iterable<String>`	`propertyNames()`	Gets an iterable of names of the properties contained by this descriptor.
`void`	`set(DisplayDescriptor descriptor)`
`void`	`setBackgroundColor(Color color)`	Sets the background color of the display.
`void`	`setBoundingBox(BoundingBox boundingBox)`	Sets the BoundingBox for the display.
`void`	`setDisplayType(String type, boolean reset)`	Sets the display type of this descriptor.
`void`	`setLayoutClassName(String className)`
`void`	`setLayoutFrequency(IDisplay.LayoutFrequency frequency)`
`void`	`setLayoutInterval(int interval)`
`void`	`setLayoutProjection(String name)`	Sets the name of the projection to associate with the layout.
`void`	`setLayoutProperties(VisualizationProperties props)`	Sets the layout properties for this display.
`void`	`setProperty(String name, Object value)`	Sets the specified property.
`void`	`setScheduleParameters(ScheduleParameters scheduleInfo)`	Sets the parameters for when to activate the display update.

Methods inherited from interface repast.simphony.engine.schedule.Descriptor
getName, setName

- Method Detail
  - makeCopy
```
DisplayDescriptor makeCopy()
```
    Returns a deep copy of the descriptor.
    
    Returns:
  - set
```
void set(DisplayDescriptor descriptor)
```
  - setLayoutInterval
```
void setLayoutInterval(int interval)
```
  - getLayoutInterval
```
int getLayoutInterval()
```
  - getDefaultStyles
```
Class<?>[] getDefaultStyles()
```
  - getDefaultNetStyles
```
Class<?>[] getDefaultNetStyles()
```
  - clearProjectionDescriptors
```
void clearProjectionDescriptors()
```
    Removes any added projection descriptors.
  - getDisplayType
```
String getDisplayType()
```
  - setDisplayType
```
void setDisplayType(String type,
                    boolean reset)
```
    Sets the display type of this descriptor. If reset is true, then the fields in the descriptor that depend on type info will be reset.
    
    Parameters:
    
    type - the display type
    
    reset - if true, then the fields in the descriptor that depend on type info will be reset.
  - addStyle
```
void addStyle(String objClassname,
              String styleClassName)
```
  - addEditedStyle
```
void addEditedStyle(String objClassname,
                    String userStyleName)
```
  - addLayerOrder
```
void addLayerOrder(String objClassname,
                   int order)
```
  - addNetworkStyle
```
void addNetworkStyle(Object networkID,
                     String networkClassName)
```
  - addNetworkEditedStyle
```
void addNetworkEditedStyle(Object networkID,
                           String networkClassName)
```
  - getStyleClassName
```
String getStyleClassName(String objClassName)
```
  - getEditedStyleName
```
String getEditedStyleName(String objClassName)
```
  - getLayerOrder
```
Integer getLayerOrder(String objClassName)
```
  - getNetworkStyleClassName
```
String getNetworkStyleClassName(Object networkID)
```
  - getNetworkEditedStyleName
```
String getNetworkEditedStyleName(Object networkID)
```
  - agentClassStyleNames
```
Iterable<String> agentClassStyleNames()
```
  - agentClassEditedStyleNames
```
Iterable<String> agentClassEditedStyleNames()
```
  - agentClassLayerOrders
```
Iterable<String> agentClassLayerOrders()
```
  - networkStyleIDs
```
Iterable<Object> networkStyleIDs()
```
  - networkEditedStyleIDs
```
Iterable<Object> networkEditedStyleIDs()
```
  - getLayoutFrqeuency
```
IDisplay.LayoutFrequency getLayoutFrqeuency()
```
  - setLayoutFrequency
```
void setLayoutFrequency(IDisplay.LayoutFrequency frequency)
```
  - getScheduleParameters
```
ScheduleParameters getScheduleParameters()
```
    Retrieves the parameters for when to activate the display update.
    
    Returns:
    
    the parameters for when to activate the display update.
  - setScheduleParameters
```
void setScheduleParameters(ScheduleParameters scheduleInfo)
```
    Sets the parameters for when to activate the display update.
    
    Parameters:
    
    scheduleInfo - when to activate the display update
  - getLayoutClassName
```
String getLayoutClassName()
```
  - setLayoutClassName
```
void setLayoutClassName(String className)
```
  - setLayoutProjection
```
void setLayoutProjection(String name)
```
    Sets the name of the projection to associate with the layout.
    
    Parameters:
    
    name -
  - getLayoutProjection
```
String getLayoutProjection()
```
    Gets the name of the projection associated with the layout.
    
    Returns:
    
    the name of the projection associated with the layout.
  - getProjections
```
Iterable<ProjectionData> getProjections()
```
    Gets the data for all the projections for which this is the display info.
    
    Returns:
    
    the data for all the projections for which this is the display info.
  - getProjectionCount
```
int getProjectionCount()
```
    Gets the number of projections in this display descriptor.
    
    Returns:
    
    the number of projections in this display descriptor.
  - addProjection
```
void addProjection(ProjectionData proj,
                   ProjectionDescriptor descriptor)
```
    Adds the data for a projection for which this is the display info.
    
    Parameters:
    
    proj -
    
    descriptor -
  - clearProjections
```
void clearProjections()
```
  - getProjectionDescriptors
```
Iterable<ProjectionDescriptor> getProjectionDescriptors()
```
  - getProjectionDescriptor
```
ProjectionDescriptor getProjectionDescriptor(String name)
```
    Gets the ProjectionDescriptor for the named projection.
    
    Parameters:
    
    name - the name of the projection whose descriptor we want
    
    Returns:
    
    the ProjectionDescriptor for the named projection.
  - getLayoutProperties
```
VisualizationProperties getLayoutProperties()
```
    Returns:
    
    properties for the layout
  - setLayoutProperties
```
void setLayoutProperties(VisualizationProperties props)
```
    Sets the layout properties for this display.
  - getBoundingBox
```
BoundingBox getBoundingBox()
```
    Gets the Bounding Box for the display. This defines the extents of the display
    
    Returns:
    
    the BoundingBox
  - setBoundingBox
```
void setBoundingBox(BoundingBox boundingBox)
```
    Sets the BoundingBox for the display. This defines the extents of the display.
    
    Parameters:
    
    boundingBox - The BoundingBox
  - getProperty
```
Object getProperty(String name)
```
    Gets the named property.
    
    Parameters:
    
    name - the name of the property
    
    Returns:
    
    the named property
  - setProperty
```
void setProperty(String name,
                 Object value)
```
    Sets the specified property.
    
    Parameters:
    
    name - the property's name
    
    value - the property's value
  - propertyNames
```
Iterable<String> propertyNames()
```
    Gets an iterable of names of the properties contained by this descriptor.
    
    Returns:
    
    an iterable of names of the properties contained by this descriptor.
  - getStyles
```
Map<String,String> getStyles()
```
  - getBackgroundColor
```
Color getBackgroundColor()
```
    Gets the background color of the display.
    
    Returns:
    
    the background color of the display.
  - setBackgroundColor
```
void setBackgroundColor(Color color)
```
    Sets the background color of the display.
    
    Parameters:
    
    color - the background color of the display.
  - getLayerOrders
```
Map<String,Integer> getLayerOrders()
```
  - getEditedStyles
```
Map<String,String> getEditedStyles()
```
  - addScenarioChangedListener
```
void addScenarioChangedListener(ScenarioChangedListener listener)
```

Interface DisplayDescriptor

Method Summary

Methods inherited from interface repast.simphony.engine.schedule.Descriptor

Method Detail

makeCopy

set

setLayoutInterval

getLayoutInterval

getDefaultStyles

getDefaultNetStyles

clearProjectionDescriptors

getDisplayType

setDisplayType

addStyle

addEditedStyle

addLayerOrder

addNetworkStyle

addNetworkEditedStyle

getStyleClassName

getEditedStyleName

getLayerOrder

getNetworkStyleClassName

getNetworkEditedStyleName

agentClassStyleNames

agentClassEditedStyleNames

agentClassLayerOrders

networkStyleIDs

networkEditedStyleIDs

getLayoutFrqeuency

setLayoutFrequency

getScheduleParameters

setScheduleParameters

getLayoutClassName

setLayoutClassName

setLayoutProjection

getLayoutProjection

getProjections

getProjectionCount

addProjection

clearProjections

getProjectionDescriptors

getProjectionDescriptor

getLayoutProperties

setLayoutProperties

getBoundingBox

setBoundingBox

getProperty

setProperty

propertyNames

getStyles

getBackgroundColor

setBackgroundColor

getLayerOrders

getEditedStyles

addScenarioChangedListener