gov.noaa.pmel.sgt.beans
Class PanelHolder

java.lang.Object
  extended by gov.noaa.pmel.sgt.beans.PanelHolder
All Implemented Interfaces:
java.io.Serializable, java.util.EventListener, javax.swing.event.ChangeListener

public class PanelHolder
extends java.lang.Object
implements javax.swing.event.ChangeListener, java.io.Serializable

Object to hold all the objects necessary to describe a Panel. Associated objects include Label, DataGroup, and Legend.

Since:
3.0
Version:
$Revision$, $Date$
Author:
Donald Denbo
See Also:
Label, Panel, PanelModel for UML diagram, DataGroup, Legend, Serialized Form

Constructor Summary
PanelHolder()
          Default constructor.
PanelHolder(java.lang.String id, PanelModel pModel)
          PanelHolder constructor.
PanelHolder(java.lang.String id, PanelModel pModel, java.awt.Rectangle bounds, java.util.Map labels, java.util.Map dataGroups, java.util.Map legends)
          PanelHolder constructor.
 
Method Summary
 void addChangeListener(javax.swing.event.ChangeListener l)
          Add changelistener
 void addDataGroup(DataGroup dataGroup)
          Add DataGroup to the PanelHolder.
 void addLabel(Label label)
          Add Label to the PanelHolder.
 void addLegend(Legend legend)
          Add Legend to the PanelHolder.
 java.util.Iterator dataGroupIterator()
          Get an Iterator of DataGroup objects.
 DataGroup findDataGroup(java.lang.String id)
          Find a DataGroup by identifier.
 Label findLabel(java.lang.String id)
          Find Label by identifier.
 Legend findLegend(java.lang.String id)
          Find Legend by identifier.
protected  void fireStateChanged()
           
 java.awt.Color getBackground()
          Get background color.
 javax.swing.border.Border getBorder()
          Return Border for Panel.
 java.awt.Rectangle getBounds()
          Get bounds of Panel.
 java.util.Map getDataGroups()
          Get Map containing DataGroups.
 int getDataGroupSize()
          Get number of DataGroup objects in Map.
 java.lang.String getId()
          Get PanelHolder identifier
 java.util.Map getLabels()
          Get Map of Labels.
 int getLabelSize()
          Get number of Label objects in Map.
 java.util.Map getLegends()
          Get Map containing Legends.
 int getLegendSize()
          Get number of Legend objects in Map.
 PanelModel getPanelModel()
          Get the PanelModel.
 boolean hasDataGroup(java.lang.String id)
          Does PanelHolder contain DataGroup?
 boolean hasLabel(java.lang.String id)
          Does PanelHolder contain Label?
 boolean hasLegend(java.lang.String id)
          Does PanelHolder contain Legend?
 boolean isInstantiated()
          Is panel instantiated?
 boolean isUsePageBackground()
          Use the page background color?
 boolean isVisible()
          Is Panel visible?
 java.util.Iterator labelIterator()
          Get an Iterator of Label objects.
 java.util.Iterator legendIterator()
          Get an Iterator of Legend objects.
 void removeAllChangeListeners()
          Remove all ChangeListeners.
 void removeChangeListener(javax.swing.event.ChangeListener l)
          Remove changelistener.
 void removeDataGroup(DataGroup dataGroup)
          Remove DataGroup from the PanelHolder.
 void removeDesignChangeListeners()
          Remove all ChangeListeners that implement the DesignListener interface.
 void removeLabel(Label label)
          Remove Label from the PanelHolder.
 void removeLegend(Legend legend)
          Remove Legend from the PanelHolder.
 void setBackground(java.awt.Color background)
          Set the Panel background color.
 void setBorder(javax.swing.border.Border border)
          Set Border for Panel.
 void setBounds(java.awt.Rectangle bounds)
          Set bounds of Panel.
 void setDataGroups(java.util.Map dataGroups)
          Set Map of DataGroups.
 void setId(java.lang.String id)
          Set PanelHolder identifier.
 void setInstantiated(boolean instantiated)
          Set instantiated.
 void setLabels(java.util.Map labels)
          Set Map of Labels.
 void setLegends(java.util.Map legends)
          Set Map of Legends.
 void setPanelModel(PanelModel pModel)
          Set the PanelModel parent.
 void setUsePageBackground(boolean pageBackground)
          Set the Panel to use the Page background color.
 void setVisible(boolean visible)
          Set Panel visible.
 void stateChanged(javax.swing.event.ChangeEvent e)
          ChangeListner callback.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PanelHolder

public PanelHolder()
Default constructor. Sets PanelHolder identifier and PanelModel parent to null.


PanelHolder

public PanelHolder(java.lang.String id,
                   PanelModel pModel)
PanelHolder constructor.

Parameters:
id - PanelHolder identifier
pModel - PanelModel parent

PanelHolder

public PanelHolder(java.lang.String id,
                   PanelModel pModel,
                   java.awt.Rectangle bounds,
                   java.util.Map labels,
                   java.util.Map dataGroups,
                   java.util.Map legends)
PanelHolder constructor. This constructor has arguments to pass Maps of Label, DataGroup, and Legend objects. The Map key is the objects identifier.

Parameters:
id - PanelHolder identifier
pModel - PanelModel parent
bounds - bounds
labels - Map containing Labels
dataGroups - Map containing DataGroups
legends - Map contiaining Legends
Method Detail

setPanelModel

public void setPanelModel(PanelModel pModel)
Set the PanelModel parent.

Parameters:
pModel - PanelModel

getPanelModel

