ChooserPanel (Unidata IDV API v6.3)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - ucar.unidata.ui.ChooserPanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

IdvChooser
```
public class ChooserPanel
extends javax.swing.JPanel
implements java.awt.event.ActionListener
```
Common class for the chooser panels.

Author:

Unidata Metapps development team

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  javax.swing.JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected javax.swing.JButton`	`cancelButton` Cancel button.
`static java.lang.String`	`CMD_LOAD` Text for the load button.
`protected javax.swing.JComponent`	`contents` Panel holding the contents.
`protected static java.awt.Insets`	`GRID_INSETS` Used by derived classes when they do a GuiUtils.doLayout
`protected static int`	`GRID_SPACING` The spacing used in the grid layout.
`protected static int`	`GRID_SPACING_H` The Constant GRID_SPACING_H.
`protected static int`	`GRID_SPACING_V` The Constant GRID_SPACING_V.
`protected boolean`	`haveData` Flag for whether data has been chosen or not.
`protected java.lang.String`	`helpPath` Where can we find help for this panel.
`protected javax.swing.JButton`	`loadButton` Load button.
`static java.awt.Color`	`MAP_COLOR` The color for station maps.
`protected boolean`	`simpleMode` _more_.
`protected javax.swing.JLabel`	`statusLabel` Shows the status.

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 and Description

ChooserPanel()
Construct an object for selecting a data source from the current directory and from a default ADDE server.

Constructors
Constructor and Description
`ChooserPanel()` Construct an object for selecting a data source from the current directory and from a default ADDE server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent ae)` Receive the update,cancel, load commands and call: doUpdate, doCancel or doLoad.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds a PropertyChangeListener.
`boolean`	`canDoUpdate()` Can do update.
`void`	`clearWaitCursor()` Clear any outstanding cursor waits.
`void`	`doCancel()` Gets called when the user presses Cancel in multipleSelect mode This can get overwritten by a derived class to do something.
`protected void`	`doClose()` Gets called to close the panel.
`void`	`doHelp()` Gets called when the user presses the Help button.
`void`	`doLoad()` Gets called when the user presses `CMD_LOAD` button.
`void`	`doLoadInThread()` Gets called by doLoad in a thread when the user presses the load button.
`protected javax.swing.JComponent`	`doMakeContents()` Do make contents.
`void`	`doUpdate()` Gets called when the user presses the Update button.
`protected void`	`firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)` Fires a PropertyChangeEvent.
`protected java.lang.String[]`	`getButtonLabels()` Get the names for the buttons.
`javax.swing.JComponent`	`getContents()` Hides the fact that this is really a JPanel.
`javax.swing.JComponent`	`getDefaultButtons()` Get the default buttons for this chooser panel.
`javax.swing.JComponent`	`getDefaultButtons(java.awt.event.ActionListener listener)` Gets the default buttons.
`boolean`	`getHaveData()` Gets the have data.
`protected java.lang.String`	`getLoadCommandName()` This allows for derived classes to define their own name for the "Add source" button.
`protected java.lang.String`	`getLoadToolTip()` Get the tooltip for the load button.
`protected java.lang.String`	`getMessageTemplate()` Gets the message template.
`boolean`	`getSimpleMode()` Gets the simple mode.
`protected javax.swing.JComponent`	`getStatusComponent()` Gets the status component.
`protected javax.swing.JLabel`	`getStatusLabel()` Create (if needed) and return the JLabel that shows the status messages.
`java.awt.Color`	`getStatusLabelBackground()` Gets the status label background.
`java.awt.Color`	`getStatusLabelForeground()` Gets the status label foreground.
`protected java.lang.String`	`getUpdateToolTip()` Get the tooltip for the update button.
`void`	`logException(java.lang.String msg, java.lang.Exception exc)` Convenience method to `LogUtil.logException(String, Throwable)`.
`javax.swing.JComponent`	`padLabel(java.lang.String s)` Pad label.
`protected javax.swing.JComponent`	`registerStatusComp(java.lang.String name, javax.swing.JComponent comp)` Register status comp.
`void`	`revalidate()`
`void`	`setHaveData(boolean have)` Set whether the user has made a selection that contains data.
`void`	`setHelpPath(java.lang.String path)` Set the help path used for this chooser.
`void`	`setMessageTemplate(java.lang.String template)` Sets the message template.
`void`	`setStatus(java.lang.String msg)` Set the status message.
`void`	`setStatus(java.lang.String msg, java.lang.String compId)` Sets the status.
`void`	`showNormalCursor()` Set the normal cursor over this panel.
`void`	`showNormalCursor(javax.swing.JComponent comp)` Set the normal cursor over this panel.
`void`	`showWaitCursor()` Set the wait cursor over this panel.
`void`	`showWaitCursor(javax.swing.JComponent comp)` Set the wait cursor over this panel.
`protected void`	`updateStatus()` Update status.

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, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail
  - GRID_SPACING
