ucar.unidata.idv.control
Class TextProductControl

java.lang.Object
  ucar.unidata.collab.SharableImpl
      ucar.unidata.idv.control.DisplayControlBase
          ucar.unidata.idv.control.DisplayControlImpl
              ucar.unidata.idv.control.ObsDisplayControl
                  ucar.unidata.idv.control.StationModelControl
                      ucar.unidata.idv.control.StationLocationControl
                          ucar.unidata.idv.control.TextProductControl

All Implemented Interfaces:

ActionListener, ItemListener, PropertyChangeListener, EventListener, HyperlinkListener, Sharable, DataChangeListener, DisplayControl, Prototypable, ControlListener, DisplayListener

public class TextProductControl
extends StationLocationControl
implements HyperlinkListener

Class to display weather text

Version:

$Revision: 1.3 $ $Date: 2006/12/01 20:16:39 $

Author:

IDV Development Team

Nested Class Summary

Nested classes/interfaces inherited from class ucar.unidata.idv.control.ObsDisplayControl

ObsDisplayControl.RealWrapper

Nested classes/interfaces inherited from class ucar.unidata.idv.control.DisplayControlImpl

DisplayControlImpl.SideLegendLabel

Field Summary

static String	HTML_TYPE type for html
static String	TEXT_TYPE type for text

Fields inherited from class ucar.unidata.idv.control.StationModelControl

currentStationData, densityComps, filters, lastDeclutteredData, layoutModelWidget, lockIcon, stationsLocked, timeDeclutterComps, unlockIcon, zPositionPanel

Fields inherited from class ucar.unidata.idv.control.ObsDisplayControl

colNames, colString, FIELD_ALL, format, LABEL_ALT, LABEL_LAT, LABEL_LON, LABEL_TIME

Fields inherited from class ucar.unidata.idv.control.DisplayControlImpl

categories, colorScaleInfo, colorScales, contourInfo, contourInfoParams, contourWidget, controlContext, ctw, dataSelection, defaultView, defaultViewManager, DISPLAY_LIST_NAME, displayListTable, displayListUsesColor, displayMasters, displayUnit, helpUrl, initNoteText, instantiatedWithNoData, noteTextArea, noteWrapper, paramName, requestProperties, selectRangeWidget, settingVisibility, sharables, showNoteText, skipSlider, version, viewManagers, ZFUDGE

Fields inherited from class ucar.unidata.idv.control.DisplayControlBase

CMD_BARBSIZE, CMD_COLORS, CMD_COLORTABLE, CMD_INTERVAL, CMD_LEVEL, CMD_LINEWIDTH, CMD_POPUP, CMD_REMOVE, DEFAULT_POINT_SIZE, DEFAULT_SAMPLING_MODE, FIND_ALL, FIND_CATEGORY, FIND_CLASS, FIND_SPECIAL, FIND_THIS, FIND_WITHDATA, FIND_WITHTHISDATA, FIND_WITHTHISFIELD, FIND_WITHTHISVIEW, FLAG_COLOR, FLAG_COLORTABLE, FLAG_COLORUNIT, FLAG_CONTOUR, FLAG_DATACONTROL, FLAG_DISPLAYUNIT, FLAG_LINEWIDTH, FLAG_NONE, FLAG_SELECTRANGE, FLAG_SKIPFACTOR, FLAG_SMOOTHING, FLAG_TEXTUREQUALITY, FLAG_TIMERANGE, FLAG_ZPOSITION, GRID_INSETS, ICON_LOCK, ICON_REMOVE, ICON_UNLOCK, LABEL_NONE, log_, MACRO_DATASOURCENAME, MACRO_DISPLAYNAME, MACRO_DISPLAYUNIT, MACRO_FHOUR, MACRO_LONGNAME, MACRO_POSITION, MACRO_SHORTNAME, MACRO_STATION, MACRO_TIMESTAMP, MACRO_VALUE, NEAREST_NEIGHBOR, PREF_DISPLAYLIST_TEMPLATE, PREF_EXTRALABEL_TEMPLATE, PREF_LEGENDLABEL_TEMPLATE, PROP_REMOVED, SETTINGS_GROUP_DISPLAY, SETTINGS_GROUP_FLAGS, SHARE_CHOICES, SHARE_COLOR, SHARE_COLORSCALE, SHARE_COLORTABLE, SHARE_DISPLAYUNIT, SHARE_POSITION, SHARE_SELECTRANGE, SHARE_SKIPVALUE, SHARE_TRANSECT, SHARE_VISIBILITY, WEIGHTED_AVERAGE

