com.bbn.openmap.gui
Class ToolPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JToolBar
                  com.bbn.openmap.gui.ToolPanel

All Implemented Interfaces:

MapPanelChild, PropertyConsumer, java.awt.event.ComponentListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextMembershipListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.SwingConstants

public class ToolPanel
extends javax.swing.JToolBar
implements java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextMembershipListener, MapPanelChild, PropertyConsumer, java.awt.event.ComponentListener

Represents the toolbar containing tools to apply to the map. Tools can be added in sequential order, and retrieved using the tool's keyword. NOTE: Every time a string is passed into a method of this class, the interned version of it is used as a key.

When the ToolPanel is part of the BeanContext, it looks for Tools that have also been added to the BeanContext. If there is more than one ToolPanel in a BeanContext at a time, both will show the same Tool faces. The 'components' property can be used to control which tools can be added to a specific instance of a ToolPanel. That property should contain a space separated list of prefixes used for Tools, which in turn should be set in the Tools as their keys.

Author:

john gash

See Also:

Tool, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JToolBar

javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator

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

Field Summary

protected boolean	autoSpace A flag to note whether the ToolPanel inserts spaces between tools.
static java.lang.String	AvoidComponentsProperty A list of components to use for filtering out tools found in the MapHandler.
protected java.util.List<java.lang.String>	avoidList A filter list of components to avoid.
protected java.awt.GridBagConstraints	c
protected java.util.List<java.lang.String>	componentList A filter list of components to look for and add.
static java.lang.String	ComponentsProperty A list of components to use for filtering tools found in the MapHandler to add to this ToolPanel.
protected javax.swing.JLabel	filler Holder that expands in the GridBagLayout, keeping things pushed to the left side of the toolpanel.
protected java.awt.GridBagLayout	gridbag
protected java.util.Hashtable<java.lang.String,Tool>	items The set of tools contained on the toolbar.
int	MAX_INDEXES
static java.lang.String	MembershipProperty
static java.lang.String	NameProperty
protected java.lang.String	parentName
protected java.lang.String	preferredLocation BorderLayout.NORTH by default for this class.
protected java.lang.String	propertyPrefix The property prefix used for this ToolPanel.
protected boolean[]	usedIndexes A little array used to track what indexes are already used, to prevent the GridBagLayout from placing things on top of each other.

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 com.bbn.openmap.gui.MapPanelChild

ParentNameProperty, PreferredLocationProperty

Fields inherited from interface com.bbn.openmap.PropertyConsumer

EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ToolPanel()
Constructor

Method Summary