```
protected static final int GRID_SPACING
```
    The spacing used in the grid layout.
    
    See Also:
    
    Constant Field Values
  - GRID_SPACING_V
```
protected static final int GRID_SPACING_V
```
    The Constant GRID_SPACING_V.
    
    See Also:
    
    Constant Field Values
  - GRID_SPACING_H
```
protected static final int GRID_SPACING_H
```
    The Constant GRID_SPACING_H.
    
    See Also:
    
    Constant Field Values
  - GRID_INSETS
```
protected static final java.awt.Insets GRID_INSETS
```
    Used by derived classes when they do a GuiUtils.doLayout
  - MAP_COLOR
```
public static final java.awt.Color MAP_COLOR
```
    The color for station maps.
  - CMD_LOAD
```
public static final java.lang.String CMD_LOAD
```
    Text for the load button.
    
    See Also:
    
    Constant Field Values
  - helpPath
```
protected java.lang.String helpPath
```
    Where can we find help for this panel.
  - contents
```
protected javax.swing.JComponent contents
```
    Panel holding the contents.
  - loadButton
```
protected javax.swing.JButton loadButton
```
    Load button.
  - cancelButton
```
protected javax.swing.JButton cancelButton
```
    Cancel button.
  - haveData
```
protected boolean haveData
```
    Flag for whether data has been chosen or not.
  - statusLabel
```
protected javax.swing.JLabel statusLabel
```
    Shows the status.
  - simpleMode
```
protected boolean simpleMode
```
    _more_.
- Constructor Detail
  - ChooserPanel
```
public ChooserPanel()
```
    Construct an object for selecting a data source from the current directory and from a default ADDE server.
- Method Detail
  - setMessageTemplate
```
public void setMessageTemplate(java.lang.String template)
```
    Sets the message template.
    
    Parameters:
    
    template - the new message template
  - getMessageTemplate
```
protected java.lang.String getMessageTemplate()
```
    Gets the message template.
    
    Returns:
    
    the message template
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Adds a PropertyChangeListener.
    
    Overrides:
    
    addPropertyChangeListener in class java.awt.Container
    
    Parameters:
    
    listener - The PropertyChangeListener to add.
  - firePropertyChange
```
protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)
```
    Fires a PropertyChangeEvent.
    
    Overrides:
    
    firePropertyChange in class java.awt.Component
    
    Parameters:
    
    propertyName - The name of the property.
    
    oldValue - The old value of the property.
    
    newValue - The new Value of the property.
  - revalidate
```
public void revalidate()
```
    Overrides:
    
    revalidate in class javax.swing.JComponent
  - registerStatusComp
```
protected javax.swing.JComponent registerStatusComp(java.lang.String name,
                                                    javax.swing.JComponent comp)
```
    Register status comp.
    
    Parameters:
    
    name - the name
    
    comp - the comp
    
    Returns:
    
    the JComponent
  - setStatus
```
public void setStatus(java.lang.String msg)
```
    Set the status message.
    
    Parameters:
    
    msg - The status message
  - getSimpleMode
```
public boolean getSimpleMode()
```
    Gets the simple mode.
    
    Returns:
    
    the simple mode
  - setStatus
```
public void setStatus(java.lang.String msg,
                      java.lang.String compId)
```
    Sets the status.
    
    Parameters:
    
    msg - the msg
    
    compId - the comp id
  - getStatusLabel
```
protected javax.swing.JLabel getStatusLabel()
```
    Create (if needed) and return the JLabel that shows the status messages.
    
    Returns:
    
    The status label
  - getStatusLabelBackground
```
public java.awt.Color getStatusLabelBackground()
```
    Gets the status label background.
    
    Returns:
    
    the status label background
  - getStatusLabelForeground
```
public java.awt.Color getStatusLabelForeground()
```
    Gets the status label foreground.
    
    Returns:
    
    the status label foreground
  - getStatusComponent