Fields inherited from interface ucar.unidata.idv.DisplayControl

BOTTOM_LEGEND, DEFAULT_PROBEFORMAT, PREF_PREFIX, PREF_PROBEFORMAT, PREF_REMOVEONWINDOWCLOSE, PREF_SAMPLING_MODE, PREF_STANDALONE_REMOVEONCLOSE, PREF_STANDALONE_REMOVEONCLOSE_ASK, PROP_LEGENDICON, RASTERMODE_SHOWALL, RASTERMODE_SHOWNONRASTER, RASTERMODE_SHOWRASTER, SIDE_LEGEND

Constructor Summary

TextProductControl()
Default cstr;

Method Summary

protected Container	doMakeContents() Make the gui
String	getDisplayType() Get the text display type
int	getHours() Get the Hours property.
ProductType	getProductType() Get the Product property.
List<String>	getSelectedStationIds() Get the SelectedStationId property.
boolean	getShowGlossary() Get the ShowGlossary property.
protected List	getStationList() Get the station list
void	hyperlinkUpdate(HyperlinkEvent e) Handle a hyperlink update
boolean	init(DataChoice dataChoice) Called to make this kind of Display Control; also calls code to made the Displayable.
static void	main(String[] args) Test this out
protected void	selectedStationsChanged(List selectionList) Handle a change to the selected stations
void	setDisplayType(String type) Set the text display type
void	setHours(int value) Set the Hours property.
void	setProductType(ProductType value) Set the Product property.
void	setSelectedStationIds(List<String> value) Set the SelectedStationId property.
void	setShowGlossary(boolean value) Set the ShowGlossary property.
protected void	setText(String newText, boolean fromProduct) Set the text
protected void	timeChanged(Real time) Handle the time changed
void	updateText() Update the text.
protected void	xxxaddSelectedToList(List listOfStations) Add selected to list

Methods inherited from class ucar.unidata.idv.control.StationLocationControl

actionPerformed, addSelectedToList, buttonPressed, createStationModelDisplayable, doMakeDataInstance, doMakeDisplayPanel, doMakeStationListPanel, doMakeTabs, exportLocations, getCenterOnClick, getCursorReadoutInner, getDataProjection, getDataProjectionForMenu, getDataProjectionLabel, getDetailsContents, getDetailsInLegend, getEditMenuItems, getEnabled, getExtraLegendComponent, getFilterNames, getIdType, getLegendLabels, getMenuLabel, getMyStationModel, getSaveMenuItems, getShowId, getShowSymbol, getStationTableDescription, getStationTableNames, getSymbolType, getUseStationModel, getViewMenuItems, handleChangedStationModel, handleMousePressed, hasMapProjection, initAsPrototype, initDisplayable, initDone, isChartEnabled, loadData, loadDataInAWhile, makeStationModelEditMenuItems, reloadDataSource, resetData, setCenterOnClick, setData, setDeclutter, setDetailsInLegend, setEnabled, setIdType, setOnlyShowFiltered, setScaleOnDisplayable, setSelectedStations, setShowId, setShowSymbol, setStationTableName, setStationTableNames, setSymbolType, setUseStationModel, showFlythrough

Methods inherited from class ucar.unidata.idv.control.StationModelControl