void	add(java.lang.String key, Tool item) Add an item to the tool bar.
void	add(java.lang.String key, Tool item, int index) Add an item to the tool bar.
void	add(Tool item) Add an item to the tool bar.
void	add(Tool item, int index) Add an item to the tool bar.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener in_pcl) Method for BeanContextChild interface.
protected void	addSpace() Add a space between tools.
void	addVetoableChangeListener(java.lang.String propertyName, java.beans.VetoableChangeListener in_vcl) Method for BeanContextChild interface.
boolean	areComponentsVisible()
boolean	checkToolPanelToggleMenuItem(ToolPanelToggleMenuItem mi) Checks to see if the menu item controls this ToolPanel.
void	childrenAdded(java.beans.beancontext.BeanContextMembershipEvent bcme) BeanContextMembershipListener method.
void	childrenRemoved(java.beans.beancontext.BeanContextMembershipEvent bcme) BeanContextMembershipListener method.
void	componentHidden(java.awt.event.ComponentEvent ce)
void	componentMoved(java.awt.event.ComponentEvent ce)
void	componentResized(java.awt.event.ComponentEvent ce)
void	componentShown(java.awt.event.ComponentEvent ce)
void	findAndInit(java.util.Iterator<java.lang.Object> it) Called when the ToolPanel is added to the BeanContext, and when new objects are added to the BeanContext after that.
void	findAndInit(java.lang.Object someObj)
Tool	get(java.lang.String key) Get an item from the tool bar.
java.util.List<java.lang.String>	getAvoidList() Get the list of strings used by the ToolPanel to figure out which Tools should not be added (in the findAndInit()) method.
java.beans.beancontext.BeanContext	getBeanContext() Method for BeanContextChild interface.
java.util.List<java.lang.String>	getComponentList() Get the list of strings used by the ToolPanel to figure out which Tools should be added (in the findAndInit()) method and where they should go.
protected int	getNextAvailableIndex() Provides the next available component index for placement, starting at 0.
protected int	getNextAvailableIndex(int startAt) Provides the next available component index for placement, given a starting index.
java.lang.String	getParentName() Should return the name of the desired parent component.
java.lang.String	getPreferredLocation() MapPanelChild method.
java.util.Properties	getProperties(java.util.Properties props) Method to fill in a Properties object, reflecting the current values of the PropertyConsumer.
java.util.Properties	getPropertyInfo(java.util.Properties props) 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.
ToolPanelToggleMenuItem	getToggleMenu() Get a menu item that controls the visibility of this ToolPanel.
boolean	isAutoSpace() Find out whether spaces are being placed between tools.
protected int	keyOnList(java.lang.String key, java.util.List<java.lang.String> list) Figure out if the string key is in the provided list, and provide the location index of it is.
protected java.lang.StringBuffer	rebuildListProperty(java.util.List<java.lang.String> aList) Take a List of strings, and return a space-separated version.
void	remove(java.lang.String key) Remove a tool with the right key
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener in_pcl) Method for BeanContextChild interface.
void	removeVetoableChangeListener(java.lang.String propertyName, java.beans.VetoableChangeListener in_vcl) Method for BeanContextChild interface.
void	setAutoSpace(boolean set) Set whether spaces are placed between tools.
void	setAvoidList(java.util.List<java.lang.String> list) Set the list of strings used by the ToolPanel to figure out which Tools should not be added (in the findAndInit()) method.
void	setBeanContext(java.beans.beancontext.BeanContext in_bc) Method for BeanContextChild interface.
void	setComponentList(java.util.List<java.lang.String> list) Set the list of strings used by the ToolPanel to figure out which Tools should be added (in the findAndInit()) method and where they should go.
void	setParentName(java.lang.String parentName)
void	setPreferredLocation(java.lang.String value) MapPanelChild method.
void	setProperties(java.util.Properties props) Method to set the properties in the PropertyConsumer.
void	setProperties(java.lang.String prefix, java.util.Properties props) Method to set the properties in the PropertyConsumer.
void	setPropertyPrefix(java.lang.String prefix) Set the property key prefix that should be used by the PropertyConsumer.
protected void	setVisibility() If any of the components are visible, set the ToolPanel to be visible.

Methods inherited from class javax.swing.JToolBar

add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

items

protected java.util.Hashtable<java.lang.String,Tool> items

The set of tools contained on the toolbar.

autoSpace

protected boolean autoSpace

A flag to note whether the ToolPanel inserts spaces between tools.

propertyPrefix

protected java.lang.String propertyPrefix

The property prefix used for this ToolPanel.

ComponentsProperty

public static final java.lang.String ComponentsProperty

A list of components to use for filtering tools found in the MapHandler to add to this ToolPanel.

See Also:

Constant Field Values

AvoidComponentsProperty

public static final java.lang.String AvoidComponentsProperty

A list of components to use for filtering out tools found in the MapHandler. Components added to this list will NOT be added to this ToolPanel.

See Also:

Constant Field Values

MembershipProperty

public static final java.lang.String MembershipProperty

See Also:

Constant Field Values

NameProperty

public static final java.lang.String NameProperty

See Also:

Constant Field Values

componentList

protected java.util.List<java.lang.String> componentList

A filter list of components to look for and add.

avoidList

protected java.util.List<java.lang.String> avoidList

A filter list of components to avoid.

gridbag

protected java.awt.GridBagLayout gridbag

c

protected java.awt.GridBagConstraints c

parentName

protected java.lang.String parentName

filler

protected javax.swing.JLabel filler

Holder that expands in the GridBagLayout, keeping things pushed to the left side of the toolpanel.

usedIndexes

protected boolean[] usedIndexes

A little array used to track what indexes are already used, to prevent the GridBagLayout from placing things on top of each other.

MAX_INDEXES

public int MAX_INDEXES

preferredLocation

protected java.lang.String preferredLocation

BorderLayout.NORTH by default for this class.

Constructor Detail

ToolPanel

public ToolPanel()

Constructor

Method Detail

add

public void add(java.lang.String key,
                Tool item)

Add an item to the tool bar.

Parameters:

key - The key associated with the item.

item - The Tool to add.

getNextAvailableIndex

