uk.ac.starlink.table.gui.TableLoadPanel

All Implemented Interfaces:: ImageObserver, MenuContainer, Serializable, Accessible

public abstract class TableLoadPanel extends JPanel

Component which aggregates a TableLoadDialog and buttons (OK and Cancel) to control it. The utility method (loadTables is a convenient way to do synchronous table loading.

Concrete implementations of this abstract class must implement the getLoadClient() method to determine how loaded tables will be consumed.

Since:

13 Sept 2010

Author:

Mark Taylor

See Also:

Nested Class Summary

Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container
Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Field Summary

Fields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor Summary

Constructors

Constructor

Description

TableLoadPanel(TableLoadDialog tld, StarTableFactory tfact)

Constructor.
Method Summary

Modifier and Type

Method

Description

Action

getCancelAction()

Returns the action which cancels a load in progress.

protected abstract TableLoadClient

getLoadClient()

Returns a GUI consumer for any tables loaded by this panel.

Action

getOkAction()

Returns the action which starts to load tables.

JProgressBar

getProgressBar()

Returns the progress bar used by this panel.

boolean

isLoading()

Indicates whether a load is currently in progress.

static StarTable

loadTable(Component parent, TableLoadDialog tld, StarTableFactory tfact)

Displays a modal load dialogue to load a single table, and returns the tables it has loaded when finished.

static StarTable[]

loadTables(Component parent, TableLoadDialog tld, StarTableFactory tfact)

Displays a modal load dialogue to load (possibly) multiple tables, and returns the tables it has loaded when finished.

static void

main(String[] args)

Test method.

void

setProgressBar(JProgressBar progBar)

Sets the progress bar used by this panel.

Methods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class 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 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, transferFocusDownCycle, validate, validateTree

Methods inherited from class 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 Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- TableLoadPanel
  
  public TableLoadPanel(TableLoadDialog tld, StarTableFactory tfact)
  
  Constructor.
  
  Parameters:
  
  tld - load dialogue
  
  tfact - representative table factory (not necessarily the one used to create tables)
Method Details
- getLoadClient
  
  protected abstract TableLoadClient getLoadClient()
  
  Returns a GUI consumer for any tables loaded by this panel. It will be called once for each load sequence; the returned object may or may not be the same one each time.
  
  Returns:
  
  load client ready to accept tables
- getOkAction
  
  public Action getOkAction()
  
  Returns the action which starts to load tables.
  
  Returns:
  
  OK action
- getCancelAction
  
  public Action getCancelAction()
  
  Returns the action which cancels a load in progress.
  
  Returns:
  
  Cancel action
- isLoading
  
  public boolean isLoading()
  
  Indicates whether a load is currently in progress.
  
  Returns:
  
  true iff loading is taking place
- getProgressBar
  
  public JProgressBar getProgressBar()
  
  Returns the progress bar used by this panel.
  
  Returns:
  
  progress bar
- setProgressBar
  
  public void setProgressBar(JProgressBar progBar)
  
  Sets the progress bar used by this panel.
  
  Parameters:
  
  progBar - progress bar
- loadTable
  
  public static StarTable loadTable(Component parent, TableLoadDialog tld, StarTableFactory tfact) throws IOException
  
  Displays a modal load dialogue to load a single table, and returns the tables it has loaded when finished.
  
  Parameters:
  
  parent - parent component
  
  tld - load dialogue
  
  tfact - table factory
  
  Throws:
  
  IOException
- loadTables
  
  public static StarTable[] loadTables(Component parent, TableLoadDialog tld, StarTableFactory tfact) throws IOException
  
  Displays a modal load dialogue to load (possibly) multiple tables, and returns the tables it has loaded when finished.
  
  Parameters:
  
  parent - parent component
  
  tld - load dialogue
  
  tfact - table factory
  
  Throws:
  
  IOException
- main
  
  public static void main(String[] args) throws IOException
  
  Test method. Posts a file load dialogue and summarises any tables that were loaded.
  
  Throws:
  
  IOException

Class TableLoadPanel

Nested Class Summary

Nested classes/interfaces inherited from class JPanel

Nested classes/interfaces inherited from class JComponent

Nested classes/interfaces inherited from class Container

Nested classes/interfaces inherited from class Component

Field Summary

Fields inherited from class JComponent

Fields inherited from class Component

Fields inherited from interface ImageObserver

Constructor Summary

Method Summary

Methods inherited from class JPanel

Methods inherited from class JComponent

Methods inherited from class Container

Methods inherited from class Component

Methods inherited from class Object

Constructor Details

TableLoadPanel

Method Details

getLoadClient

getOkAction

getCancelAction

isLoading

getProgressBar

setProgressBar

loadTable

loadTables

main