ucar.unidata.idv.control
Class TextDisplayControl

java.lang.Object
  ucar.unidata.collab.SharableImpl
      ucar.unidata.idv.control.DisplayControlBase
          ucar.unidata.idv.control.DisplayControlImpl
              ucar.unidata.idv.control.TextDisplayControl

All Implemented Interfaces:

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

public class TextDisplayControl
extends DisplayControlImpl
implements HyperlinkListener, MouseMotionListener, MouseListener

DisplayControl for displaying straight text or HTML.

Version:

$Revision: 1.93 $

Author:

IDV development team

Nested Class Summary

static class

TextDisplayControl.PolyGlyph Class PolyGlyph

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

DisplayControlImpl.SideLegendLabel

Field Summary

static int	DEFAULT_HEIGHT default height
static int	DEFAULT_WIDTH default width
static Dimension	EDITOR_PREFERRRED_SIZE Preferred dimension for the editor pane
static Dimension	SCROLLPANE_PREFERRRED_SIZE Preferred dimension for the scroll pane
static String	SHARE_URL property for sharing URL
static String	TAG_APPLET applet tag
static String	TAG_COMPONENT component tag
static String	TAG_DISPLAY display tag
static String	TAG_INTERNALIMAGE For having internal images (from auxdata) in html
static String	TAG_VIEW view tag

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

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

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_TIMERANGE, FLAG_ZPOSITION, GRID_INSETS, ICON_LOCK, ICON_REMOVE, ICON_UNLOCK, LABEL_NONE, log_, MACRO_DATASOURCENAME, MACRO_DISPLAYNAME, MACRO_DISPLAYUNIT, MACRO_LONGNAME, MACRO_POSITION, MACRO_SHORTNAME, 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, SIDE_LEGEND

Constructor Summary

TextDisplayControl()
Default constructor; does nothing.

Method Summary

void	click(String linkText, boolean doHistory) Respond to a click.
void	click(String linkText, boolean doHistory, boolean andShare) Respond to a click.
protected Container	doMakeContents() Make the contents for this control
protected Component	doMakeMainButtonPanel() Override the base class button panel method
void	doRemove() Remove from the IDV
String	getCurrentUrl() Get the current URL.
String	getDisplayName() Get the display name.
ArrayList	getGlyphHistory() Get the glyph history.
List	getGlyphs() Get the Glyphs property.
ArrayList	getHistory() Get the history list.
int	getHistoryIdx() Get the index into the history
String	getRootPath() Get the root path.
protected String	getTitle() Overwrite the base class method to return the filename or url.
void	goToUrl(String url) Go to a particular URL
void	history(int delta) Scroll through the history.
void	hyperlinkUpdate(HyperlinkEvent e) Respond to any hyperlink events: ACTIVATED, ENTERED, EXITED.
boolean	init(DataChoice dataChoice) Initialize this class with the supplied DataChoice.
void	mouseClicked(MouseEvent e) Public method for mouse clicked events
void	mouseDragged(MouseEvent e) Public method for mouse dragged events
void	mouseEntered(MouseEvent e) Public method for mouse entered events
void	mouseExited(MouseEvent e) Public method for mouse exited events
void	mouseMoved(MouseEvent e) Public method for mouse moved events
void	mousePressed(MouseEvent e) Public method for mouse Pressed events
void	mouseReleased(MouseEvent e) Public method for mouse released events
void	print(Element elem, String tab) Print the element
void	processForm(String action, String data) Process the form data.
void	receiveShareData(Sharable from, Object dataId, Object[] data) Receive shared data from another control
void	reload() Reload the page
void	setGlyphHistory(ArrayList h) Set the history list.
void	setGlyphs(List value) Set the Glyphs property.
void	setHistory(ArrayList h) Set the history list.
void	setHistoryIdx(int h) Set the index into the history
void	writeTestArchive(String archiveName) test code

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

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

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

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

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, removeSharable, 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.collab.Sharable

getShareGroup, getSharing, getUniqueId

Field Detail

SHARE_URL

public static final String SHARE_URL

property for sharing URL

See Also:

Constant Field Values

TAG_INTERNALIMAGE

public static final String TAG_INTERNALIMAGE

For having internal images (from auxdata) in html

