public abstract class AbstractLocationHandler extends java.lang.Object implements LocationHandler
LocationHandler
by implementing a number of methods. By
extending this class, a developer need only implement get(), setProperties(),
and reloadData().
locationhandler.locationColor=FF0000 locationhandler.nameColor=008C54 locationhandler.showNames=false locationhandler.showLocations=true locationhandler.override=true
LocationHandler
Modifier and Type | Field and Description |
---|---|
protected I18n |
i18n
All LocationHandlers have access to an I18n object, which is provided by
the Environment.
|
protected DrawingAttributes |
locationDrawingAttributes
The rendering attributes for the locations.
|
protected static java.util.logging.Logger |
logger |
protected DrawingAttributes |
nameDrawingAttributes
The rendering attributes for the names.
|
protected java.lang.String |
propertyPrefix
Token uniquely identifying this LocationHandler in the application
properties.
|
protected LocationLayer |
zLayer
The parent layer.
|
defaultLocationColorString, defaultNameColorString, forceGlobalCommand, ForceGlobalProperty, LocationColorProperty, LocationPropertyPrefix, NameColorProperty, NamePropertyPrefix, readDataCommand, showdetails, showLocationsCommand, ShowLocationsProperty, showname, showNamesCommand, ShowNamesProperty
EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty
Modifier | Constructor and Description |
---|---|
protected |
AbstractLocationHandler() |
Modifier and Type | Method and Description |
---|---|
java.awt.Component |
getGUI()
A set of controls to manipulate and control the display of data from the
handler.
|
LocationLayer |
getLayer()
Get the layer the handler is serving.
|
java.awt.Color |
getLocationColor()
Get the color used for the location graphic.
|
DrawingAttributes |
getLocationDrawingAttributes() |
java.awt.Color |
getNameColor()
Get the color used for the name label.
|
DrawingAttributes |
getNameDrawingAttributes() |
java.util.Properties |
getProperties(java.util.Properties props)
PropertyConsumer method, to fill in a Properties object, reflecting the
current values of the layer.
|
java.util.Properties |
getPropertyInfo(java.util.Properties list)
Method to fill in a Properties object with values reflecting the
properties able to be set on this PropertyConsumer.
|
java.lang.String |
getPropertyPrefix()
Get the property key prefix that is being used to prepend to the property
keys for Properties lookups.
|
boolean |
isForceGlobal()
Find out whether global settings should override local ones.
|
boolean |
isShowLocations()
See if the handler is displaying location graphics at a global level.
|
boolean |
isShowNames()
See if the handler is displaying labels at a global level.
|
void |
removed(java.awt.Container cont)
Called by the LocationLayer when the layer is removed from the map.
|
void |
setForceGlobal(boolean set)
Set whether global settings should override local ones.
|
void |
setLayer(LocationLayer l)
Set the layer the handler is responding to.
|
void |
setLocationColor(java.awt.Color lColor)
Set the color used for the location graphic.
|
void |
setLocationDrawingAttributes(DrawingAttributes lda) |
void |
setNameColor(java.awt.Color nColor)
Set the color used for the name label.
|
void |
setNameDrawingAttributes(DrawingAttributes nda) |
void |
setProperties(java.util.Properties props)
Sets the properties for the handler.
|
void |
setProperties(java.lang.String prefix,
java.util.Properties properties)
Set up the properties of the handler.
|
void |
setPropertyPrefix(java.lang.String prefix)
Set the property key prefix that should be used by the PropertyConsumer.
|
void |
setShowLocations(boolean set)
Set the handler to show/hide location graphics at a global level.
|
void |
setShowNames(boolean set)
Set the handler to show/hide labels at a global level.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
get, getItemsForPopupMenu, reloadData
protected static java.util.logging.Logger logger
protected LocationLayer zLayer
protected DrawingAttributes nameDrawingAttributes
protected DrawingAttributes locationDrawingAttributes
protected java.lang.String propertyPrefix
protected transient I18n i18n
public void setLayer(LocationLayer l)
setLayer
in interface LocationHandler
l
- a LocationLayerpublic LocationLayer getLayer()
getLayer
in interface LocationHandler
public boolean isShowNames()
isShowNames
in interface LocationHandler
public void setShowNames(boolean set)
setShowNames
in interface LocationHandler
public boolean isShowLocations()
isShowLocations
in interface LocationHandler
public void setShowLocations(boolean set)
setShowLocations
in interface LocationHandler
public boolean isForceGlobal()
isForceGlobal
in interface LocationHandler
public void setForceGlobal(boolean set)
setForceGlobal
in interface LocationHandler
public void setNameColor(java.awt.Color nColor)
public java.awt.Color getNameColor()
public void setLocationColor(java.awt.Color lColor)
public java.awt.Color getLocationColor()
public java.awt.Component getGUI()
getGUI
in interface LocationHandler
public void removed(java.awt.Container cont)
removed
in interface LocationHandler
cont
- Container being removed from.public void setProperties(java.util.Properties props)
setProperties
in interface PropertyConsumer
props
- the Properties
object.public void setProperties(java.lang.String prefix, java.util.Properties properties)
setProperties
in interface PropertyConsumer
prefix
- a String used by the PropertyConsumer to prepend
to each property value it wants to look up -
setList.getProperty(prefix.propertyKey). If the prefix
had already been set, then the prefix passed in should
replace that previous value.properties
- a Properties object that the PropertyConsumer
can use to retrieve expected properties it can use for
configuration.public java.util.Properties getProperties(java.util.Properties props)
getProperties
in interface PropertyConsumer
props
- a Properties object to load the PropertyConsumer properties
into. If props equals null, then a new Properties object should be
created.public java.util.Properties getPropertyInfo(java.util.Properties list)
getPropertyInfo
in interface PropertyConsumer
list
- a Properties object to load the PropertyConsumer properties
into. If getList equals null, then a new Properties object should
be created.public void setPropertyPrefix(java.lang.String prefix)
setPropertyPrefix
in interface PropertyConsumer
prefix
- the prefix String.public java.lang.String getPropertyPrefix()
getPropertyPrefix
in interface PropertyConsumer
public DrawingAttributes getLocationDrawingAttributes()
public void setLocationDrawingAttributes(DrawingAttributes lda)
public DrawingAttributes getNameDrawingAttributes()
public void setNameDrawingAttributes(DrawingAttributes nda)
Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details