addChartParam, addDensityComp, addDisplaySettings, addTimeDeclutterComp, applyFilters, applyTimeRange, calculateLatLonBounds, chartChanged, decodeFilterString, doInitialUpdateLegendAndList, doMakeFilterGui, doMakeSideLegendComponent, doMakeVerticalPositionPanel, doRemove, editStationTable, exportAsCsv, exportAsKmz, fieldSelectorChanged, filterData, findClosestOb, firstFrameDone, getAskedUserToDeclutterTime, getBounds, getChart, getChartParams, getColorTableToApply, getColorWidgetLabel, getControlWidgets, getDeclutter, getDeclutterFilter, getDensityControl, getDisplayableScale, getFilters, getFiltersEnabled, getImage, getInitialColorTable, getLockButton, getMatchAll, getOnlyShowFiltered, getRangeToApply, getScale, getScaleFromDisplayable, getSelectedObId, getSelectedObLocation, getShouldUseAltitude, getStationModel, getStationModelName, getStationsLocked, getTheStationModel, getTimeSeries, getTupleType, getUseDataTimes, getUseLastTime, handleDisplayChanged, handleOnlyShow, haveFilters, initAfterUnPersistence, initFilters, isInitDone, loadDataInThread, projectionChanged, propertyChange, removeChartParam, setAskedUserToDeclutterTime, setChartParams, setChartSettings, setDeclutterFilter, setDisplayableScale, setFilters, setFiltersEnabled, setLayoutModel, setMatchAll, setScaleOnDisplayable, setSelectedObId, setSelectedObLocation, setShouldUseAltitude, setShouldUseAltitudeIndex, setShowAllTimes, setShowThumbNail, setStationModelFromWidget, setStationModelName, setStationsLocked, setTheStationModel, setTimeSeries, setUseDataTimes, setUseLastTime, shouldAddControlListener, shouldAddDisplayListener, showLineProperties, test, timeDeclutterChanged, toFront, transectChanged, updateLockButton, updateTable, viewpointChanged

Methods inherited from class ucar.unidata.idv.control.ObsDisplayControl

applyPreferences, doDeclutterTime, doMakeFieldSelector, doMakeShowRawSelector, exportAsNetcdf, getColString, getColValue, getColValue, getDisplayUnit, getDisplayUnitName, getFieldsToShow, getIndex, getIndicesToShow, getParamLabel, getShowDataRaw, getTimeDeclutterComps, getTimeDeclutterEnabled, getTimeDeclutterMinutes, isIdParam, setColString, setShowDataRaw, setTimeDeclutterEnabled, setTimeDeclutterMinutes, showFieldSelector

Methods inherited from class ucar.unidata.idv.control.DisplayControlImpl

