ucar.unidata.idv
Class IdvBase

java.lang.Object
  ucar.unidata.idv.IdvBase

All Implemented Interfaces:

IdvConstants, XmlPersistable

Direct Known Subclasses:

IntegratedDataViewer

public abstract class IdvBase
extends Object
implements IdvConstants, XmlPersistable

This is the base class for the IntegratedDataViewer. It holds a set of managers (e.g., IdvUIManager, DataManager) and has methods to create them and get them. These factory could be overwritten by derived classes to create their own kind of manager or editor or so some different initialization.

Version:

$Revision: 1.40 $Date: 2007/06/12 22:52:02 $

Author:

IDV development team

Field Summary

protected AliasEditor	aliasEditor The data alias editor
protected String[]	args Command line arguments
protected ArgsManager	argsManager The command line argument manager
protected AutoDisplayEditor	autoDisplayEditor The data alias editor
protected IdvChooserManager	chooserManager The chooser manager
protected CollabManager	collabManager Handles collaboration and the event capture
protected ColorTableEditor	colorTableEditor The color table editor.
protected ColorTableManager	colorTableManager The color table manager.
protected DataManager	dataManager The data manager
protected DisplayConventions	displayConventions Handles the different display conventions
protected IntegratedDataViewer	idv The idv.
protected ImageGenerator	imageGenerator Handles generating images, movies, etc.
protected InstallManager	installManager Handles reinstalling the IDV
protected JythonManager	jythonManager The jython manager
protected ParamDefaultsEditor	paramDefaultsEditor The parameter defaults editor
protected ParamGroupsEditor	paramGroupsEditor The parameter defaults editor
protected IdvPersistenceManager	persistenceManager Handles bundle writing
protected PluginManager	pluginManager The plugin manager
protected IdvPreferenceManager	preferenceManager Handles the end user preferences
protected IdvProjectionManager	projectionManager The porojection manager
protected PublishManager	publishManager Handles doing publishing of content
protected IdvResourceManager	resourceManager The resource manager
protected ResourceViewer	resourceViewer _more_
protected StateManager	stateManager Handles properties, etc.
protected StationModelManager	stationModelManager The station model manager
protected ucar.unidata.idv.test.TestManager	testManager Handles running tests, creating test archives, etc.
protected IdvUIManager	uiManager Handles creating user interfaces, etc.
protected VMManager	vmManager The manager of ViewManagers

Fields inherited from interface ucar.unidata.idv.IdvConstants

