uk.ac.starlink.util.gui
Class StoreControlFrame

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by uk.ac.starlink.util.gui.StoreControlFrame
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class StoreControlFrame
extends JFrame

A top-level window that offers controls for saving, restoring and deleting configuration data stored in XML files. The configurations are stored in a permanent file which has each configuration characterised by a description (created by the user) and a date that the configuration was created (or maybe last updated).

An instance of this class should be associated with a SourceSource implementation that acts as a view for the restored configuration and a model for the current configuration. The actual interaction with the XML store is performed by a StoreConfiguration object.

Version:
$Id$
Author:
Peter W. Draper
See Also:
StoreConfiguration, StoreSource, Serialized Form

Nested Class Summary
protected  class StoreControlFrame.AddAction
          Inner class defining action to create a new configuration entry adding the current configuration to it.
protected  class StoreControlFrame.CloseAction
          Inner class defining Action for closing window and keeping fit.
protected  class StoreControlFrame.DeleteAction
          Inner class defining action to delete the selected configuration entries.
protected  class StoreControlFrame.RestoreAction
          Inner class defining Action for closing window and keeping fit.
protected  class StoreControlFrame.UpdateAction
          Inner class defining action to update a configuration entry.
 
Nested classes/interfaces inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame
 
Nested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
 
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
protected  JPanel actionBar
          Action buttons container.
protected  JPanel contentPane
          Content pane of frame.
protected  JMenu fileMenu
           
protected  JMenuBar menuBar
          Menubar and various menus and items that it contains.
protected  JTable statusTable
          The table showing the stored configurations.
protected  JPanel statusView
          Container for view of currently saved states.
protected  StoreConfiguration store
          Object that mediates to the actual store.
protected  StoreSource storeSource
          The StoreSource object, this understands the configuration data and how to encode and decode it from XML.
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
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 class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
StoreControlFrame(StoreSource storeSource)
          Create an instance.
 
Method Summary
protected  void closeWindowEvent()
          Close the window.
 void deleteSelectedConfigurations()
          Delete all the selected configurations, or none if none are selected.
protected  void initFrame()
          Initialise frame properties (disposal, title, menus etc.).
protected  void initMenus()
          Initialise the menu bar, action bar and related actions.
protected  void initUI()
          Initialise the user interface.
 void restoreSelectedConfiguration()
          Restore the selected configuration, if any.
 void storeCurrentConfiguration()
          Create a new configuration entry and store the current configuration in it.
 void updateCurrentConfiguration()
          Update the current configuration.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, toFront
 
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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

contentPane

protected JPanel contentPane
Content pane of frame.


actionBar

protected JPanel actionBar
Action buttons container.


statusView

protected JPanel statusView
Container for view of currently saved states.


statusTable

protected JTable statusTable
The table showing the stored configurations.


storeSource

protected StoreSource storeSource
The StoreSource object, this understands the configuration data and how to encode and decode it from XML.


store

protected StoreConfiguration store
Object that mediates to the actual store.


menuBar

protected JMenuBar menuBar
Menubar and various menus and items that it contains.


fileMenu

protected JMenu fileMenu
Constructor Detail

StoreControlFrame

public StoreControlFrame(StoreSource storeSource)
Create an instance.

Method Detail

initMenus

protected void initMenus()
Initialise the menu bar, action bar and related actions.


initFrame

protected void initFrame()
Initialise frame properties (disposal, title, menus etc.).


initUI

protected void initUI()
Initialise the user interface. This is the action bar and the status view.


closeWindowEvent

protected void closeWindowEvent()
Close the window.


storeCurrentConfiguration

public void storeCurrentConfiguration()
Create a new configuration entry and store the current configuration in it.


updateCurrentConfiguration

public void updateCurrentConfiguration()
Update the current configuration.


deleteSelectedConfigurations

public void deleteSelectedConfigurations()
Delete all the selected configurations, or none if none are selected.


restoreSelectedConfiguration

public void restoreSelectedConfiguration()
Restore the selected configuration, if any.



Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.