activateDisplays, addAttributedDisplayable, addAttributedDisplayable, addAttributedDisplayable, addAttributeFlags, addCheckBoxSettings, addDataChoice, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayMaster, addLabelMacros, addNewData, addNoteText, addPropertiesComponents, addPropertyChangeListener, addRemovable, addSharable, addTimeModeWidget, addToControlContext, addToRangeMenu, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyDisplayUnit, applyLineWidth, applyProperties, applyProperties, applyPropertyValues, applyRange, applySelectRange, applySkipFactor, applySmoothing, applyTextureQuality, applyZPosition, boundsClose, canBeDocked, canExportData, canSaveDataInCache, captureWindow, centerOnDisplay, changeColorUnit, changeDisplayUnit, checkFlag, checkIfDataOk, checkImageSize, clearDataInstance, clearPrototype, clearViewManagers, close, colorUnitChanged, controlChanged, convertColorRange, convertRange, createDisplayListDisplayable, createIdvWindow, dataChanged, deactivateDisplays, debug, displayableToFront, displayChanged, displayControlFailed, displayUnitChanged, doApplyProperties, doExport, doMakeBottomLegendComponent, doMakeChangeColorMenu, doMakeChangeColorMenu, doMakeChangeParameterMenuItem, doMakeColorControl, doMakeColorControl, doMakeColorScales, doMakeMenuBar, doMakeMenuBarMenus, doMakePointSizeWidget, doMakeRemoveControl, doMakeSkipFactorSlider, doMakeTextureSlider, doMakeVisibilityControl, doMakeWidgetComponent, doMakeWindow, doMakeZPositionSlider, exportDisplayedData, findDisplayInfo, findDisplays, findDisplays, firePropertyChangeEvent, formatForCursorReadout, getActive, getAnimation, getAnimation, getAnimation, getAnimation, getAnimationInfo, getAnimationWidget, getAttributeFlags, getCachedData, getCanDoRemoveAll, getCategories, getChangeParameterLabel, getCollapseLegend, getColor, getColorDimness, getColorScaleInfo, getColorTable, getColorTableForDisplayable, getColorTableWidget, getColorUnit, getColorUnitName, getComponentHolder, getContents, getContourInfo, getControlChangeSleepTime, getControlContext, getControlMenus, getCursorReadout, getCursorReadoutInner, getData, getDataChoice, getDataChoices, getDataForDisplayList, getDataInstance, getDataInstance, getDataSelection, getDataSources, getDataTimeRange, getDataTimeRange, getDataTimeSet, getDebugDetails, getDefaultColorScaleInfo, getDefaultDisplayListTemplate, getDefaultDistanceUnit, getDefaultFastRendering, getDefaultSamplingMode, getDefaultSamplingModeValue, getDefaultView, getDefaultViewDescriptor, getDefaultViewManager, getDisplayAltitudeType, getDisplayCategory, getDisplayCenter, getDisplayConventions, getDisplayedData, getDisplayId, getDisplayInfos, getDisplayListColor, getDisplayListData, getDisplayListDisplayable, getDisplayListTemplate, getDisplayMaster, getDisplayName, getDisplayScale, getDisplayUnit, getDisplayUnit, getDisplayUnitName, getDisplayVisibility, getDoCursorReadout, getEditMenuItems, getExpandedInTabs, getExtraLabelTemplate, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getGrid, getGrid, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getInitDataChoices, getInitialFastRendering, getInitialRange, getInitialZPosition, getInternalAnimation, getInternalAnimation, getIsRaster, getIsTimeDriver, getLabel, getLastFileMenuItems, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabelTemplate, getLegendToolTip, getLineWidth, getLineWidthWidget, getLineWidthWidgetLabel, getLockVisibilityToggle, getLongParamName, getMacroNames, getMainPanel, getMainPanelSize, getMakeWindow, getMapDisplay, getMapViewManager, getMapViewProjection, getMyDataChoices, getNavigatedDisplay, getNoteText, getObjectStore, getOkToFireEvents, getOldColorTableOrInitialColorTable, getOriginalDataChoicesLabel, getOuterContents, getPointSize, getProperty, getProperty, getPropertyDisplayName, getRange, getRangeForColorTable, getRawDataUnit, getRequestProperties, getSamplingModeName, getSamplingModeValue, getSamplingModeValue, getSelectRange, getSelectRangeEnabled, getSelectRangeWidget, getSettingsPanel, getShortParamName, getShowInDisplayList, getShowInLegend, getShowInTabs, getShowNoteText, getSkipValue, getSkipWidgetLabel, getSmoothingFactor, getSmoothingType, getSomeAnimation, getStore, getTemplateName, getTextureQuality, getTextureQualityLabel, getTimeSet, getTitle, getTransientProperty, getUnitForColor, getUseFastRendering, getUsesTimeDriver, getUseTimesInAnimation, getVersion, getVerticalValue, getViewAnimation, getViewContext, getViewer, getViewManager, getViewManager, getViewManager, getViewManagerClassNames, getViewManagerForCapture, getViewManagers, getViewMenuItems, getVisbilityAnimationPause, getWasUnPersisted, getWindow, getWindowSize, getWindowVisible, getWindowX, getWindowY, getZPosition, getZPositionSliderLabel, guiExported, guiImported, handleWindowClosing, hasTimeMacro, haveDataTimes, haveParameterDefaults, hide, inGlobeDisplay, init, init, init, initAfterUnPersistence, initAsTemplate, initBasic, initializeWithNewData, initWindow, isDisplay3D, isDisplayUnitAlsoColorUnit, isGuiShown, isInTransectView, isInViewManager, itemStateChanged, makeChangeColorMenuItems, makeLegendLabel, makeLockButton, makeRemoveButton, moveTo, notifyViewManagersOfChange, parseProperties, popup, popupDataDialog, popupDataDialog, popupDataDialog, processRequestProperties, putTransientProperty, reallySetAttributeFlags, receiveShareData, redoGuiLayout, reloadDataSourceInThread, removeDataChoice, removeDisplayable, removeDisplayables, removeDisplayables, removeOnWindowClose, removePropertyChangeListener, resetDimness, resetViewManager, revertToDefaultColorTable, revertToDefaultColorTable, revertToDefaultRange, revertToDefaultRange, saveAsFavorite, saveAsParameterDefaults, saveAsPrototype, saveAsTemplate, saveDataChoiceInCache, saveImage, selectDataChoices, setAnimationInfo, setAnimationSet, setAttributeFlags, setCachedData, setCanDoRemoveAll, setCategories, setCollapseLegend, setColor, setColorBrighter, setColorDimmer, setColorDimness, setColorScaleInfo, setColorScaleVisible, setColorTable, setColorTable, setColorTableName, setColorUnit, setColorUnitName, setComponentHolder, setContents, setContourInfo, setContourInfoParams, setData, setDataChoices, setDataInstance, setDataInstances, setDataSelection, setDataTimeRange, setDefaultSamplingMode, setDefaultView, setDisplayableVisibility, setDisplayableVisiblity, setDisplayActive, setDisplayCategory, setDisplayId, setDisplayInactive, setDisplayListColor, setDisplayListColor, setDisplayListProperties, setDisplayListTemplate, setDisplayName, setDisplayUnit, setDisplayUnitName, setDisplayVisibility, setDoCursorReadout, setExpandedInTabs, setExtraLabelTemplate, setHadDataChoices, setHelpUrl, setId, setInitDataChoices, setInitialSettings, setInitialViewManager, setIsRaster, setIsTimeDriver, setLabelAsPreference, setLegendBackground, setLegendForeground, setLegendLabel, setLegendLabelTemplate, setLineWidth, setLockVisibilityToggle, setMainPanelDimensions, setMainPanelSize, setMakeWindow, setName, setNameFromUser, setNewColorUnit, setNewDisplayUnit, setNoteText, setOkToFireEvents, setOriginalDataChoicesLabel, setParamName, setPersistedVisadData, setPointSize, setProjectionInView, setProjectionInView, setProperty, setRange, setRange, setSelectRange, setSelectRangeEnabled, setSettingsDisplayUnit, setSharedColorScaleInfo, setShowInDisplayList, setShowInLegend, setShowInTabs, setShowNoteText, setSkipValue, setSmoothingFactor, setSmoothingType, setTemplateName, setTextureQuality, setTitle, setUnitForColor, setUseFastRendering, setUsesTimeDriver, setUseTimesInAnimation, setVersion, setViewer, setViewManagerClassNames, setVisbilityAnimationPause, setWindowSize, setWindowVisible, setWindowX, setWindowY, setZPosition, setZPosition, shouldAddAnimationListener, shouldApplyFastRendering, shouldBeDocked, shouldWindowBeVisible, show, showColorControlWidget, showColorDialog, showColorDialog, showColorScaleDialog, showColorScales, showColorSwatches, showContourPropertiesDialog, showDetails, showDisplaySettingsDialog, showHelp, showLegendMenu, showNormalCursor, showProperties, showTimeRangeDialog, showWaitCursor, toFront, toggleNoteTextArea, toggleVisibilityForVectorGraphicsRendering, toggleWindow, toString, updateAnimation, updateDataInstance, updateDataSelection, updateDisplayList, updateGridDataInstance, updateLegendAndList, updateLegendLabel, updateLockButton, useSmoothingFactor, useZPosition, viewManagerChanged, viewManagerDestroyed, writeTestArchive, xxxsetDisplayActive, zSliderChanged