ARG_B64BUNDLE, ARG_B64ISL, ARG_BUNDLE, ARG_CATALOG, ARG_CHOOSER, ARG_CLEARDEFAULT, ARG_CODE, ARG_CONNECT, ARG_CURRENTTIME, ARG_DATA, ARG_DEBUG, ARG_DEFAULT, ARG_DISPLAY, ARG_DXML, ARG_FIXEDTIME, ARG_HELP, ARG_IMAGE, ARG_IMAGESERVER, ARG_INSTALLPLUGIN, ARG_ISLFILE, ARG_ISLINTERACTIVE, ARG_LISTRESOURCES, ARG_MAINCLASS, ARG_MOVIE, ARG_MSG_DEBUG, ARG_MSG_RECORD, ARG_NODEFAULT, ARG_NOERRORSINGUI, ARG_NOGUI, ARG_NOONEINSTANCE, ARG_NOPLUGINS, ARG_NOPREF, ARG_ONEINSTANCEPORT, ARG_PLUGIN, ARG_PORT, ARG_PRINTJNLP, ARG_PROPERTIES, ARG_SCRIPT, ARG_SERVER, ARG_SETFILES, ARG_SITEPATH, ARG_TEMPLATE, ARG_TEST, ARG_TESTEVAL, ARG_TRACE, ARG_TRACEONLY, ARG_USERPATH, DEFAULT_DATE_FORMAT, DEFAULT_DOCPATH, DEFAULT_MAX_PERMGENSIZE, DEFAULT_TIMEZONE, FILTER_CPT, FILTER_ISL, FILTER_JNLP, FILTER_XIDV, FILTER_XIDVZIDV, FILTER_XML, FILTER_ZIDV, ID_COMMANDSTORUN, ID_DATASOURCES, ID_DISPLAYCONTROLS, ID_IDV, ID_JYTHON, ID_MESSAGE, ID_MISCHASHTABLE, ID_NCIDV_VERSION, ID_VERSION, ID_VIEWMANAGERS, ID_WINDOWS, INITIAL_PROBE_EARTHLOCATION, NULL_DATA_SELECTION, NULL_STRING, PREF_ARCHIVEDIR, PREF_ARCHIVENAME, PREF_AUTODISPLAYS_ENABLE, PREF_AUTODISPLAYS_SHOWGUI, PREF_AUTOSELECTDATA, PREF_CACHESIZE, PREF_CONTROLSINTABS, PREF_DATAPREFIX, PREF_DATE_FORMAT, PREF_DISTANCEUNIT, PREF_DOCACHE, PREF_EMBEDDATACHOOSERINDASHBOARD, PREF_EMBEDFIELDSELECTORINDASHBOARD, PREF_EMBEDLEGENDINDASHBOARD, PREF_EMBEDQUICKLINKSINDASHBOARD, PREF_EVENT_KEYBOARDMAP, PREF_EVENT_MOUSEMAP, PREF_EVENT_WHEELMAP, PREF_FAST_RENDER, PREF_FIELD_CACHETHRESHOLD, PREF_FILEREADDIR, PREF_FILEWRITEDIR, PREF_GEOMETRY_BY_REF, PREF_HISTORY, PREF_IMAGE_BY_REF, PREF_LARGE_REMOTE_DATA_WARN, PREF_LASTVERSION, PREF_LATLON_FORMAT, PREF_LEGEND_SHOWICONS, PREF_LOCALE, PREF_LOOKANDFEEL, PREF_MAX_PERMGENSIZE, PREF_MAXIMAGESIZE, PREF_MEMORY, PREF_NPOT_IMAGE, PREF_OPEN_ASK, PREF_OPEN_MERGE, PREF_OPEN_REMOVE, PREF_PROJ_LIST, PREF_SAMPLINGMODE, PREF_SHOWCONTROLWINDOW, PREF_SHOWDASHBOARD, PREF_SHOWDECODEDIALOG, PREF_SHOWHIDDENFILES, PREF_SHOWQUITCONFIRM, PREF_SITEPATH, PREF_THREADS_DATA, PREF_THREADS_RENDER, PREF_TIMEZONE, PREF_VERTICALCS, PREF_VERTICALUNIT, PREF_WINDOW_SHOWTOOLBAR, PREF_ZIDV_ASK, PREF_ZIDV_DIRECTORY, PREF_ZIDV_SAVETOTMP, PROP_3DMODE, PROP_ABOUTTEXT, PROP_APPRESOURCEPATH, PROP_CHOOSERS, PROP_CHOOSERS_ALL, PROP_CONTROLDESCRIPTORS, PROP_CONTROLDESCRIPTORS_ALL, PROP_DATAHOLDERBOUNDS, PROP_DEFAULTLOCATIONS, PROP_DISPLAYLIST_GROUP, PROP_FIXFILELOCKUP, PROP_JNLPCODEBASE, PROP_JNLPTEMPLATE, PROP_JNLPTITLE, PROP_LOADINGXML, PROP_MAP_GLOBE_LEVEL, PROP_MAP_MAP_LEVEL, PROP_MINIMUMFRAMECYCLETIME, PROP_MONITORPORT, PROP_OLDCONTROLDESCRIPTORS, PROP_ONEINSTANCEPORT, PROP_PREFERENCES, PROP_PROJ_NAME, PROP_RESOURCEFILES, PROP_SHOWCLOCK, PROP_SHOWDASHBOARD, PROP_SHOWDATATREE, PROP_SHOWFORMULAS, PROP_SHOWSPLASH, PROP_SPLASHICON, PROP_UI_DESKTOP, PROP_USE_TIMEDRIVER, PROP_VERSIONFILE, PROP_WINDOW_SCREENSIZEOFFSET, PROP_WINDOW_SIZEHEIGHT, PROP_WINDOW_SIZEWIDTH, PROP_WINDOW_USESCREENSIZE, SUFFIX_BAT, SUFFIX_CPT, SUFFIX_ISL, SUFFIX_JNLP, SUFFIX_RBI, SUFFIX_SH, SUFFIX_XIDV, SUFFIX_XML, SUFFIX_ZIDV

Constructor Summary

IdvBase(String[] args)
Create the IdvBase