See Also:

Constant Field Values

TAG_VIEW

public static final String TAG_VIEW

view tag

See Also:

Constant Field Values

TAG_DISPLAY

public static final String TAG_DISPLAY

display tag

See Also:

Constant Field Values

TAG_APPLET

public static final String TAG_APPLET

applet tag

See Also:

Constant Field Values

TAG_COMPONENT

public static final String TAG_COMPONENT

component tag

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

default width

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

default height

See Also:

Constant Field Values

EDITOR_PREFERRRED_SIZE

public static final Dimension EDITOR_PREFERRRED_SIZE

Preferred dimension for the editor pane

SCROLLPANE_PREFERRRED_SIZE

public static final Dimension SCROLLPANE_PREFERRRED_SIZE

Preferred dimension for the scroll pane

Constructor Detail

TextDisplayControl

public TextDisplayControl()

Default constructor; does nothing. Heavy work done in init().

Method Detail

init

public boolean init(DataChoice dataChoice)
             throws VisADException,
                    RemoteException

Initialize this class with the supplied DataChoice.

Overrides:

init in class DisplayControlImpl

Parameters:

dataChoice - choice to describe the data

Returns:

true if successful

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

getTitle

protected String getTitle()

Overwrite the base class method to return the filename or url.

Overrides:

getTitle in class DisplayControlImpl

Returns:

The filename or url as the title.

doMakeContents

protected Container doMakeContents()
                            throws VisADException,
                                   RemoteException

Make the contents for this control

Overrides:

doMakeContents in class DisplayControlImpl

Returns:

UI for the control

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

mouseDragged

public void mouseDragged(MouseEvent e)

Public method for mouse dragged events

Specified by:

mouseDragged in interface MouseMotionListener

Parameters:

e - mouse event

mouseMoved

public void mouseMoved(MouseEvent e)

Public method for mouse moved events

Specified by:

mouseMoved in interface MouseMotionListener

Parameters:

e - mouse event

mouseClicked

public void mouseClicked(MouseEvent e)

Public method for mouse clicked events

Specified by:

mouseClicked in interface MouseListener

Parameters:

e - mouse event

mouseEntered

public void mouseEntered(MouseEvent e)

Public method for mouse entered events

Specified by:

mouseEntered in interface MouseListener

Parameters:

e - mouse event

mouseExited

public void mouseExited(MouseEvent e)

Public method for mouse exited events

Specified by:

mouseExited in interface MouseListener

Parameters:

e - mouse event

mousePressed

public void mousePressed(MouseEvent e)

Public method for mouse Pressed events

Specified by:

mousePressed in interface MouseListener

Parameters:

e - mouse event

mouseReleased

public void mouseReleased(MouseEvent e)

Public method for mouse released events

Specified by:

mouseReleased in interface MouseListener

Parameters:

e - mouse event

reload

public void reload()

Reload the page

print

public void print(Element elem,
                  String tab)

Print the element

Parameters:

elem - element to print

tab - tab (prefix) string

getHistory

public ArrayList getHistory()

Get the history list. Used by XML persistence.

Returns:

list of visited sites

setHistory

public void setHistory(ArrayList h)

Set the history list. Used by XML persistence.

Parameters:

h - list to use

getGlyphHistory

public ArrayList getGlyphHistory()

Get the glyph history. Used by XML persistence.

Returns:

glyph history list

setGlyphHistory

public void setGlyphHistory(ArrayList h)

Set the history list. Used by XML persistence.

Parameters:

h - history list

setGlyphs

public void setGlyphs(List value)

Set the Glyphs property.

Parameters:

value - The new value for Glyphs

getGlyphs

public List getGlyphs()

Get the Glyphs property.

Returns:

The Glyphs

getHistoryIdx

public int getHistoryIdx()

Get the index into the history

Returns:

history index.

setHistoryIdx

public void setHistoryIdx(int h)

Set the index into the history

Parameters:

h - index

doMakeMainButtonPanel

protected Component doMakeMainButtonPanel()

Override the base class button panel method

Returns:

component for button panel

processForm

public void processForm(String action,
                        String data)

Process the form data.

Parameters:

action - action for form

data - form data.

hyperlinkUpdate

public void hyperlinkUpdate(