Methods inherited from class ucar.unidata.idv.control.DisplayControlBase

boxToEarth, boxToEarth, boxToEarth, boxToEarth, boxToEarth, boxToScreen, calculateRectangle, createStationTfo, earthToBox, earthToBox, earthToBoxTuple, earthToScreen, formatLevels, getLabeledReal, getLevelReal, getScreenCenter, getSelectedStation, getTmpProperty, isLeftButtonDown, logException, logException, makeEarthLocation, putTmpProperty, removeTmpProperty, screenToBox, screenToBox, screenToEarth, setStations, setStations, toBox, toEarth, userErrorMessage, userMessage

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, removeSharable, setReceiveShareTime, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.unidata.idv.DisplayControl

getTmpProperty, putTmpProperty, removeTmpProperty

Methods inherited from interface ucar.unidata.collab.Sharable

getReceiveShareTime, getShareGroup, getSharing, getUniqueId, setReceiveShareTime

Field Detail

TEXT_TYPE

public static final String TEXT_TYPE

type for text

See Also:

Constant Field Values

HTML_TYPE

public static final String HTML_TYPE

type for html

See Also:

Constant Field Values

Constructor Detail

TextProductControl

public TextProductControl()

Default cstr;

Method Detail

hyperlinkUpdate

public void hyperlinkUpdate(HyperlinkEvent e)

