uk.ac.starlink.ast.gui

Class GraphicsEdgesControls

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

uk.ac.starlink.ast.gui.GraphicsEdgesControls

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener, PlotControls

public class GraphicsEdgesControls
extends JPanel
implements PlotControls, ChangeListener

GraphicsEdgesControls creates a "page" of widgets that are a view of a GraphicsHints object. They provide the ability to configure all the properties of the object (i.e. whether the graphics are clipped and how much space to reserve for the labelling).

Version:

$Id$

Author:

Peter W. Draper

See Also:

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

Modifier and Type	Field and Description
protected JCheckBox	clip Whether graphics should be clipped.
protected static String	defaultName The default short name for these controls.
protected static String	defaultTitle The default title for these controls.
protected GraphicsEdges	edges GraphicsEdges model for current state.
protected ScientificSpinner	xLeft Spinner for controlling the space reserved for X labelling on left.
protected SpinnerNumberModel	xLeftModel Spinner model for X left fraction.
protected ScientificSpinner	xRight Spinner for controlling the space reserved for X labelling on right.
protected SpinnerNumberModel	xRightModel Spinner model for X right fraction.
protected ScientificSpinner	yBottom Spinner for controlling the space reserved for Y labelling at the bottom.
protected SpinnerNumberModel	yBottomModel Spinner model for Y bottom fraction.
protected ScientificSpinner	yTop Spinner for controlling the space reserved for Y labelling at the top.
protected SpinnerNumberModel	yTopModel Spinner model for Y top fraction.

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
GraphicsEdgesControls(AbstractPlotControlsModel edges) Create an instance.

Method Summary

Modifier and Type	Method and Description
JComponent	getControlsComponent() Return a reference to the JComponent sub-class that will be displayed (normally a reference to this).
AbstractPlotControlsModel	getControlsModel() Return reference to the AbstractPlotControlsModel.
static Class	getControlsModelClass() Return the class of object that we expect as our model.
String	getControlsName() Return a short name for these controls (for the tab).
String	getControlsTitle() Return a title for these controls (for the border).
GraphicsEdges	getGraphicsEdges() Get copy of reference to current GraphicsEdges
protected void	initUI() Create and initialise the user interface.
protected void	matchClip() Match whether to clip.
protected void	matchXLeft() Match left X label fraction.
protected void	matchXRight() Match right X label fraction.
protected void	matchYBottom() Match bottom Y label fraction.
protected void	matchYTop() Match top Y label fraction.
void	reset() Reset interface to default configuration.
void	setGraphicsEdges(GraphicsEdges edges) Set the GraphicsEdges object (only after UI is initiliased).
void	stateChanged(ChangeEvent e) If the GraphicsEdges object changes then we need to update the interface.
protected void	updateFromGraphicsEdges() Update interface to reflect values of GraphicsEdges 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, 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, 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, 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

Field Detail

edges

protected GraphicsEdges edges

GraphicsEdges model for current state.

clip

protected JCheckBox clip

Whether graphics should be clipped.

xLeft

protected ScientificSpinner xLeft

Spinner for controlling the space reserved for X labelling on left.

xRight

protected ScientificSpinner xRight

Spinner for controlling the space reserved for X labelling on right.

xLeftModel

protected SpinnerNumberModel xLeftModel

Spinner model for X left fraction.

xRightModel

protected SpinnerNumberModel xRightModel

Spinner model for X right fraction.

yTop

protected ScientificSpinner yTop

Spinner for controlling the space reserved for Y labelling at the top.

yBottom

protected ScientificSpinner yBottom

Spinner for controlling the space reserved for Y labelling at the bottom.

yTopModel

protected SpinnerNumberModel yTopModel

Spinner model for Y top fraction.

yBottomModel

protected SpinnerNumberModel yBottomModel

Spinner model for Y bottom fraction.

defaultTitle

protected static String defaultTitle

The default title for these controls.

defaultName

protected static String defaultName

The default short name for these controls.

Constructor Detail

GraphicsEdgesControls

public GraphicsEdgesControls(AbstractPlotControlsModel edges)

Create an instance.

Method Detail

initUI

protected void initUI()

Create and initialise the user interface.

setGraphicsEdges

public void setGraphicsEdges(GraphicsEdges edges)

Set the GraphicsEdges object (only after UI is initiliased).

updateFromGraphicsEdges

protected void updateFromGraphicsEdges()

Update interface to reflect values of GraphicsEdges object.

getGraphicsEdges

public GraphicsEdges getGraphicsEdges()

Get copy of reference to current GraphicsEdges

matchClip

protected void matchClip()

Match whether to clip.

matchXLeft

protected void matchXLeft()

Match left X label fraction.

matchXRight

protected void matchXRight()

Match right X label fraction.

matchYTop

protected void matchYTop()

Match top Y label fraction.

matchYBottom

protected void matchYBottom()

Match bottom Y label fraction.

getControlsTitle

public String getControlsTitle()

Return a title for these controls (for the border).

Specified by:

getControlsTitle in interface PlotControls

getControlsName

public String getControlsName()

Return a short name for these controls (for the tab).

Specified by:

getControlsName in interface PlotControls

reset

public void reset()

Reset interface to default configuration.

Specified by:

reset in interface PlotControls

getControlsComponent

public JComponent getControlsComponent()

Return a reference to the JComponent sub-class that will be displayed (normally a reference to this).

Specified by:

getControlsComponent in interface PlotControls

getControlsModel

public AbstractPlotControlsModel getControlsModel()

Return reference to the AbstractPlotControlsModel. This defines the actual state of the controls and stores the current values.

Specified by:

getControlsModel in interface PlotControls

getControlsModelClass

public static Class getControlsModelClass()

Return the class of object that we expect as our model.

stateChanged

public void stateChanged(ChangeEvent e)

If the GraphicsEdges object changes then we need to update the interface.

Specified by:

stateChanged in interface ChangeListener