Method Summary

static void	addPluginClass(Class c) Add a class that was loaded in via the plugin mechanism.
Element	createElement(XmlEncoder encoder) Implement the XmlPersistable createElement method, just return null since we don't really want to be persisted.
protected AliasEditor	doMakeAliasEditor() Factory method to create the AliasEditor
protected ArgsManager	doMakeArgsManager(String[] args) Factory method to create the ArgsManager
protected AutoDisplayEditor	doMakeAutoDisplayEditor() Factory method to create the AutoDisplayEditor
protected CollabManager	doMakeCollabManager() Factory method to create the CollabManager
protected ColorTableEditor	doMakeColorTableEditor() Factory method to create the ColorTableEditor
protected ColorTableManager	doMakeColorTableManager() Factory method to create the ColorTableManager
protected DataManager	doMakeDataManager() Factory method to create the DataManager
protected DisplayConventions	doMakeDisplayConventions() Factory method to create the DisplayConventions
protected IdvChooserManager	doMakeIdvChooserManager() Factory method to create the IdvChooserManager
protected IdvProjectionManager	doMakeIdvProjectionManager() Factory method to create the ProjectionManager
protected IdvUIManager	doMakeIdvUIManager() Factory method to create the IdvUIManager
protected ImageGenerator	doMakeImageGenerator() Factory method to create the ImageGenerator
protected InstallManager	doMakeInstallManager() Factory method to create the InstallManager.
protected JythonManager	doMakeJythonManager() Factory method to create the JythonManager
protected ParamDefaultsEditor	doMakeParamDefaultsEditor() Factory method to create the ParamDefaultsEditor
protected ParamGroupsEditor	doMakeParamGroupsEditor() Factory method to create the ParamGroupsEditor
protected IdvPersistenceManager	doMakePersistenceManager() Factory method to create the IdvPersistenceManager
protected PluginManager	doMakePluginManager() Factory method to create the PluginManager
protected IdvPreferenceManager	doMakePreferenceManager() Factory method to create the IdvPreferenceManager
protected PublishManager	doMakePublishManager() Factory method to create the PublishManager This manages publishing content to weblogs, etc.
protected IdvResourceManager	doMakeResourceManager() Factory method to create the IdvResourceManager
protected ResourceViewer	doMakeResourceViewer() _more_
protected StateManager	doMakeStateManager() Factory method to create the StateManager.
protected StationModelManager	doMakeStationModelManager() Factory method to create the StationModelManager
protected ucar.unidata.idv.test.TestManager	doMakeTestManager() Factory method to create the TestManager.
protected VMManager	doMakeVMManager() Factory method to create the VMManager.
AliasEditor	getAliasEditor() Create, if needed, and return the AliasEditor
ArgsManager	getArgsManager() Create, if needed, and return the ArgsManager
AutoDisplayEditor	getAutoDisplayEditor() Create, if needed, and return the AutoDisplayEditor
CollabManager	getCollabManager() Create, if needed, and return the CollabManager
Color	getColorProperty(String name, Color dflt) Utility method to retrieve a String property from the idv properties.
ColorTableEditor	getColorTableEditor() Create, if needed, and return the ColorTableEditor
ColorTableManager	getColorTableManager() Create, if needed, and return the ColorTableManager
DataManager	getDataManager() Create, if needed, and return the DataManager.
DisplayConventions	getDisplayConventions() Create, if needed, and return the DisplayConventions.
protected XmlEncoder	getEncoder()
IntegratedDataViewer	getIdv() Get the IDV
IdvChooserManager	getIdvChooserManager() Create, if needed, and return the IdvChooserManager
IdvProjectionManager	getIdvProjectionManager() Create, if needed, and return the ProjectionManager
IdvUIManager	getIdvUIManager() Create, if needed, and return the IdvUIManager
ImageGenerator	getImageGenerator() Create, if needed, and return the ImageGenerator
InstallManager	getInstallManager() Create, if needed, and return the InstallManager
JythonManager	getJythonManager() Create, if needed, and return the JythonManager
XmlObjectStore	getObjectStore() This simply returns the call to getStore.
ParamDefaultsEditor	getParamDefaultsEditor() Create, if needed, and return the ParamDefaultsEditor
ParamGroupsEditor	getParamGroupsEditor() Create, if needed, and return the ParamGroupsEditor
IdvPersistenceManager	getPersistenceManager() Get the persistence manager
PluginManager	getPluginManager() Create, if needed, and return the IdvResourceManager
Object	getPreference(String pref) Helper method that wraps getStore().get (pref)
Object	getPreference(String pref, Object dflt) Helper method that wraps getStore().get (pref)
IdvPreferenceManager	getPreferenceManager() Create, if needed, and return the IdvPreferenceManager
boolean	getProperty(String name, boolean dflt) Utility method to retrieve a boolean property from the idv properties.
double	getProperty(String name, double dflt) Utility method to retrieve an int property from the idv properties.
int	getProperty(String name, int dflt) Utility method to retrieve an int property from the idv properties.
String	getProperty(String name, String dflt) Utility method to retrieve a String property from the idv properties.
PublishManager	getPublishManager() Create, if needed, and return PublishManager
IdvResourceManager	getResourceManager() Create, if needed, and return the IdvResourceManager
ResourceViewer	getResourceViewer() Create, if needed, and return the AliasEditor
StateManager	getStateManager() Create, if needed, and return the StateManager
StationModelManager	getStationModelManager() Create, if needed, and return the StationModelManager
IdvObjectStore	getStore() Create the IdvObjectStore (if null) and return it.
ucar.unidata.idv.test.TestManager	getTestManager() Create, if needed, and return the TestManager.
VMManager	getVMManager() Create, if needed, and return the VMManager.
boolean	haveCollabManager() Do we have a non-null collab manager
boolean	initFromXml(XmlEncoder encoder, Element element) Just needed so we can implement XmlPersistable
protected Object	makeManager(Class managerClass, Object[] args) Utility to make a manager class.
protected void	setIdv(IntegratedDataViewer idv) Set the reference to the idv.
void	showAliasEditor() Show the alias editor
void	showAutoDisplayEditor() Show the alias editor
void	showChooser() Call show on the IdvChooserManager
void	showChooserModal() Call show on the IdvChooserManager
void	showColorTableEditor() Show the color table editor
void	showColorTableEditor(String colorTableName) Show the color table editor with the color table with the given name (if non-null)
void	showDefaultsEditor() Show the param defaults editor
void	showIdvProjectionManager() Show the alias editor
void	showParamGroupsEditor() Show the param defaults editor
void	showPreferenceManager() Create (if null) and popup the user preference dialog window.
void	showResourceViewer() Show the alias editor
void	showStationModelEditor() Show the station model editor

