com.bbn.openmap
Class OMComponent

java.lang.Object
  extended by com.bbn.openmap.MapHandlerChild
      extended by com.bbn.openmap.OMComponent
All Implemented Interfaces:
LightMapHandlerChild, PropertyConsumer, java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextMembershipListener, java.util.EventListener
Direct Known Subclasses:
AbstractGCT, AbstractGraphicLoader, AbstractLocationHandler, AbstractMouseMode, BasicCoordInfoFormatter, BasicLayerConfigurationListener, BasicProjectionLoader, BasicSymbolImageMaker, Clock, CoordInfoFormatterHandler, CSVEventImporter, DbfTableModelFactory, EventListIconPackage, GeneratorLoader, GraphicLoaderConnector, LayerHandler, MagicPlanetImageComponent, MapBeanKeyListener, MenuList, OMEventHandlerAdapter, OMEventSelectionCoordinator, ProjectionFactory, ProjectionStack, Rule, RuleHandler, StandardMapBeanRepaintPolicy, StandardRenderPolicy, SymbolReferenceLibrary, UndoStack, ZoomLevelInfo

public class OMComponent
extends MapHandlerChild
implements PropertyConsumer

A OMComponent is an OpenMap component that does two basic things: it is a MapHandlerChild, so it knows how to use the MapHandler to find other components it needs, and it is a PropertyConsumer, so it can be configured by a set of Properties. An OMComponent is a perfect candidate to be created by being listed in the openmap.components property of the openmap.properties file. Override the findAndInit() and findAndUndo() methods to test for and connect to other components added to the MapHandler.


Field Summary
protected  I18n i18n
          All OMComponents have access to an I18n object, which is provided by the Environment.
protected  java.lang.String propertyPrefix
          Token uniquely identifying this component in the application properties.
 
Fields inherited from class com.bbn.openmap.MapHandlerChild
beanContextChildSupport, isolated
 
Fields inherited from interface com.bbn.openmap.PropertyConsumer
EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty
 
Constructor Summary
OMComponent()
           
 
Method Summary
 java.util.Properties getProperties(java.util.Properties props)
          PropertyConsumer method, to fill in a Properties object, reflecting the current values of the OMComponent.
 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.
 void setProperties(java.util.Properties props)
          Sets the properties for the OMComponent.
 void setProperties(java.lang.String prefix, java.util.Properties props)
          Sets the properties for the OMComponent.
 void setPropertyPrefix(java.lang.String prefix)
          Set the property key prefix that should be used by the PropertyConsumer.
 
Methods inherited from class com.bbn.openmap.MapHandlerChild
addPropertyChangeListener, addVetoableChangeListener, childrenAdded, childrenRemoved, findAndInit, findAndInit, findAndUndo, firePropertyChange, fireVetoableChange, getBeanContext, isIsolated, removePropertyChangeListener, removeVetoableChangeListener, setBeanContext, setIsolated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

i18n

protected I18n i18n
All OMComponents have access to an I18n object, which is provided by the Environment.


propertyPrefix

protected java.lang.String propertyPrefix
Token uniquely identifying this component in the application properties.

Constructor Detail

OMComponent

public OMComponent()
Method Detail

setProperties

public void setProperties(java.util.Properties props)
Sets the properties for the OMComponent.

Specified by:
setProperties in interface PropertyConsumer
Parameters:
props - the Properties object.

setProperties

public void setProperties(java.lang.String prefix,
                          java.util.Properties props)
Sets the properties for the OMComponent.

Specified by:
setProperties in interface PropertyConsumer
Parameters:
prefix - the token to prefix the property names
props - the Properties object

getProperties

public java.util.Properties getProperties(java.util.Properties props)
PropertyConsumer method, to fill in a Properties object, reflecting the current values of the OMComponent. If the component has a propertyPrefix set, the property keys should have that prefix plus a separating '.' prepended to each property key it uses for configuration.

Specified by:
getProperties in interface PropertyConsumer
Parameters:
props - a Properties object to load the PropertyConsumer properties into. If props equals null, then a new Properties object should be created.
Returns:
Properties object containing PropertyConsumer property values. If getList was not null, this should equal getList. Otherwise, it should be the Properties object created by the PropertyConsumer.

getPropertyInfo

public 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. The key for each property should be the raw property name (without a prefix) with a value that is a String that describes what the property key represents, along with any other information about the property that would be helpful (range, default value, etc.). For Layer, this method should at least return the 'prettyName' property.

Specified by:
getPropertyInfo in interface PropertyConsumer
Parameters:
list - a Properties object to load the PropertyConsumer properties into. If getList equals null, then a new Properties object should be created.
Returns:
Properties object containing PropertyConsumer property values. If getList was not null, this should equal getList. Otherwise, it should be the Properties object created by the PropertyConsumer.

setPropertyPrefix

public void setPropertyPrefix(java.lang.String prefix)
Set the property key prefix that should be used by the PropertyConsumer. The prefix, along with a '.', should be prepended to the property keys known by the PropertyConsumer.

Specified by:
setPropertyPrefix in interface PropertyConsumer
Parameters:
prefix - the prefix String.

getPropertyPrefix

public java.lang.String getPropertyPrefix()
Get the property key prefix that is being used to prepend to the property keys for Properties lookups.

Specified by:
getPropertyPrefix in interface PropertyConsumer
Returns:
the property prefix string


Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details