protected int getNextAvailableIndex()

Provides the next available component index for placement, starting at 0.

getNextAvailableIndex

protected int getNextAvailableIndex(int startAt)

Provides the next available component index for placement, given a starting index.

add

public void add(java.lang.String key,
                Tool item,
                int index)

Add an item to the tool bar.

Parameters:

key - The key associated with the item.

item - The Tool to add.

index - The position index for placement of the tool. -1 puts it at the end, and if the position is greater than the size, it is placed at the end. This class does not remember where items were asked to be placed, so later additions may mess up intended order.

add

public void add(Tool item)

Add an item to the tool bar. Assumes that the key will be picked out of the Tool.

Parameters:

item - The Tool to add.

add

public void add(Tool item,
                int index)

Add an item to the tool bar. Assumes that the key will be picked out of the Tool.

Parameters:

item - The Tool to add.

index - The position to add the Tool. -1 will add it to the end.

get

public Tool get(java.lang.String key)

Get an item from the tool bar.

Parameters:

key - The key associated with the item.

Returns:

The tool associated with the key, null if not found.

remove

public void remove(java.lang.String key)

Remove a tool with the right key

addSpace

protected void addSpace()

Add a space between tools.

setAutoSpace

public void setAutoSpace(boolean set)

Set whether spaces are placed between tools.

setPreferredLocation

public void setPreferredLocation(java.lang.String value)

MapPanelChild method.

Specified by:

setPreferredLocation in interface MapPanelChild

getPreferredLocation

public java.lang.String getPreferredLocation()

MapPanelChild method.

Specified by:

getPreferredLocation in interface MapPanelChild

isAutoSpace

public boolean isAutoSpace()

Find out whether spaces are being placed between tools.

setComponentList

public void setComponentList(java.util.List<java.lang.String> list)

Set the list of strings used by the ToolPanel to figure out which Tools should be added (in the findAndInit()) method and where they should go.

getComponentList

public java.util.List<java.lang.String> getComponentList()

Get the list of strings used by the ToolPanel to figure out which Tools should be added (in the findAndInit()) method and where they should go.

setAvoidList

public void setAvoidList(java.util.List<java.lang.String> list)

Set the list of strings used by the ToolPanel to figure out which Tools should not be added (in the findAndInit()) method.

getAvoidList

public java.util.List<java.lang.String> getAvoidList()

Get the list of strings used by the ToolPanel to figure out which Tools should not be added (in the findAndInit()) method.

findAndInit

public void findAndInit(java.util.Iterator<java.lang.Object> it)

Called when the ToolPanel is added to the BeanContext, and when new objects are added to the BeanContext after that. The ToolPanel looks for Tools that are part of the BeanContext.

Parameters:

it - iterator to use to go through the new objects.

keyOnList

protected int keyOnList(java.lang.String key,
                        java.util.List<java.lang.String> list)

Figure out if the string key is in the provided list, and provide the location index of it is.

Parameters:

key - the key of the component to check for.

list - the list of keys to check.

Returns:

-1 if not on the list, the index starting at 0 if it is.

findAndInit

public void findAndInit(java.lang.Object someObj)

getToggleMenu

public ToolPanelToggleMenuItem getToggleMenu()

Get a menu item that controls the visibility of this ToolPanel.

Returns:

ToolPanelToggleMenuItem

checkToolPanelToggleMenuItem

public boolean checkToolPanelToggleMenuItem(ToolPanelToggleMenuItem mi)

Checks to see if the menu item controls this ToolPanel.

Parameters:

mi -

Returns:

true if menu item refers to this tool panel.

childrenAdded

public void childrenAdded(java.beans.beancontext.BeanContextMembershipEvent bcme)

BeanContextMembershipListener method. Called when objects have been added to the parent BeanContext.

Specified by:

childrenAdded in interface java.beans.beancontext.BeanContextMembershipListener

Parameters:

bcme - the event containing the iterator with new objects.

childrenRemoved

public void childrenRemoved(java.beans.beancontext.BeanContextMembershipEvent bcme)

BeanContextMembershipListener method. Called when objects have been removed from the parent BeanContext. If the ToolPanel finds a Tool in the list, it removes it from the ToolPanel.

Specified by:

childrenRemoved in interface java.beans.beancontext.BeanContextMembershipListener

Parameters:

bcme - the event containing the iterator with removed objects.

getBeanContext