Methods inherited from class java.lang.Object

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

Field Detail

idv

protected IntegratedDataViewer idv

The idv. This is really a pointer to this

args

protected String[] args

Command line arguments

resourceManager

protected IdvResourceManager resourceManager

The resource manager

pluginManager

protected PluginManager pluginManager

The plugin manager

vmManager

protected VMManager vmManager

The manager of ViewManagers

publishManager

protected PublishManager publishManager

Handles doing publishing of content

persistenceManager

protected IdvPersistenceManager persistenceManager

Handles bundle writing

displayConventions

protected DisplayConventions displayConventions

Handles the different display conventions

argsManager

protected ArgsManager argsManager

The command line argument manager

colorTableEditor

protected ColorTableEditor colorTableEditor

The color table editor.

colorTableManager

protected ColorTableManager colorTableManager

The color table manager.

stationModelManager

protected StationModelManager stationModelManager

The station model manager

aliasEditor

protected AliasEditor aliasEditor

The data alias editor

resourceViewer

protected ResourceViewer resourceViewer

_more_

projectionManager

protected IdvProjectionManager projectionManager

The porojection manager

autoDisplayEditor

protected AutoDisplayEditor autoDisplayEditor

The data alias editor

jythonManager

protected JythonManager jythonManager

The jython manager

paramDefaultsEditor

protected ParamDefaultsEditor paramDefaultsEditor

The parameter defaults editor

paramGroupsEditor

protected ParamGroupsEditor paramGroupsEditor

The parameter defaults editor

chooserManager

protected IdvChooserManager chooserManager

The chooser manager

dataManager

protected DataManager dataManager

The data manager

collabManager

protected CollabManager collabManager

Handles collaboration and the event capture

preferenceManager

protected IdvPreferenceManager preferenceManager

Handles the end user preferences

testManager

protected ucar.unidata.idv.test.TestManager testManager

