public abstract class IdvLegend extends java.lang.Object implements Removable
Modifier and Type | Field and Description |
---|---|
static javax.swing.ImageIcon |
ICON_DOCKED
_more_
|
static javax.swing.ImageIcon |
ICON_FLOAT
_more_
|
protected static javax.swing.ImageIcon |
ICON_PROPERTIES
The icon used to bring up the display properties window
|
static javax.swing.ImageIcon |
ICON_REMOVE
Icon used to remove displays
|
static java.lang.String |
STATE_DOCKED
_more_
|
static java.lang.String |
STATE_FLOAT
_more_
|
static java.lang.String |
STATE_HIDDEN
_more_
|
protected ViewManager |
viewManager
The
ViewManager this legend is part of |
Constructor and Description |
---|
IdvLegend()
Parameterless constructor for xml persistence
|
IdvLegend(ViewManager viewManager)
Create the legend with the given
ViewManager |
Modifier and Type | Method and Description |
---|---|
void |
doClose()
The ViewManager in which thie legend is a part of has been closed.
|
protected abstract javax.swing.JComponent |
doMakeContents()
To be overrode by derived classes to return the actual GUI contents.
|
void |
doRemove()
_more_
|
void |
fillLegend()
This is called when there is a change to the list of DisplayControls shown in this legend.
|
protected abstract void |
fillLegendSafely()
To be overrode by derived classes to fill the legend.
|
void |
floatLegend()
Float the legend in its own window.
|
javax.swing.JComponent |
getContainer()
Get the Container property.
|
javax.swing.JComponent |
getContents()
Create, if needed, and return the GUI contents.
|
protected javax.swing.JButton |
getFloatButton()
Create, if needed, and return the floatButton.
|
protected java.lang.String |
getTitle()
Get the window title to use.
|
protected javax.swing.JButton |
makePropertiesButton(DisplayControl control)
Create an icon button for showing the window for the given display control.
|
void |
setColors(java.awt.Color foreground,
java.awt.Color background)
No-op.
|
void |
setContentsToUse(javax.swing.JComponent contents)
_more_
|
void |
setTheContainer(javax.swing.JComponent value)
Set the Container property.
|
void |
setViewManager(ViewManager viewManager)
Set the view manager that this legend is part of
|
void |
showLegend()
This will float the legend.
|
void |
unFloatLegend()
_more_
|
public static final java.lang.String STATE_HIDDEN
public static final java.lang.String STATE_DOCKED
public static final java.lang.String STATE_FLOAT
public static final javax.swing.ImageIcon ICON_FLOAT
public static final javax.swing.ImageIcon ICON_DOCKED
protected static javax.swing.ImageIcon ICON_PROPERTIES
public static javax.swing.ImageIcon ICON_REMOVE
protected ViewManager viewManager
ViewManager
this legend is part ofpublic IdvLegend()
public IdvLegend(ViewManager viewManager)
ViewManager
viewManager
- The view manager this legend is a part ofpublic void setContentsToUse(javax.swing.JComponent contents)
contents
- _more_public javax.swing.JComponent getContents()
public void setViewManager(ViewManager viewManager)
viewManager
- The view managerpublic void setTheContainer(javax.swing.JComponent value)
value
- The new value for Containerpublic javax.swing.JComponent getContainer()
public void setColors(java.awt.Color foreground, java.awt.Color background)
foreground
- The foreground color of the ViewManagerbackground
- The background color of the ViewManagerprotected javax.swing.JButton getFloatButton()
public void showLegend()
protected abstract javax.swing.JComponent doMakeContents()
public final void fillLegend()
protected abstract void fillLegendSafely()
fillLegend()
within a synchronized block.protected javax.swing.JButton makePropertiesButton(DisplayControl control)
control
- The display controlpublic void doClose()
protected java.lang.String getTitle()
public void unFloatLegend()
public void floatLegend()