Handle a hyperlink update

Specified by:

hyperlinkUpdate in interface HyperlinkListener

Overrides:

hyperlinkUpdate in class DisplayControlImpl

Parameters:

e - Hyperlink event.

doMakeContents

protected Container doMakeContents()
                            throws VisADException,
                                   RemoteException

Make the gui

Overrides:

doMakeContents in class StationLocationControl

Returns:

The gui

Throws:

RemoteException - On badness

VisADException - On badness

getStationList

protected List getStationList()

Get the station list

Overrides:

getStationList in class StationLocationControl

Returns:

the list

selectedStationsChanged

protected void selectedStationsChanged(List selectionList)
                                throws VisADException,
                                       RemoteException

Handle a change to the selected stations

Overrides:

selectedStationsChanged in class StationLocationControl

Parameters:

selectionList - list of stations

Throws:

RemoteException - On badness

VisADException - On badness

updateText

public void updateText()

Update the text.

xxxaddSelectedToList

protected void xxxaddSelectedToList(List listOfStations)

Add selected to list

Parameters:

listOfStations - list of stations

main

public static void main(String[] args)
                 throws Exception

Test this out

Parameters:

args - text

Throws:

Exception - problem running the main

setText

protected void setText(String newText,
                       boolean fromProduct)

Set the text

Parameters:

newText - The new text to set

fromProduct - Is the text from a product

timeChanged

protected void timeChanged(Real time)

Handle the time changed

Overrides:

timeChanged in class StationModelControl

Parameters:

time - the time to set

init

public boolean init(DataChoice dataChoice)
             throws VisADException,
                    RemoteException

Description copied from class: StationLocationControl

Called to make this kind of Display Control; also calls code to made the Displayable. This method is called from inside DisplayControlImpl.init(several args). This implementation gets the list of stationTables to be used.

Overrides:

init in class StationLocationControl

Parameters:

dataChoice - the DataChoice of the moment -

Returns:

true if successful

Throws:

VisADException - there was a VisAD error

RemoteException - there was a remote error

setDisplayType

public void setDisplayType(String type)

Set the text display type

Parameters:

type - type (TEXT_TYPE or HTML_TYPE);

getDisplayType

public String getDisplayType()

Get the text display type

Returns:

type (TEXT_TYPE or HTML_TYPE);

setProductType

public void setProductType(ProductType value)

Set the Product property.

Parameters:

value - The new value for Product

getProductType

public ProductType getProductType()

Get the Product property.

Returns:

The Product

setSelectedStationIds

public void setSelectedStationIds(List<String> value)

Set the SelectedStationId property.

Parameters:

value - The new value for SelectedStationId

getSelectedStationIds

public List<String> getSelectedStationIds()

Get the SelectedStationId property.

Returns:

The SelectedStationId

setHours

public void setHours(int value)

Set the Hours property.

Parameters:

value - The new value for Hours

getHours

public int getHours()

Get the Hours property.

Returns:

The Hours

setShowGlossary

public void setShowGlossary(boolean value)

Set the ShowGlossary property.

Parameters:

value - The new value for ShowGlossary

getShowGlossary

public boolean getShowGlossary()

Get the ShowGlossary property.

Returns:

The ShowGlossary