ucar.unidata.idv.ui
Class ParamDefaultsEditor

java.lang.Object
  ucar.unidata.ui.WindowHolder
      ucar.unidata.idv.IdvManager
          ucar.unidata.idv.ui.ParamDefaultsEditor

All Implemented Interfaces:

ActionListener, EventListener, IdvConstants

public class ParamDefaultsEditor
extends IdvManager
implements ActionListener

This class provides 2 facilities. First, there is a set of static methods: init (XmlResourceCollection resources); Range getParamRange (String paramName); getParamColorTable (String paramName); that provide basic lookup of parameter defaults. The init method is called once. It is passed an XmlResourceCollection that holds the list of xml files to be used. The first resource in the list is taken to be the user's "writable" resource. These resources are read in, first to last, and a static collection of ParamInfo-s are is created that is used to do the subsequent param default lookups. This class is also used to provide an end-user editing facility.

Version:

$Revision: 1.78 $Date: 2007/06/22 13:03:56 $

Author:

IDV development team

Nested Class Summary

class

ParamDefaultsEditor.ParamDefaultsTable A JTable that holds a list of ParamInfo objects and provides display and editing capabilities

Field Summary

static String	ATTR_CI_BASE The contour info base xml attribute name
static String	ATTR_CI_DASH The contour info dash xml attribute name
static String	ATTR_CI_INTERVAL The contour info interval xml attribute name
static String	ATTR_CI_LABEL The contour info label xml attribute name
static String	ATTR_CI_MAX The contour info max xml attribute name
static String	ATTR_CI_MIN The contour info min xml attribute name
static String	ATTR_CI_WIDTH The contour info label xml attribute name
static String	ATTR_COLORTABLE The colortable xml attribute name
static String	ATTR_NAME The name xml attribute name
static String	ATTR_RANGE_MAX The range max xml attribute name
static String	ATTR_RANGE_MIN The range min xml attribute name
static String	ATTR_UNIT The unit xml attribute name
static boolean	DFLT_CI_DASH The contour info default dash value
static boolean	DFLT_CI_LABEL The contour info default label value
static int	DFLT_CI_WIDTH The contour info default width value
static String	TAG_PARAM The param xml tag name
static String	TAG_PARAMS The params xml tag name

Fields inherited from class ucar.unidata.ui.WindowHolder

contents, dialog, frame, window

Fields inherited from interface ucar.unidata.idv.IdvConstants

ARG_B64BUNDLE, 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_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_TIMEZONE, FILE_VMSTATE, 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_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_HISTORY, PREF_LASTVERSION, PREF_LATLON_FORMAT, PREF_LOCALE, PREF_LOOKANDFEEL, PREF_MAXIMAGESIZE, 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_TIMEZONE, PREF_VERTICALCS, PREF_VERTICALUNIT, 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_JNLPCODEBASE, PROP_JNLPTEMPLATE, PROP_JNLPTITLE, PROP_LOADINGXML, PROP_OLDCONTROLDESCRIPTORS, PROP_ONEINSTANCEPORT, PROP_PREFERENCES, PROP_PROJ_NAME, PROP_RESOURCEFILES, PROP_SHOWDASHBOARD, PROP_SHOWDATATREE, PROP_SHOWFORMULAS, PROP_SHOWSPLASH, PROP_SPLASHICON, PROP_UI_DESKTOP, 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

ParamDefaultsEditor(IntegratedDataViewer idv)
Create the editor with the given collection of xml resources

Method Summary

void	actionPerformed(ActionEvent event) Handle the CLOSEANCEL, OK, HELP, events.
void	addNewRow() add a new row to users table
protected void	copyToUsers(ParamInfo i) Copy the given ParamInfo object into the user's editable table
void	doClose() Close the window (and the color table editor if it is open)
void	doImport() Import an xml param defaults file
void	doOpen() Open an xml param defaults file
void	doSave(List infoList, String filename) Save the list of ParamInfo-s into the given file
void	doSaveAs() Save the param infos
void	doSaveAs(List infoList) Prompt for a file and write out the ParamInfo-s from the given list.
void	exportSelectedToPlugin() Export the selected param infos to the plugin manager
void	exportToPlugin() Export allthe param infos to the plugin manager
ParamDefaultsEditor.ParamDefaultsTable	getCurrentTable() Return the ParamDefaultsTable which is currently being shown in the tabbed pane
ColorTable	getParamColorTable(String paramName) Returns a color table based on the parameter name (e.g., rh, t, etc.)
ContourInfo	getParamContourInfo(String paramName) Returns a ContourInfo based on the parameter name (e.g., rh, t, etc.)
Unit	getParamDisplayUnit(String paramName) Returns a Unit based on the parameter name (e.g., rh, t, etc.)
List	getParamInfos(boolean justFirst) Get the param infos
Range	getParamRange(String paramName) Returns a Range based on the parameter name (e.g., rh, t, etc.)
protected String	getWindowTitle() Get the window title to use
void	loadResources(XmlResourceCollection resources) Load in the xml resources
void	saveDefaults(DisplayControlImpl displayControl) Get the color table, range, etc, from the given display control and save them as the param defaults for its data choice
void	showHelp() show help

Methods inherited from class ucar.unidata.idv.IdvManager

getArgsManager, getCollabManager, getColorTableManager, getDataManager, getIdv, getIdvChooserManager, getIdvClass, getIdvProjectionManager, getIdvUIManager, getImageGenerator, getJythonManager, getPersistenceManager, getPreferenceManager, getProperty, getProperty, getProperty, getPublishManager, getResourceManager, getStateManager, getStationModelManager, getStore, getVMManager, logException, showNormalCursor, showWaitCursor, waitUntilDisplaysAreDone

