QueryWindow (Starjava TOPCAT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Frame
      - javax.swing.JFrame
        
        uk.ac.starlink.topcat.AuxWindow
        
        uk.ac.starlink.topcat.QueryWindow

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

AbstractSubsetQueryWindow, ActivationQueryWindow, ParameterQueryWindow, SaveQueryWindow, SaveTableQueryWindow, SkyColumnQueryWindow, SyntheticColumnQueryWindow
```
public abstract class QueryWindow
extends AuxWindow
```
Abstract superclass for windows which are going to ask the user for some input. These are like non-modal dialogues, but share some of the TOPCAT (AuxWindow) look and feel.

See Also:

Serialized Form

Nested Class Summary
- 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
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Frame
  java.awt.Frame.AccessibleAWTFrame
- Nested classes/interfaces inherited from class javax.swing.JFrame
  javax.swing.JFrame.AccessibleJFrame
- Nested classes/interfaces inherited from class java.awt.Window
  java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Field Summary

Fields
Modifier and Type Field Description

protected javax.swing.border.Border blankBorder
- Fields inherited from class java.awt.Component
  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from class java.awt.Frame
  CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
- Fields inherited from class javax.swing.JFrame
  accessibleContext, rootPane, rootPaneCheckingEnabled
- Fields inherited from interface javax.swing.WindowConstants
  DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields
Modifier and Type	Field	Description
`protected javax.swing.border.Border`	`blankBorder`

Constructor Summary

Constructors
Constructor	Description
`QueryWindow(java.lang.String title, java.awt.Component parent)`	Constructs a new QueryWindow with OK and Cancel buttons.
`QueryWindow(java.lang.String title, java.awt.Component parent, boolean ok, boolean cancel)`	Constructs a new QueryWindow.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`javax.swing.JPanel`	`getAuxControlPanel()`	Returns a panel which can be used by subclasses to place custom controls.
`protected uk.ac.starlink.table.gui.LabelledComponentStack`	`getStack()`	Returns a stack of components suitable for adding new query boxes to.
`void`	`invokeCancel()`	Programatically push the Cancel button.
`void`	`invokeOK()`	Programatically push the OK button.
`protected abstract boolean`	`perform()`	This method will be invoked when the OK button is pushed or the user otherwise indicates that he has filled in the form.
`void`	`setVisible(boolean isVis)`	Override the setVisible method to perform some extra actions when the window is popped up on the first or subsequent occasions.

Methods inherited from class uk.ac.starlink.topcat.AuxWindow
addHelp, beep, confirm, createImportTableAction, createSaveTableAction, getBodyPanel, getControlPanel, getHelpMenu, getIconImage, getMainArea, getSponsorLogos, getToolBar, getWindowMenu, makeTitledBorder, makeVisible, placeProgressBar, positionAfter, recursiveSetEnabled, setBusy, setCloseIsExit, setMainHeading

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, toFront

- Field Detail
  - blankBorder
```
protected javax.swing.border.Border blankBorder
```
- Constructor Detail
  - QueryWindow
```
public QueryWindow(java.lang.String title,
                   java.awt.Component parent)
```
    Constructs a new QueryWindow with OK and Cancel buttons.
    
    Parameters:
    
    title - title to put in the window heading
    
    parent - parent component, used for positioning the window
  - QueryWindow
```
public QueryWindow(java.lang.String title,
                   java.awt.Component parent,
                   boolean ok,
                   boolean cancel)
```
    Constructs a new QueryWindow.
    
    Parameters:
    
    title - title to put in the window heading
    
    parent - parent component, used for positioning the window
    
    ok - whether to include an OK button
    
    cancel - whether to include a Cancel button
- Method Detail
  - perform
```
protected abstract boolean perform()
```
    This method will be invoked when the OK button is pushed or the user otherwise indicates that he has filled in the form.
    
    Returns:
    
    true if the action is complete in some sense. The window will be disposed if true is returned, otherwise it will remain posted.
  - getStack
```
protected uk.ac.starlink.table.gui.LabelledComponentStack getStack()
```
    Returns a stack of components suitable for adding new query boxes to.
    
    Returns:
    
    the stack
  - getAuxControlPanel
```
public javax.swing.JPanel getAuxControlPanel()
```
    Returns a panel which can be used by subclasses to place custom controls. The panel returned by AuxWindow.getControlPanel() is used for the OK and Cancel controls.
    
    Returns:
    
    a container for custom controls
  - invokeOK
```
public void invokeOK()
```
    Programatically push the OK button.
  - invokeCancel
```
public void invokeCancel()
```
    Programatically push the Cancel button.
  - setVisible
```
public void setVisible(boolean isVis)
```
    Override the setVisible method to perform some extra actions when the window is popped up on the first or subsequent occasions.
    
    Overrides:
    
    setVisible in class AuxWindow

Class QueryWindow

Nested Class Summary

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

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

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

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

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

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from class java.awt.Frame

Fields inherited from interface java.awt.image.ImageObserver

Fields inherited from class javax.swing.JFrame

Fields inherited from interface javax.swing.WindowConstants

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.topcat.AuxWindow

Methods inherited from class java.awt.Component

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Frame

Methods inherited from class javax.swing.JFrame

Methods inherited from interface java.awt.MenuContainer

Methods inherited from class java.lang.Object

Methods inherited from class java.awt.Window

Field Detail

blankBorder

Constructor Detail

QueryWindow

QueryWindow

Method Detail

perform

getStack

getAuxControlPanel

invokeOK

invokeCancel

setVisible