public interface DisplayControl extends Sharable
Modifier and Type | Field and Description |
---|---|
static int |
BOTTOM_LEGEND
Bottom type legend
|
static java.lang.String |
DEFAULT_PROBEFORMAT
Default format for probe format
|
static java.lang.String |
PREF_PREFIX
Preference prefix for preferences of this class.
|
static java.lang.String |
PREF_PROBEFORMAT
Preference for probe format
|
static java.lang.String |
PREF_REMOVEONWINDOWCLOSE
Preference for whether the control should be removed when
the window is closed
|
static java.lang.String |
PREF_SAMPLING_MODE
Preference for sampling mode
|
static java.lang.String |
PREF_STANDALONE_REMOVEONCLOSE
Should we remove stand alone display controls when their window is closed
|
static java.lang.String |
PREF_STANDALONE_REMOVEONCLOSE_ASK
Should we ask the user if they want to remove stand alone display controls
|
static java.lang.String |
PROP_LEGENDICON
The property name of the String path or url of the icon this
display control should show in its legend.
|
static int |
RASTERMODE_SHOWALL
Show all flag
|
static int |
RASTERMODE_SHOWNONRASTER
Show no raster flag
|
static int |
RASTERMODE_SHOWRASTER
Show raster flag
|
static int |
SIDE_LEGEND
Side type legend
|
Modifier and Type | Method and Description |
---|---|
void |
applyPreferences()
Apply preferences to this control.
|
boolean |
canBeDocked()
Can this be docked
|
javax.swing.JCheckBox |
doMakeVisibilityControl(java.lang.String label)
Make a visibility control as a JCheckbox.
|
void |
doRemove()
Called when the DisplayControl is removed from the display
|
void |
firstFrameDone()
Method to call when the first frame has been rendered.
|
boolean |
getActive()
Is this control active or has it been removed
|
boolean |
getCanDoRemoveAll()
See if this DisplayControl can remove all controls.
|
java.util.List |
getCategories()
Get the list of
DataCategory s |
boolean |
getCollapseLegend()
Get the collapsed state of the legend.
|
java.util.List |
getControlMenus(javax.swing.JComponent comp)
Get the menus for this control.
|
java.util.List |
getCursorReadout(visad.georef.EarthLocation el,
visad.Real animationValue,
int animationStep,
java.util.List<ReadoutInfo> samples)
Get the cursor readout
|
DataChoice |
getDataChoice()
Get the
DataChoice associated with this control. |
java.util.List |
getDataChoices()
Get the list of
DataChoice s associated with this control. |
visad.Data |
getDataForDisplayList()
Get the data for the display list
|
visad.georef.MapProjection |
getDataProjection()
Get the
MapProjection associated with the data in
this DisplayControl. |
ViewManager |
getDefaultViewManager()
Get the default view manager for this control
|
java.lang.String |
getDisplayCategory()
Get the display category for this DisplayControl.
|
java.lang.String |
getDisplayId()
Get the display id for this control.
|
DisplayableData |
getDisplayListDisplayable(ViewManager view)
Get the displayable for the display list for the particular view
|
boolean |
getDisplayVisibility()
Get the display's visibility.
|
boolean |
getExpandedInTabs()
Is this control expanded when it is shown in the main tabs
|
boolean |
getIsTimeDriver()
is this display the one that drives time selection for other displays
|
java.lang.String |
getLabel()
Get a label describing control
|
javax.swing.JComponent |
getLegendButtons(int legendType)
Get the legend component for the type of legend
|
javax.swing.JComponent |
getLegendComponent(int legendType)
Get the legend component for the type of legend
|
javax.swing.JComponent |
getLegendLabel(int legendType)
Get the legend lable for the type of legend
|
boolean |
getLockVisibilityToggle()
Get whether the visibility of this display control is locked
(could be on or off)
|
java.lang.String |
getMenuLabel()
Get the text that should show up in a menu listing this control.
|
boolean |
getShowInDisplayList()
Should this display be shown in the display list
|
boolean |
getShowInLegend()
Should the display control be shown in a legend
|
boolean |
getShowInTabs()
Should we show this control in the main tabs
|
visad.Set |
getTimeSet()
get the time set of the data
|
java.lang.Object |
getTmpProperty(java.lang.Object key)
Get the tmp property.
|
java.lang.Object |
getTransientProperty(java.lang.Object key)
Find a property on the display control.
|
ViewManager |
getViewManager()
Get the view manager for this control
|
int |
getVisbilityAnimationPause()
How long should this display be shown when in visibility animation mode
|
javax.swing.JFrame |
getWindow()
Get the control window for this DisplayControl.
|
void |
init(java.lang.String displayId,
java.util.List dataCategories,
java.util.List choices,
ControlContext viewer,
java.util.Hashtable properties,
DataSelection dataSelection)
Initialize the DisplayControl.
|
void |
init(java.lang.String displayId,
java.util.List dataCategories,
java.util.List choices,
ControlContext viewer,
java.lang.String properties,
DataSelection dataSelection)
Deprecated.
Use init that that takes a properties Hashtable
|
void |
initAfterUnPersistence(ControlContext vc,
java.util.Hashtable properties)
Method to call after unpersisting from XML.
|
void |
initAfterUnPersistence(ControlContext vc,
java.util.Hashtable properties,
java.util.List dataChoices)
Initialize after unpersistance
|
void |
initAsTemplate()
Intialize the display control when it is created from a template
|
void |
initBasic(java.lang.String displayId,
java.util.List categories,
java.util.Hashtable properties)
Do basic initialization.
|
boolean |
isInitDone()
Are we fully initialized
|
javax.swing.JLabel |
makeLegendLabel()
Make a label like the one in the legend
|
void |
moveTo(ViewManager viewManager)
Move this control to a different
ViewManager . |
void |
projectionChanged()
Method called when a map projection changes.
|
void |
putTmpProperty(java.lang.Object key,
java.lang.Object value)
put the tmp property.
|
void |
putTransientProperty(java.lang.Object key,
java.lang.Object value)
Put a property on the display control.
|
java.lang.Object |
removeTmpProperty(java.lang.Object key)
remove the tmp property
|
void |
saveImage(java.lang.String filename)
Save an image of this control to a file.
|
void |
setCollapseLegend(boolean collapse)
Set the collapsed state of the legend.
|
void |
setDisplayCategory(java.lang.String category)
Set the display category
|
void |
setDisplayVisibility(boolean b)
Set the display's visibility.
|
void |
setExpandedInTabs(boolean value)
Set whether this control expanded when it is shown in the main tabs
|
void |
setLegendBackground(java.awt.Color bg)
Set the background color on the legend component
|
void |
setLegendForeground(java.awt.Color fg)
Set the foreground color on the legend component
|
void |
setLockVisibilityToggle(boolean value)
Set whether the visibility of this display control is locked
(could be on or off)
|
void |
setShowInTabs(boolean value)
Set whether to show this control in the main tabs
|
boolean |
shouldBeDocked()
Should this be docked?
|
void |
show()
Show this control's component
|
void |
showHelp()
Show help
|
void |
toFront()
Bring this control's component to the front
|
void |
toggleVisibilityForVectorGraphicsRendering(int rasterMode)
Toggle the visibility for vector graphics rendering based on mode
|
void |
toggleWindow()
Hide or show the main window
|
void |
transectChanged()
Method called when a transect changes.
|
void |
viewManagerChanged(java.lang.String property)
Method called when a view manager changes.
|
void |
viewManagerDestroyed(ViewManager viewManager)
Called when a ViewManager which holds the display is destoryed
|
void |
writeTestArchive(java.lang.String archivePath)
This is called when we are generating a test archive of images from all components
|
getReceiveShareTime, getShareGroup, getSharing, getUniqueId, receiveShareData, setReceiveShareTime
static final java.lang.String PREF_PREFIX
static final java.lang.String PROP_LEGENDICON
static final java.lang.String PREF_SAMPLING_MODE
static final java.lang.String PREF_PROBEFORMAT
static final java.lang.String DEFAULT_PROBEFORMAT
static final java.lang.String PREF_REMOVEONWINDOWCLOSE
static final java.lang.String PREF_STANDALONE_REMOVEONCLOSE
static final java.lang.String PREF_STANDALONE_REMOVEONCLOSE_ASK
static final int BOTTOM_LEGEND
static final int SIDE_LEGEND
static final int RASTERMODE_SHOWRASTER
static final int RASTERMODE_SHOWNONRASTER
static final int RASTERMODE_SHOWALL
void init(java.lang.String displayId, java.util.List dataCategories, java.util.List choices, ControlContext viewer, java.lang.String properties, DataSelection dataSelection) throws visad.VisADException, java.rmi.RemoteException
displayId
- the display iddataCategories
- the DisplayControl's data categorieschoices
- a list of DataChoice
sviewer
- the control context in which this is viewedproperties
- propertiesdataSelection
- specific data selection propertiesjava.rmi.RemoteException
- Java RMI errorvisad.VisADException
- VisAD errorvoid init(java.lang.String displayId, java.util.List dataCategories, java.util.List choices, ControlContext viewer, java.util.Hashtable properties, DataSelection dataSelection) throws visad.VisADException, java.rmi.RemoteException
displayId
- the display iddataCategories
- the DisplayControl's data categorieschoices
- a list of DataChoice
sviewer
- the control context in which this is viewedproperties
- extra propertiesdataSelection
- specific data selection propertiesjava.rmi.RemoteException
- Java RMI errorvisad.VisADException
- VisAD errorboolean isInitDone()
javax.swing.JFrame getWindow()
boolean getLockVisibilityToggle()
boolean getShowInDisplayList()
DisplayableData getDisplayListDisplayable(ViewManager view)
view
- The view managervisad.Data getDataForDisplayList()
void setLockVisibilityToggle(boolean value)
value
- true to lock to current statejavax.swing.JComponent getLegendComponent(int legendType)
legendType
- type of legend (BOTTOM, SIDE)javax.swing.JComponent getLegendButtons(int legendType)
legendType
- type of legend (BOTTOM, SIDE)void setCollapseLegend(boolean collapse)
collapse
- true to collapse the legend.boolean getCollapseLegend()
javax.swing.JComponent getLegendLabel(int legendType)
legendType
- type of legend (BOTTOM, SIDE)void doRemove() throws visad.VisADException, java.rmi.RemoteException
java.rmi.RemoteException
- Java RMI errorvisad.VisADException
- VisAD errorvoid viewManagerDestroyed(ViewManager viewManager) throws visad.VisADException, java.rmi.RemoteException
viewManager
- The view manager that has been destroyedjava.rmi.RemoteException
- Java RMI errorvisad.VisADException
- VisAD errorboolean getCanDoRemoveAll()
boolean getActive()
DataChoice getDataChoice()
DataChoice
associated with this control.java.util.List getDataChoices()
DataChoice
s associated with this control.java.lang.String getDisplayId()
java.lang.String getMenuLabel()
java.util.List getControlMenus(javax.swing.JComponent comp)
comp
- component for placement of window (can be null)java.lang.String getLabel()
void moveTo(ViewManager viewManager)
ViewManager
.viewManager
- ViewManager to move to.ViewManager getViewManager()
ViewManager getDefaultViewManager()
void saveImage(java.lang.String filename)
filename
- filename to save tovoid toFront()
javax.swing.JLabel makeLegendLabel()
void show()
void toggleWindow()
void setDisplayVisibility(boolean b)
b
- true to set it visibleboolean getDisplayVisibility()
void toggleVisibilityForVectorGraphicsRendering(int rasterMode) throws java.lang.Exception
rasterMode
- mode to usejava.lang.Exception
- problem togglingjavax.swing.JCheckBox doMakeVisibilityControl(java.lang.String label)
label
- label for the visibility checkboxvoid setLegendForeground(java.awt.Color fg)
fg
- foreground colorvoid setLegendBackground(java.awt.Color bg)
bg
- background colorvoid initAfterUnPersistence(ControlContext vc, java.util.Hashtable properties)
vc
- control context for this DisplayControl.properties
- A place to put propertiesvoid initAfterUnPersistence(ControlContext vc, java.util.Hashtable properties, java.util.List dataChoices)
vc
- the control contextproperties
- the propertiesdataChoices
- the list of data choicesvoid initAsTemplate()
void initBasic(java.lang.String displayId, java.util.List categories, java.util.Hashtable properties)
displayId
- idcategories
- display categoriesproperties
- propertiesvoid firstFrameDone()
void writeTestArchive(java.lang.String archivePath)
archivePath
- Where to write the imagesvisad.georef.MapProjection getDataProjection()
MapProjection
associated with the data in
this DisplayControl.void projectionChanged()
void transectChanged()
void viewManagerChanged(java.lang.String property)
property
- the property that changedjava.lang.String getDisplayCategory()
void setDisplayCategory(java.lang.String category)
category
- the display categoryjava.util.List getCategories()
DataCategory
sjava.lang.Object getTransientProperty(java.lang.Object key)
key
- The keyvoid putTransientProperty(java.lang.Object key, java.lang.Object value)
key
- The keyvalue
- The valuevoid applyPreferences()
boolean getShowInLegend()
void showHelp()
boolean getExpandedInTabs()
void setExpandedInTabs(boolean value)
value
- valueboolean getShowInTabs()
boolean shouldBeDocked()
boolean canBeDocked()
void setShowInTabs(boolean value)
value
- valuevisad.Set getTimeSet() throws java.rmi.RemoteException, visad.VisADException
java.rmi.RemoteException
- on badnessvisad.VisADException
- on badnessjava.util.List getCursorReadout(visad.georef.EarthLocation el, visad.Real animationValue, int animationStep, java.util.List<ReadoutInfo> samples) throws java.lang.Exception
el
- positionanimationValue
- animation valueanimationStep
- animation indexsamples
- the list of samples to add tojava.lang.Exception
- problem getting the cursor readoutjava.lang.Object getTmpProperty(java.lang.Object key)
key
- keyvoid putTmpProperty(java.lang.Object key, java.lang.Object value)
key
- keyvalue
- valuejava.lang.Object removeTmpProperty(java.lang.Object key)
key
- keyint getVisbilityAnimationPause()
boolean getIsTimeDriver()