jsky.catalog.gui
Class CatalogQueryTool

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by jsky.catalog.gui.CatalogQueryTool
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, Interruptable, Storeable
Direct Known Subclasses:
NavigatorQueryTool

public class CatalogQueryTool
extends javax.swing.JPanel
implements java.awt.event.ActionListener, Interruptable, Storeable

Displays a CatalogQueryPanel in a JScrollPane and implements a search() method.

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
CatalogQueryTool(Catalog catalog, boolean scrollable)
          Create a CatalogQueryTool for searching the given catalog.
CatalogQueryTool(Catalog catalog, QueryResultDisplay queryResultDisplay)
          Create a CatalogQueryTool for searching the given catalog.
CatalogQueryTool(Catalog catalog, QueryResultDisplay queryResultDisplay, boolean scrollable)
          Create a CatalogQueryTool for searching the given catalog.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent ev)
          Called when return is typed in one of the query panel text fields to start the query.
 Catalog getCatalog()
          Return the catalog for this object
 CatalogQueryPanel getCatalogQueryPanel()
          Return the panel containing labels and entries for searching the catalog
 java.lang.String getName()
          Return the name of this component (based on the data being displayed)
 QueryResultDisplay getQueryResultDisplay()
          Return the object used to diplay the result of a query
 void interrupt()
          Stop the background loading thread if it is running
protected  javax.swing.JPanel makeButtonPanel()
          Make and return the button panel
protected  javax.swing.JLabel makeCatalogPanelLabel(Catalog catalog)
          Make and return the catalog panel label
protected  CatalogQueryPanel makeCatalogQueryPanel(Catalog catalog)
          Make and return the catalog query panel
 boolean restoreSettings(java.lang.Object obj)
          Restore the settings previously stored.
 void search()
          Query the catalog based on the settings in the query panel and display the results.
 void setQueryResult(QueryResult queryResult)
          Display the given query result.
 void setQueryResultDisplay(QueryResultDisplay q)
          Set the object used to diplay the result of a query
 java.lang.Object storeSettings()
          Store the current settings in a serializable object and return the object.
 
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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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, transferFocusBackward, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CatalogQueryTool

public CatalogQueryTool(Catalog catalog,
                        boolean scrollable)
Create a CatalogQueryTool for searching the given catalog.

Parameters:
catalog - The catalog to use.
scrollable - set to true to allow scrolling of the query panel

CatalogQueryTool

public CatalogQueryTool(Catalog catalog,
                        QueryResultDisplay queryResultDisplay,
                        boolean scrollable)
Create a CatalogQueryTool for searching the given catalog.

Parameters:
catalog - The catalog to use.
queryResultDisplay - object used to display query results
scrollable - set to true to allow scrolling of the query panel

CatalogQueryTool

public CatalogQueryTool(Catalog catalog,
                        QueryResultDisplay queryResultDisplay)
Create a CatalogQueryTool for searching the given catalog.

Parameters:
catalog - The catalog to use.
queryResultDisplay - object used to display query results
Method Detail

makeCatalogPanelLabel

protected javax.swing.JLabel makeCatalogPanelLabel(Catalog catalog)
Make and return the catalog panel label


makeCatalogQueryPanel

protected CatalogQueryPanel makeCatalogQueryPanel(Catalog catalog)
Make and return the catalog query panel


makeButtonPanel

protected javax.swing.JPanel makeButtonPanel()
Make and return the button panel


setQueryResultDisplay

public void setQueryResultDisplay(QueryResultDisplay q)
Set the object used to diplay the result of a query


getQueryResultDisplay

public QueryResultDisplay getQueryResultDisplay()
Return the object used to diplay the result of a query


interrupt

public void interrupt()
Stop the background loading thread if it is running

Specified by:
interrupt in interface Interruptable

getName

public java.lang.String getName()
Return the name of this component (based on the data being displayed)

Overrides:
getName in class java.awt.Component

getCatalog

public Catalog getCatalog()
Return the catalog for this object


getCatalogQueryPanel

public CatalogQueryPanel getCatalogQueryPanel()
Return the panel containing labels and entries for searching the catalog


actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ev)
Called when return is typed in one of the query panel text fields to start the query.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

search

public void search()
Query the catalog based on the settings in the query panel and display the results.


setQueryResult

public void setQueryResult(QueryResult queryResult)
Display the given query result.


storeSettings

public java.lang.Object storeSettings()
Store the current settings in a serializable object and return the object.

Specified by:
storeSettings in interface Storeable

restoreSettings

public boolean restoreSettings(java.lang.Object obj)
Restore the settings previously stored.

Specified by:
restoreSettings in interface Storeable