Methods inherited from class ucar.unidata.ui.WindowHolder

close, doMakeContents, getContents, getDialog, getFrame, getWindow, isShowing, removeAll, setWindowTitle, shouldMakeDialog, show, show, showModal, toFront, windowIsClosing

Methods inherited from class java.lang.Object

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

Field Detail

TAG_PARAM

public static final String TAG_PARAM

The param xml tag name

See Also:

Constant Field Values

TAG_PARAMS

public static final String TAG_PARAMS

The params xml tag name

See Also:

Constant Field Values

ATTR_UNIT

public static final String ATTR_UNIT

The unit xml attribute name

See Also:

Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

The name xml attribute name

See Also:

Constant Field Values

ATTR_COLORTABLE

public static final String ATTR_COLORTABLE

The colortable xml attribute name

See Also:

Constant Field Values

ATTR_RANGE_MIN

public static final String ATTR_RANGE_MIN

The range min xml attribute name

See Also:

Constant Field Values

ATTR_RANGE_MAX

public static final String ATTR_RANGE_MAX

The range max xml attribute name

See Also:

Constant Field Values

ATTR_CI_INTERVAL

public static final String ATTR_CI_INTERVAL

The contour info interval xml attribute name

See Also:

Constant Field Values

ATTR_CI_BASE

public static final String ATTR_CI_BASE

The contour info base xml attribute name

See Also:

Constant Field Values

ATTR_CI_MIN

public static final String ATTR_CI_MIN

The contour info min xml attribute name

See Also:

Constant Field Values

ATTR_CI_MAX

public static final String ATTR_CI_MAX

The contour info max xml attribute name

See Also:

Constant Field Values

ATTR_CI_DASH

public static final String ATTR_CI_DASH

The contour info dash xml attribute name

See Also:

Constant Field Values

ATTR_CI_LABEL

public static final String ATTR_CI_LABEL

The contour info label xml attribute name

See Also:

Constant Field Values

ATTR_CI_WIDTH

public static final String ATTR_CI_WIDTH

The contour info label xml attribute name

See Also:

Constant Field Values

DFLT_CI_DASH

public static final boolean DFLT_CI_DASH

The contour info default dash value

See Also:

Constant Field Values

DFLT_CI_LABEL

public static final boolean DFLT_CI_LABEL

The contour info default label value

See Also:

Constant Field Values

DFLT_CI_WIDTH

public static final int DFLT_CI_WIDTH

The contour info default width value

See Also:

Constant Field Values

Constructor Detail

ParamDefaultsEditor

public ParamDefaultsEditor(IntegratedDataViewer idv)

Create the editor with the given collection of xml resources

Parameters:

idv - The IDV

Method Detail

exportSelectedToPlugin

public void exportSelectedToPlugin()

Export the selected param infos to the plugin manager

exportToPlugin

public void exportToPlugin()

Export allthe param infos to the plugin manager

addNewRow

public void addNewRow()

add a new row to users table

getParamInfos

public List getParamInfos(boolean justFirst)

Get the param infos

Parameters:

justFirst - if true then just get the first table

Returns:

param infos

loadResources

public void loadResources(XmlResourceCollection resources)

Load in the xml resources

Parameters:

resources - The resources

getCurrentTable

public ParamDefaultsEditor.ParamDefaultsTable getCurrentTable()

Return the ParamDefaultsTable which is currently being shown in the tabbed pane

Returns:

The current ParamDefaultsTable

doImport

public void doImport()

Import an xml param defaults file

doOpen

public void doOpen()

Open an xml param defaults file

actionPerformed

public void actionPerformed(ActionEvent event)

Handle the CLOSEANCEL, OK, HELP, events.

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class WindowHolder

Parameters:

event - The event

showHelp

public void showHelp()

show help

doClose

public void doClose()

Close the window (and the color table editor if it is open)

getWindowTitle

protected String getWindowTitle()

Get the window title to use

Overrides:

getWindowTitle in class WindowHolder

Returns:

Window title

doSave

public void doSave(List infoList,
                   String filename)

Save the list of ParamInfo-s into the given file

Parameters:

infoList - List of infos

filename - The filename to write to

doSaveAs

public void doSaveAs()

Save the param infos

doSaveAs

public void doSaveAs(List infoList)

Prompt for a file and write out the ParamInfo-s from the given list.

Parameters:

infoList - List of ParamInfo-s

copyToUsers

protected void copyToUsers(ParamInfo i)

Copy the given ParamInfo object into the user's editable table

Parameters:

i - the param fino object to copy

saveDefaults

public void saveDefaults(DisplayControlImpl displayControl)

Get the color table, range, etc, from the given display control and save them as the param defaults for its data choice

Parameters:

displayControl - the display control to get state from

getParamRange

public Range getParamRange(String paramName)

Returns a Range based on the parameter name (e.g., rh, t, etc.)

Parameters:

paramName - Name to look for

Returns:

The Range found or null

getParamContourInfo

public ContourInfo getParamContourInfo(String paramName)

Returns a ContourInfo based on the parameter name (e.g., rh, t, etc.)

Parameters:

paramName - Name to look for

Returns:

The ContourInfo found or null

getParamDisplayUnit

public Unit getParamDisplayUnit(String paramName)

Returns a Unit based on the parameter name (e.g., rh, t, etc.)

Parameters:

paramName - Name to look for

Returns:

The Unit found or null

getParamColorTable

public ColorTable getParamColorTable(String paramName)

Returns a color table based on the parameter name (e.g., rh, t, etc.)

Parameters:

paramName - Name to look for

Returns:

The ColorTable found or null