Handles running tests, creating test archives, etc.

uiManager

protected IdvUIManager uiManager

Handles creating user interfaces, etc.

imageGenerator

protected ImageGenerator imageGenerator

Handles generating images, movies, etc.

stateManager

protected StateManager stateManager

Handles properties, etc.

installManager

protected InstallManager installManager

Handles reinstalling the IDV

Constructor Detail

IdvBase

public IdvBase(String[] args)

Create the IdvBase

Parameters:

args - Command line arguments

Method Detail

setIdv

protected void setIdv(IntegratedDataViewer idv)

Set the reference to the idv. This is really a reference to this IdvBase object, but the idv is used to pass in to the different managers and editors.

Parameters:

idv - The IDV

getIdv

public IntegratedDataViewer getIdv()

Get the IDV

Returns:

The idv

addPluginClass

public static void addPluginClass(Class c)

Add a class that was loaded in via the plugin mechanism. We check these classes when we are creating a manager

Parameters:

c - The class

makeManager

protected Object makeManager(Class managerClass,
                             Object[] args)

Utility to make a manager class. This first sees if there is a sub-class of the given managerClass in th list of plugin classes If there is it will use that class. If args is null this method jsut does a newInstance If args is non-null we'll look for the right constructor

Parameters:

managerClass - Class to instantiate

args - Args to pass in. May be null.

Returns:

Instantiated object

doMakeStationModelManager

protected StationModelManager doMakeStationModelManager()

Factory method to create the StationModelManager

Returns:

The station model manager

getStationModelManager

public StationModelManager getStationModelManager()

Create, if needed, and return the StationModelManager

Returns:

The station model manager

showStationModelEditor

public void showStationModelEditor()

Show the station model editor

doMakeArgsManager

protected ArgsManager doMakeArgsManager(String[] args)

Factory method to create the ArgsManager

Parameters:

args - The command lint arguments

Returns:

The command line argument manager

getPersistenceManager

public IdvPersistenceManager getPersistenceManager()

Get the persistence manager

Returns:

The persistence manager

doMakePersistenceManager

protected IdvPersistenceManager doMakePersistenceManager()

Factory method to create the IdvPersistenceManager

Returns:

The IdvPersistenceManager

getArgsManager

public ArgsManager getArgsManager()

Create, if needed, and return the ArgsManager

Returns:

The command line argument manager

doMakeDataManager

protected DataManager doMakeDataManager()

Factory method to create the DataManager

Returns:

The data manager

getDataManager

public DataManager getDataManager()

Create, if needed, and return the DataManager. This manages the creation and manipulation of the data sources.

Returns:

The data manager

doMakeDisplayConventions

protected DisplayConventions doMakeDisplayConventions()

Factory method to create the DisplayConventions

Returns:

The display conventions

getDisplayConventions

public DisplayConventions getDisplayConventions()

Create, if needed, and return the DisplayConventions. This manages the creation and manipulation of the data sources.

Returns:

The data manager

doMakeColorTableManager

protected ColorTableManager doMakeColorTableManager()

Factory method to create the ColorTableManager

Returns:

The color table manager

getColorTableManager

public ColorTableManager getColorTableManager()

Create, if needed, and return the ColorTableManager

Returns:

The color table manager

doMakeTestManager

protected ucar.unidata.idv.test.TestManager doMakeTestManager()

Factory method to create the TestManager.

Returns:

The test manager

getTestManager

public ucar.unidata.idv.test.TestManager getTestManager()

Create, if needed, and return the TestManager. This class runs the idv in test mode and also creates the test archives.

Returns:

The test manager

doMakeVMManager

protected VMManager doMakeVMManager()

Factory method to create the VMManager. This manages the set of ViewManagers. It really should be called the ViewManagerManager

Returns:

The ViewManager manager

getVMManager

public VMManager getVMManager()

Create, if needed, and return the VMManager.

Returns:

The ViewManager manager

doMakePublishManager

protected PublishManager doMakePublishManager()

Factory method to create the PublishManager This manages publishing content to weblogs, etc.

Returns:

The Publish manager

getPublishManager

public PublishManager getPublishManager()

Create, if needed, and return PublishManager

Returns:

The publish manager

doMakeIdvUIManager

protected IdvUIManager doMakeIdvUIManager()

Factory method to create the IdvUIManager

Returns:

The UI manager

getIdvUIManager

public IdvUIManager getIdvUIManager()

Create, if needed, and return the IdvUIManager

Returns:

The UI manager

doMakeImageGenerator

protected ImageGenerator doMakeImageGenerator()

Factory method to create the ImageGenerator

Returns:

The image generator

getImageGenerator

public ImageGenerator getImageGenerator()

Create, if needed, and return the ImageGenerator

Returns:

The ImageGenerator

doMakeStateManager

protected StateManager doMakeStateManager()

Factory method to create the StateManager.

Returns:

The state manager

getStateManager

public StateManager getStateManager()

Create, if needed, and return the StateManager

Returns:

The state manager

doMakeInstallManager

protected InstallManager doMakeInstallManager()

Factory method to create the InstallManager.

Returns:

The install manager

getInstallManager

public InstallManager getInstallManager()

Create, if needed, and return the InstallManager

Returns:

The install manager

doMakeJythonManager

protected JythonManager doMakeJythonManager()

Factory method to create the JythonManager

Returns:

The jython manager

getJythonManager

public JythonManager getJythonManager()

Create, if needed, and return the JythonManager

Returns:

The jython manager

doMakeIdvChooserManager

protected IdvChooserManager doMakeIdvChooserManager()

Factory method to create the IdvChooserManager

Returns:

The Chooser manager

getIdvChooserManager

public IdvChooserManager getIdvChooserManager()

Create, if needed, and return the IdvChooserManager

Returns:

The Chooser manager

showChooser

public void showChooser()

Call show on the IdvChooserManager

showChooserModal

public void showChooserModal()

Call show on the IdvChooserManager

doMakeCollabManager

protected CollabManager doMakeCollabManager()

Factory method to create the CollabManager

Returns:

The collaboration manager

getCollabManager

public CollabManager getCollabManager()

Create, if needed, and return the CollabManager

Returns:

The collaboration manager

haveCollabManager

public boolean haveCollabManager()

Do we have a non-null collab manager

Returns:

Have a collab manager

doMakeAliasEditor

protected AliasEditor doMakeAliasEditor()

Factory method to create the AliasEditor

Returns:

The alias editor

getAliasEditor

public AliasEditor getAliasEditor()

Create, if needed, and return the AliasEditor

Returns:

The alias editor

showAliasEditor

public void showAliasEditor()

Show the alias editor

doMakeResourceViewer

protected ResourceViewer doMakeResourceViewer()

_more_

Returns:

_more_

getResourceViewer

public ResourceViewer getResourceViewer()

Create, if needed, and return the AliasEditor

Returns:

The alias editor

showResourceViewer

public void showResourceViewer()

Show the alias editor

doMakeIdvProjectionManager

protected IdvProjectionManager doMakeIdvProjectionManager()

Factory method to create the ProjectionManager

Returns:

The alias editor

getIdvProjectionManager

public IdvProjectionManager getIdvProjectionManager()

Create, if needed, and return the ProjectionManager

Returns:

The projection manager

showIdvProjectionManager

public void showIdvProjectionManager()

Show the alias editor

doMakeAutoDisplayEditor

protected AutoDisplayEditor doMakeAutoDisplayEditor()

Factory method to create the AutoDisplayEditor

Returns:

The auto display editor

getAutoDisplayEditor

public AutoDisplayEditor getAutoDisplayEditor()

Create, if needed, and return the AutoDisplayEditor

Returns:

The auto display editor

showAutoDisplayEditor

public void showAutoDisplayEditor()

Show the alias editor

doMakeParamDefaultsEditor

protected ParamDefaultsEditor doMakeParamDefaultsEditor()

Factory method to create the ParamDefaultsEditor

Returns:

The parameter defaults editor

getParamDefaultsEditor

public ParamDefaultsEditor getParamDefaultsEditor()

Create, if needed, and return the ParamDefaultsEditor

Returns:

The parameter defaults editor

showDefaultsEditor

public void showDefaultsEditor()

Show the param defaults editor

doMakeParamGroupsEditor

protected ParamGroupsEditor doMakeParamGroupsEditor()

Factory method to create the ParamGroupsEditor

Returns:

The parameter Groups editor

getParamGroupsEditor

public ParamGroupsEditor getParamGroupsEditor()

Create, if needed, and return the ParamGroupsEditor

Returns:

The parameter Groups editor

showParamGroupsEditor

public void showParamGroupsEditor()

Show the param defaults editor

doMakeColorTableEditor

protected ColorTableEditor doMakeColorTableEditor()

Factory method to create the ColorTableEditor

Returns:

The color table editor

getColorTableEditor

public ColorTableEditor getColorTableEditor()

Create, if needed, and return the ColorTableEditor

Returns:

The color table editor

showColorTableEditor

public void showColorTableEditor()

Show the color table editor

showColorTableEditor

public void showColorTableEditor(String colorTableName)

Show the color table editor with the color table with the given name (if non-null)

Parameters:

colorTableName - The name of the color table to show

doMakePreferenceManager

protected IdvPreferenceManager doMakePreferenceManager()

Factory method to create the IdvPreferenceManager

Returns:

The preference manager

getPreferenceManager

public IdvPreferenceManager getPreferenceManager()

Create, if needed, and return the IdvPreferenceManager

Returns:

The preference manager

showPreferenceManager

public void showPreferenceManager()

Create (if null) and popup the user preference dialog window.

doMakeResourceManager

protected IdvResourceManager doMakeResourceManager()

Factory method to create the IdvResourceManager

Returns:

The resource manager

getResourceManager

public IdvResourceManager getResourceManager()

Create, if needed, and return the IdvResourceManager

Returns:

The resource manager

doMakePluginManager

protected PluginManager doMakePluginManager()

Factory method to create the PluginManager

Returns:

The plugin manager

getPluginManager

public PluginManager getPluginManager()

Create, if needed, and return the IdvResourceManager

Returns:

The resource manager

getObjectStore

public XmlObjectStore getObjectStore()

This simply returns the call to getStore. We have this here because getStore returns an IdvObjectStore, not an XmlObjectStore which is called for in the inteface.

Returns:

The XmlObjectStore

getStore

public IdvObjectStore getStore()

Create the IdvObjectStore (if null) and return it.

Returns:

The XmlObjectStore

getProperty

public boolean getProperty(String name,
                           boolean dflt)

Utility method to retrieve a boolean property from the idv properties. If the property does not exists return the given default value.

Parameters:

name - The name of the property

dflt - The default value if the property is not found

Returns:

The given property or the dflt value

getProperty

public int getProperty(String name,
                       int dflt)

Utility method to retrieve an int property from the idv properties. If the property does not exists return the given default value.

Parameters:

name - The name of the property

dflt - The default value if the property is not found

Returns:

The given property or the dflt value

getProperty

public double getProperty(String name,
                          double dflt)

Utility method to retrieve an int property from the idv properties. If the property does not exists return the given default value.

Parameters:

name - The name of the property

dflt - The default value if the property is not found

Returns:

The given property or the dflt value

getProperty

public String getProperty(String name,
                          String dflt)

Utility method to retrieve a String property from the idv properties. If the property does not exists return the given default value.

Parameters:

name - The name of the property

dflt - The default value if the property is not found

Returns:

The given property or the dflt value

getColorProperty

public Color getColorProperty(String name,
                              Color dflt)

Utility method to retrieve a String property from the idv properties. If the property does not exists return the given default value.

Parameters:

name - The name of the property

dflt - The default value if the property is not found

Returns:

The given property or the dflt value

getPreference

public Object getPreference(String pref)

Helper method that wraps getStore().get (pref)

Parameters:

pref - The name of the preference

Returns:

The value of the preference, or null if not found

getPreference

public Object getPreference(String pref,
                            Object dflt)

Helper method that wraps getStore().get (pref)

Parameters:

pref - The name of the preference

dflt - The default value to return if the preference is not found

Returns:

The preference value or the dflt

createElement

public Element createElement(XmlEncoder encoder)

Implement the XmlPersistable createElement method, just return null since we don't really want to be persisted.

Specified by:

createElement in interface XmlPersistable

Parameters:

encoder - The encoder doing the encoding

Returns:

null, because we don't want this object to actually be encoded

getEncoder

protected XmlEncoder getEncoder()

initFromXml

public boolean initFromXml(XmlEncoder encoder,
                           Element element)

Just needed so we can implement XmlPersistable

Specified by:

initFromXml in interface XmlPersistable

Parameters:

encoder - The encoder doing the encoding

element - The xml element that defines the object

Returns:

Was this intialization successful