Package noaa.coastwatch.gui

Class SurveyListChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

noaa.coastwatch.gui.SurveyListChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, TabComponent

public class SurveyListChooser
extends JPanel
implements TabComponent

The SurveyListChooser class is a panel that allows the user to manipulate a list of EarthDataSurvey objects. The user may add a new point, line, or box survey, edit the survey color, name and linestyle, and change the survey layer.

The chooser signals a change in the survey list by firing a property change event whose property name is given by SURVEY_LIST_PROPERTY. See the AbstractOverlayListPanel class for details on how the property change events should be interpreted.

Surveys require that extra information be provided from the user object. The chooser signals that it requires input for a survey by firing an action event whose action command specifies the type of input required as POINT_COMMAND, LINE_COMMAND, or BOX_COMMAND. The user object should perform some operation to obtain the survey input information, and then pass it to the addSurvey() method.

Since:

3.1.7

Author:

Peter Hollemans

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BOX_COMMAND	The box survey command.
static final String	LINE_COMMAND	The line survey command.
static final String	POINT_COMMAND	The point survey command.
static final String	POLYGON_COMMAND	The polygon survey command.
static final String	SURVEY_LIST_PROPERTY	The survey list property.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
SurveyListChooser()	Creates a new survey list chooser.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Redirects overlay property listeners to the list panel.
void	addSurvey(EarthDataSurvey survey)	Adds a new survey.
void	addSurveyActionListener(ActionListener listener)	Adds the specified listener for receiving survey input action commands.
void	deactivate()	Deactivates the survey so that no survey is selected.
Icon	getIcon()	Gets the tab icon.
String	getSurveyCommand()	Gets the last survey command executed.
String	getTitle()	Gets the tab title.
String	getToolTip()	Gets the tab tooltip.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

SURVEY_LIST_PROPERTY

public static final String SURVEY_LIST_PROPERTY

The survey list property.

POINT_COMMAND

public static final String POINT_COMMAND

The point survey command.

See Also:

• Constant Field Values

LINE_COMMAND

public static final String LINE_COMMAND

The line survey command.

See Also:

• Constant Field Values

BOX_COMMAND

public static final String BOX_COMMAND

The box survey command.

See Also:

• Constant Field Values

POLYGON_COMMAND

public static final String POLYGON_COMMAND

The polygon survey command.

See Also:

• Constant Field Values

Constructor Details

SurveyListChooser

public SurveyListChooser()

Creates a new survey list chooser.

Method Details

getSurveyCommand

public String getSurveyCommand()

Gets the last survey command executed.

addSurveyActionListener

public void addSurveyActionListener(ActionListener listener)

Adds the specified listener for receiving survey input action commands.

getToolTip

public String getToolTip()

Description copied from interface: TabComponent

Gets the tab tooltip.

Specified by:

getToolTip in interface TabComponent

Returns:

the tooltip text if the tab is to have an appearing tooltip when the mouse hovers over the tab, or null if no tooltip is required.

getTitle

public String getTitle()

Description copied from interface: TabComponent

Gets the tab title.

Specified by:

getTitle in interface TabComponent

Returns:

the title to be used if the tab is to have a text label as a title, or null if no title is required.

getIcon

public Icon getIcon()

Description copied from interface: TabComponent

Gets the tab icon.

Specified by:

getIcon in interface TabComponent

Returns:

the icon to be used if the tab is to have an icon beside the title label, or null if no icon is required.

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Redirects overlay property listeners to the list panel.

Overrides:

addPropertyChangeListener in class Container

addSurvey

public void addSurvey(EarthDataSurvey survey)

Adds a new survey. A survey overlay is created for the survey and the overlay added to the list.

Parameters:

survey - the new data survey to add.

deactivate

public void deactivate()

Deactivates the survey so that no survey is selected.