public PanelModel getPanelModel()
Get the PanelModel.

Returns:
PanelModel

addLabel

public void addLabel(Label label)
Add Label to the PanelHolder.

Parameters:
label - Label

removeLabel

public void removeLabel(Label label)
Remove Label from the PanelHolder.

Parameters:
label - Label

addDataGroup

public void addDataGroup(DataGroup dataGroup)
Add DataGroup to the PanelHolder.

Parameters:
dataGroup - DataGroup

removeDataGroup

public void removeDataGroup(DataGroup dataGroup)
Remove DataGroup from the PanelHolder.

Parameters:
dataGroup - DataGroup

addLegend

public void addLegend(Legend legend)
Add Legend to the PanelHolder.

Parameters:
legend - Legend

removeLegend

public void removeLegend(Legend legend)
Remove Legend from the PanelHolder.

Parameters:
legend - Legend

setId

public void setId(java.lang.String id)
Set PanelHolder identifier.

Parameters:
id - identifier

getId

public java.lang.String getId()
Get PanelHolder identifier

Returns:
identifier

getLabelSize

public int getLabelSize()
Get number of Label objects in Map.

Returns:
number of Labels

getDataGroupSize

public int getDataGroupSize()
Get number of DataGroup objects in Map.

Returns:
number of DataGroups

getLegendSize

public int getLegendSize()
Get number of Legend objects in Map.

Returns:
number of Legends

labelIterator

public java.util.Iterator labelIterator()
Get an Iterator of Label objects.

Returns:
Iterator

dataGroupIterator

public java.util.Iterator dataGroupIterator()
Get an Iterator of DataGroup objects.

Returns:
Iterator

legendIterator

public java.util.Iterator legendIterator()
Get an Iterator of Legend objects.

Returns:
Iterator

setBounds

public void setBounds(java.awt.Rectangle bounds)
Set bounds of Panel.

Parameters:
bounds - bounds

getBounds

public java.awt.Rectangle getBounds()
Get bounds of Panel.

Returns:
bounds

removeAllChangeListeners

public void removeAllChangeListeners()
Remove all ChangeListeners.


stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)
ChangeListner callback.

Specified by:
stateChanged in interface javax.swing.event.ChangeListener
Parameters:
e - ChangeEvent

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)
Remove changelistener.

Parameters:
l - changelistener

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)
Add changelistener

Parameters:
l - changelistener

removeDesignChangeListeners

public void removeDesignChangeListeners()
Remove all ChangeListeners that implement the DesignListener interface.

See Also:
DesignListener

fireStateChanged

protected void fireStateChanged()

setVisible

public void setVisible(boolean visible)
Set Panel visible.

Parameters:
visible - true if visible

isVisible

public boolean isVisible()
Is Panel visible?

Returns:
true, if Panel is visible

setInstantiated

public void setInstantiated(boolean instantiated)
Set instantiated. Once associated Panel object has been created this property is set true. Used internally.

Parameters:
instantiated - true if instantiated

isInstantiated

public boolean isInstantiated()
Is panel instantiated?

Returns:
true, if Panel instantiated

findDataGroup

public DataGroup findDataGroup(java.lang.String id)
Find a DataGroup by identifier.

Parameters:
id - identifier
Returns:
DataGroup

findLabel

public Label findLabel(java.lang.String id)
Find Label by identifier.

Parameters:
id - identifier
Returns:
Label

findLegend

public Legend findLegend(java.lang.String id)
Find Legend by identifier.

Parameters:
id - identifier
Returns:
Legend

hasDataGroup

public boolean hasDataGroup(java.lang.String id)
Does PanelHolder contain DataGroup?

Parameters:
id - DataGroup identifier
Returns:
true, if DataGroup exists

hasLabel

public boolean hasLabel(java.lang.String id)
Does PanelHolder contain Label?

Parameters:
id - Label identifier
Returns:
Label

hasLegend

public boolean hasLegend(java.lang.String id)
Does PanelHolder contain Legend?

Parameters:
id - Legend identifier
Returns:
Legend

getBorder

public javax.swing.border.Border getBorder()
Return Border for Panel.

Returns:
Border

setBorder

public void setBorder(javax.swing.border.Border border)
Set Border for Panel. Default = LineBorder(gray, 2)

Parameters:
border - Border

getLabels

public java.util.Map getLabels()
Get Map of Labels.

Returns:
Map

setLabels

public void setLabels(java.util.Map labels)
Set Map of Labels. Key in Map contains Label identifier.

Parameters:
labels - Label Map

getLegends

public java.util.Map getLegends()
Get Map containing Legends.

Returns:
Map

setLegends

public void setLegends(java.util.Map legends)
Set Map of Legends. Key in Map contains Legend identifier.

Parameters:
legends - Legend Map

getDataGroups

public java.util.Map getDataGroups()
Get Map containing DataGroups.

Returns:
Map

setDataGroups

public void setDataGroups(java.util.Map dataGroups)
Set Map of DataGroups. Key in Map contains DataGroup identifier.

Parameters:
dataGroups - DataGroup Map

getBackground

public java.awt.Color getBackground()
Get background color. Will use the page background if usePageBackground property is true.

Returns:
color

setBackground

public void setBackground(java.awt.Color background)
Set the Panel background color.

Parameters:
background - color

isUsePageBackground

public boolean isUsePageBackground()
Use the page background color?

Returns:
true if using page background color

setUsePageBackground

public void setUsePageBackground(boolean pageBackground)
Set the Panel to use the Page background color.

Parameters:
pageBackground - true to use page background color