java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors
      - adams.gui.visualization.object.objectannotations.colors.PerType

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ColorProviderHandler, AnnotationColors, Serializable
```
public class PerType
extends AbstractAnnotationColors
implements ColorProviderHandler
```
Uses a color per object type.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected ColorProvider`	`m_ColorProvider`	the color provider to use.
`protected String`	`m_MetaDataKey`	the key in the meta-data that contains the type.
`protected Color`	`m_NoTypeColor`	the color to use if no type present.
`protected BaseString[]`	`m_PredefinedTypes`	predefined types.
`protected HashMap<String,Color>`	`m_TypeColors`	the type/color mapping.
`protected BaseRegExp`	`m_TypeRegExp`	the regular expression for the types to draw.

Fields inherited from class adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors
m_Enabled

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

PerType()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`colorProviderTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected Color`	`doGetColor(LocatedObject object)`	Returns the color for the object.
`protected void`	`doInitColors(LocatedObjects objects, MessageCollection errors)`	Initializes the colors with the annotations.
`protected String`	`generateQuickInfo()`	Returns a quick info about the object, which can be displayed in the GUI.
`ColorProvider`	`getColorProvider()`	Returns the color provider to use for the types.
`String`	`getMetaDataKey()`	Returns the key in the meta-data of the object that contains the type.
`Color`	`getNoTypeColor()`	Returns the color to use when no type information available.
`BaseString[]`	`getPredefinedTypes()`	Returns the predefined types.
`BaseRegExp`	`getTypeRegExp()`	Returns the regular expression that the types must match in order to get drawn.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`metaDataKeyTipText()`	Returns the tip text for this property.
`String`	`noTypeColorTipText()`	Returns the tip text for this property.
`String`	`predefinedTypesTipText()`	Returns the tip text for this property.
`void`	`setColorProvider(ColorProvider value)`	Sets the color provider to use for the types.
`void`	`setMetaDataKey(String value)`	Sets the key in the meta-data of the object that contains the type.
`void`	`setNoTypeColor(Color value)`	Sets the color to use when no type information available.
`void`	`setPredefinedTypes(BaseString[] value)`	Sets the predefined types.
`void`	`setTypeRegExp(BaseRegExp value)`	Sets the regular expression that the types must match in order to get drawn.
`String`	`typeRegExpTipText()`	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors
check, enabledTipText, getColor, getEnabled, getQuickInfo, initColors, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject
setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - m_MetaDataKey
```
protected String m_MetaDataKey
```
    the key in the meta-data that contains the type.
  - m_TypeRegExp
```
protected BaseRegExp m_TypeRegExp
```
    the regular expression for the types to draw.
  - m_ColorProvider
```
protected ColorProvider m_ColorProvider
```
    the color provider to use.
  - m_NoTypeColor
```
protected Color m_NoTypeColor
```
    the color to use if no type present.
  - m_PredefinedTypes
```
protected BaseString[] m_PredefinedTypes
```
    predefined types.
  - m_TypeColors
```
protected transient HashMap<String,Color> m_TypeColors
```
    the type/color mapping.
- Constructor Detail
  - PerType
```
public PerType()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractAnnotationColors
  - setMetaDataKey
```
public void setMetaDataKey(String value)
```
    Sets the key in the meta-data of the object that contains the type.
    
    Parameters:
    
    value - the key
  - getMetaDataKey
```
public String getMetaDataKey()
```
    Returns the key in the meta-data of the object that contains the type.
    
    Returns:
    
    the key
  - metaDataKeyTipText
```
public String metaDataKeyTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTypeRegExp
```
public void setTypeRegExp(BaseRegExp value)
```
    Sets the regular expression that the types must match in order to get drawn.
    
    Parameters:
    
    value - the expression
  - getTypeRegExp
```
public BaseRegExp getTypeRegExp()
```
    Returns the regular expression that the types must match in order to get drawn.
    
    Returns:
    
    the expression
  - typeRegExpTipText
```
public String typeRegExpTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColorProvider
```
public void setColorProvider(ColorProvider value)
```
    Sets the color provider to use for the types.
    
    Specified by:
    
    setColorProvider in interface ColorProviderHandler
    
    Parameters:
    
    value - the provider
  - getColorProvider
```
public ColorProvider getColorProvider()
```
    Returns the color provider to use for the types.
    
    Specified by:
    
    getColorProvider in interface ColorProviderHandler
    
    Returns:
    
    the provider
  - colorProviderTipText
```
public String colorProviderTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    colorProviderTipText in interface ColorProviderHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setNoTypeColor
```
public void setNoTypeColor(Color value)
```
    Sets the color to use when no type information available.
    
    Parameters:
    
    value - the color
  - getNoTypeColor
```
public Color getNoTypeColor()
```
    Returns the color to use when no type information available.
    
    Returns:
    
    the color
  - noTypeColorTipText
```
public String noTypeColorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPredefinedTypes
```
public void setPredefinedTypes(BaseString[] value)
```
    Sets the predefined types.
    
    Parameters:
    
    value - the types
  - getPredefinedTypes
```
public BaseString[] getPredefinedTypes()
```
    Returns the predefined types.
    
    Returns:
    
    the types
  - predefinedTypesTipText
```
public String predefinedTypesTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - generateQuickInfo
```
protected String generateQuickInfo()
```
    Returns a quick info about the object, which can be displayed in the GUI.
    
    Overrides:
    
    generateQuickInfo in class AbstractAnnotationColors
    
    Returns:
    
    null if no info available, otherwise short string
  - doInitColors
```
protected void doInitColors(LocatedObjects objects,
                            MessageCollection errors)
```
    Initializes the colors with the annotations.
    
    Specified by:
    
    doInitColors in class AbstractAnnotationColors
    
    Parameters:
    
    objects - the annotations to use for initialization
    
    errors - for collecting errors
  - doGetColor
```
protected Color doGetColor(LocatedObject object)
```
    Returns the color for the object.
    
    Specified by:
    
    doGetColor in class AbstractAnnotationColors
    
    Parameters:
    
    object - the annotation to get the color for

Class PerType

Field Summary

Fields inherited from class adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.gui.visualization.object.objectannotations.colors.AbstractAnnotationColors

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

m_MetaDataKey

m_TypeRegExp

m_ColorProvider

m_NoTypeColor

m_PredefinedTypes

m_TypeColors

Constructor Detail

PerType

Method Detail

globalInfo

defineOptions

setMetaDataKey

getMetaDataKey

metaDataKeyTipText

setTypeRegExp

getTypeRegExp

typeRegExpTipText

setColorProvider

getColorProvider

colorProviderTipText

setNoTypeColor

getNoTypeColor

noTypeColorTipText

setPredefinedTypes

getPredefinedTypes

predefinedTypesTipText

generateQuickInfo

doInitColors

doGetColor