```
protected javax.swing.JComponent getStatusComponent()
```
    Gets the status component.
    
    Returns:
    
    the status component
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent ae)
```
    Receive the update,cancel, load commands and call: doUpdate, doCancel or doLoad.
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
    
    Parameters:
    
    ae - ActionEvent to process
  - getLoadCommandName
```
protected java.lang.String getLoadCommandName()
```
    This allows for derived classes to define their own name for the "Add source" button.
    
    Returns:
    
    custom name
  - getDefaultButtons
```
public javax.swing.JComponent getDefaultButtons()
```
    Get the default buttons for this chooser panel.
    
    Returns:
    
    panel of buttons
  - getDefaultButtons
```
public javax.swing.JComponent getDefaultButtons(java.awt.event.ActionListener listener)
```
    Gets the default buttons.
    
    Parameters:
    
    listener - the listener
    
    Returns:
    
    the default buttons
  - canDoUpdate
```
public boolean canDoUpdate()
```
    Can do update.
    
    Returns:
    
    true, if successful
  - getButtonLabels
```
protected java.lang.String[] getButtonLabels()
```
    Get the names for the buttons.
    
    Returns:
    
    array of button names
  - getLoadToolTip
```
protected java.lang.String getLoadToolTip()
```
    Get the tooltip for the load button.
    
    Returns:
    
    The tooltip for the load button
  - getUpdateToolTip
```
protected java.lang.String getUpdateToolTip()
```
    Get the tooltip for the update button.
    
    Returns:
    
    The tooltip for the update button
  - setHaveData
```
public void setHaveData(boolean have)
```
    Set whether the user has made a selection that contains data.
    
    Parameters:
    
    have - true to set the haveData property. Enables the loading button
  - getHaveData
```
public boolean getHaveData()
```
    Gets the have data.
    
    Returns:
    
    the have data
  - clearWaitCursor
```
public void clearWaitCursor()
```
    Clear any outstanding cursor waits.
  - showWaitCursor
```
public void showWaitCursor()
```
    Set the wait cursor over this panel.
  - showNormalCursor
```
public void showNormalCursor()
```
    Set the normal cursor over this panel.
  - showWaitCursor
```
public void showWaitCursor(javax.swing.JComponent comp)
```
    Set the wait cursor over this panel.
    
    Parameters:
    
    comp - the comp
  - showNormalCursor
```
public void showNormalCursor(javax.swing.JComponent comp)
```
    Set the normal cursor over this panel.
    
    Parameters:
    
    comp - the comp
  - padLabel
```
public javax.swing.JComponent padLabel(java.lang.String s)
```
    Pad label.
    
    Parameters:
    
    s - the string
    
    Returns:
    
    the JComponent
  - getContents
```
public javax.swing.JComponent getContents()
```
    Hides the fact that this is really a JPanel.
    
    Returns:
    
    the contents
  - doMakeContents
```
protected javax.swing.JComponent doMakeContents()
```
    Do make contents.
    
    Returns:
    
    the JComponent
  - updateStatus
```
protected void updateStatus()
```
    Update status.
  - doLoad
```
public void doLoad()
```
    Gets called when the user presses CMD_LOAD button. This can get overwritten by a derived class to do something. By default this calls doLoadDataInThread in a separate thread
  - doLoadInThread
```
public void doLoadInThread()
```
    Gets called by doLoad in a thread when the user presses the load button. Should be overwritten by a derived class.
  - doUpdate
```
public void doUpdate()
```
    Gets called when the user presses the Update button. This can get overwritten by a derived class to do something.
  - doHelp
```
public void doHelp()
```
    Gets called when the user presses the Help button.
  - doCancel
```
public void doCancel()
```
    Gets called when the user presses Cancel in multipleSelect mode This can get overwritten by a derived class to do something.
  - doClose
```
protected void doClose()
```
    Gets called to close the panel.
  - logException
```
public void logException(java.lang.String msg,
                         java.lang.Exception exc)
```
    Convenience method to LogUtil.logException(String, Throwable).
    
    Parameters:
    
    msg - message to log
    
    exc - Exception to log
  - setHelpPath
```
public void setHelpPath(java.lang.String path)
```
    Set the help path used for this chooser.
    
    Parameters:
    
    path - the new help path

Class ChooserPanel

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

GRID_SPACING

GRID_SPACING_V

GRID_SPACING_H

GRID_INSETS

MAP_COLOR

CMD_LOAD

helpPath

contents

loadButton

cancelButton

haveData

statusLabel

simpleMode

Constructor Detail

ChooserPanel

Method Detail

setMessageTemplate

getMessageTemplate

addPropertyChangeListener

firePropertyChange

revalidate

registerStatusComp

setStatus

getSimpleMode

setStatus

getStatusLabel

getStatusLabelBackground

getStatusLabelForeground

getStatusComponent

actionPerformed

getLoadCommandName

getDefaultButtons

getDefaultButtons

canDoUpdate

getButtonLabels

getLoadToolTip

getUpdateToolTip

setHaveData

getHaveData

clearWaitCursor

showWaitCursor

showNormalCursor

showWaitCursor

showNormalCursor

padLabel

getContents

doMakeContents

updateStatus

doLoad

doLoadInThread

doUpdate

doHelp

doCancel

doClose

logException

setHelpPath