public java.beans.beancontext.BeanContext getBeanContext()

Method for BeanContextChild interface.

Specified by:

getBeanContext in interface java.beans.beancontext.BeanContextChild

setBeanContext

public void setBeanContext(java.beans.beancontext.BeanContext in_bc)
                    throws java.beans.PropertyVetoException

Method for BeanContextChild interface. Called when the ToolPanel is added to the BeanContext.

Specified by:

setBeanContext in interface java.beans.beancontext.BeanContextChild

Parameters:

in_bc - the BeanContext.

Throws:

java.beans.PropertyVetoException

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener in_pcl)

Method for BeanContextChild interface.

Specified by:

addPropertyChangeListener in interface java.beans.beancontext.BeanContextChild

Overrides:

addPropertyChangeListener in class java.awt.Container

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener in_pcl)

Method for BeanContextChild interface.

Specified by:

removePropertyChangeListener in interface java.beans.beancontext.BeanContextChild

Overrides:

removePropertyChangeListener in class java.awt.Component

addVetoableChangeListener

public void addVetoableChangeListener(java.lang.String propertyName,
                                      java.beans.VetoableChangeListener in_vcl)

Method for BeanContextChild interface.

Specified by:

addVetoableChangeListener in interface java.beans.beancontext.BeanContextChild

removeVetoableChangeListener

public void removeVetoableChangeListener(java.lang.String propertyName,
                                         java.beans.VetoableChangeListener in_vcl)

Method for BeanContextChild interface.

Specified by:

removeVetoableChangeListener in interface java.beans.beancontext.BeanContextChild

setPropertyPrefix

public void setPropertyPrefix(java.lang.String prefix)

Description copied from interface: PropertyConsumer

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()

Description copied from interface: PropertyConsumer

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 prefix string

setProperties

public void setProperties(java.util.Properties props)

Description copied from interface: PropertyConsumer

Method to set the properties in the PropertyConsumer. It is assumed that the properties do not have a prefix associated with them, or that the prefix has already been set.

Specified by:

setProperties in interface PropertyConsumer

Parameters:

props - a properties object that the PropertyConsumer can use to retrieve expected properties it can use for configuration.

setProperties

public void setProperties(java.lang.String prefix,
                          java.util.Properties props)

Description copied from interface: PropertyConsumer

Method to set the properties in the PropertyConsumer. The prefix is a string that should be prepended to each property key (in addition to a separating '.') in order for the PropertyConsumer to uniquely identify properties meant for it, in the midst of of Properties meant for several objects.

Specified by:

setProperties in interface PropertyConsumer

Parameters:

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.

props - a Properties object that the PropertyConsumer can use to retrieve expected properties it can use for configuration.

rebuildListProperty

protected java.lang.StringBuffer rebuildListProperty(java.util.List<java.lang.String> aList)

Take a List of strings, and return a space-separated version. Return null if the List is null.

getProperties

public java.util.Properties getProperties(java.util.Properties props)

Description copied from interface: PropertyConsumer

Method to fill in a Properties object, reflecting the current values of the PropertyConsumer. If the PropertyConsumer has a prefix 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 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.

getPropertyInfo

public java.util.Properties getPropertyInfo(java.util.Properties props)

Description copied from interface: PropertyConsumer

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.).

Specified by:

getPropertyInfo in interface PropertyConsumer

Parameters:

props - 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.

setVisibility

protected void setVisibility()

If any of the components are visible, set the ToolPanel to be visible. If all of them are invisible, make the ToolPanel invisible.

areComponentsVisible

public boolean areComponentsVisible()

componentHidden

public void componentHidden(java.awt.event.ComponentEvent ce)

Specified by:

componentHidden in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent ce)

Specified by:

componentMoved in interface java.awt.event.ComponentListener

componentResized

public void componentResized(java.awt.event.ComponentEvent ce)

Specified by:

componentResized in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent ce)

Specified by:

componentShown in interface java.awt.event.ComponentListener

getParentName

public java.lang.String getParentName()

Description copied from interface: MapPanelChild

Should return the name of the desired parent component. This method lets a MapPanel to ask a component if it should be added to the panel. Enables application components to configure themselves from property file information.

Specified by:

getParentName in interface MapPanelChild

Returns:

the name of the parent component that the MapPanelChild should be added to, or null if it doesn't know.

setParentName

public void setParentName(java.lang.String parentName)