thredds.ui.catalog

Class ThreddsDatasetChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

thredds.ui.catalog.ThreddsDatasetChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ThreddsDatasetChooser
extends JPanel

A Swing widget for THREDDS clients that combines a CatalogChooser, and optionally a QueryChooser PropertyChangeEvent events are thrown to notify you of various user actions; see addPropertyChangeListener.

You can use the ThreddsDatasetChooser:

1. add the components into your own JTabbedPanel.
2. wrapped in a JDialog for popping up
3. as a standalone application through its main() method

Example:

    datasetChooser = new ThreddsDatasetChooser( prefs, tabbedPane);
    datasetChooser.addPropertyChangeListener(  new java.beans.PropertyChangeListener() {
      public void propertyChange( java.beans.PropertyChangeEvent e) {
        if (e.getPropertyName().equals("Dataset")) {
          thredds.catalog.InvDataset ds = (thredds.catalog.InvDataset) e.getNewValue();
          setDataset( ds);
         }
        }
      }
    });
   

To use as popup dialog box:

   ThreddsDatasetChooser datasetChooser = new ThreddsDatasetChooser( prefs, null);
   JDialog datasetChooserDialog = datasetChooser.makeDialog("Open THREDDS dataset", true);
   datasetChooserDialog.show();
  

When using as a standalone application, the default behavior is to write the dataURLs of the selections to standard out. Copy main() and make changes as needed.

   java -classpath clientUI.jar;... thredds.catalog.ui.ThreddsDatasetChooser
  

Author:

John Caron

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 inherited from class javax.swing.JComponent

accessibleContext, 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

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
ThreddsDatasetChooser(PreferencesExt prefs, JTabbedPane tabs) Usual Constructor.
ThreddsDatasetChooser(PreferencesExt prefs, JTabbedPane tabs, JFrame frame, boolean pipeOutput, boolean messageOutput, boolean addDqc) General Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Add a PropertyChangeEvent Listener.
CatalogChooser	getCatalogChooser() Get the component CatalogChooser
QueryChooser	getQueryChooser() Get the component QueryChooser
static void	main(String[] args) Standalone application.
JDialog	makeDialog(JFrame parent, String title, boolean modal) Wrap this in a JDialog component.
void	removePropertyChangeListener(PropertyChangeListener l) Remove a PropertyChangeEvent Listener.
void	save() save the state
void	setDatasetFilter(DatasetFilter filter) Set a dataset filter to be used on all catalogs.
void	setDoResolve(boolean doResolve) If you want resolver datasets to be resolved (default false).

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, 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, 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

Constructor Detail

ThreddsDatasetChooser

public ThreddsDatasetChooser(PreferencesExt prefs,
                     JTabbedPane tabs)

Usual Constructor. Create a CatalogChooser and a QueryChooser widget, add them to a JTabbedPane.

Parameters:

prefs - persistent storage, may be null

tabs - add panels to this JTabbedPane, may be null if you are using as Dialog.

ThreddsDatasetChooser

public ThreddsDatasetChooser(PreferencesExt prefs,
                     JTabbedPane tabs,
                     JFrame frame,
                     boolean pipeOutput,
                     boolean messageOutput,
                     boolean addDqc)

General Constructor. Create a CatalogChooser and a QueryChooser widget, add them to a JTabbedPane. Optionally write to stdout and/or pop up event messsages.

Parameters:

prefs - persistent storage

tabs - add to this JTabbedPane

frame - best if non-null when messageOutP = true, otherwise null

pipeOutput - send selection message to System.out

messageOutput - send selection to popup message

Method Detail

setDatasetFilter

public void setDatasetFilter(DatasetFilter filter)

Set a dataset filter to be used on all catalogs. To turn off, set to null.

Parameters:

filter - DatasetFilter or null

setDoResolve

public void setDoResolve(boolean doResolve)

If you want resolver datasets to be resolved (default false). If true, may throw "Datasets" event.

Parameters:

doResolve -

getQueryChooser

public QueryChooser getQueryChooser()

Get the component QueryChooser

getCatalogChooser

public CatalogChooser getCatalogChooser()

Get the component CatalogChooser

save

public void save()

save the state

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Add a PropertyChangeEvent Listener. Throws a PropertyChangeEvent:

• propertyName = "Dataset" or "File", getNewValue() = InvDataset chosen.
• propertyName = "Datasets", getNewValue() = InvDataset[] chosen. This can only happen if you have set doResolve = true, and the resolved dataset is a list of datasets.
• propertyName = "InvAccess" getNewValue() = InvAccess chosen.

Overrides:

addPropertyChangeListener in class Container

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Remove a PropertyChangeEvent Listener.

Overrides:

removePropertyChangeListener in class Component

makeDialog

public JDialog makeDialog(JFrame parent,
                 String title,
                 boolean modal)

Wrap this in a JDialog component.

Parameters:

parent - put dialog on top of this, may be null

title - dialog window title

modal - is modal

main

public static void main(String[] args)

Standalone application.

Parameters:

args - recognized values:

• -usePopup to popup messages