uk.ac.starlink.ast.gui

Class StringsControls

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

uk.ac.starlink.ast.gui.StringsControls

All Implemented Interfaces:

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

public class StringsControls
extends JPanel
implements PlotControls, ChangeListener

StringsControls creates a "page" of widgets that are a view of an AstStrings object. They provide the ability to configure all the properties of the AstStrings object (that describe how the any strings drawn in an AST plot should be rendered) and show a current rendering of what the text would look like.

Version:

$Id$

Author:

Peter W. Draper

See Also:

AstStrings, 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 AstStrings	astStrings AstStrings model for current state.
protected JButton	colourButton Colour button.
protected ColourIcon	colourIcon Colour Icon of colour button.
protected static String	defaultName The default short name for these controls.
protected static String	defaultTitle The default title for these controls.
protected FontControls	fontControls FontControls.
protected JLabel	sampleText The sample text field.

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
StringsControls(AbstractPlotControlsModel astStrings) Create an instance.

Method Summary

Modifier and Type	Method and Description
protected void	chooseColour() Choose a text colour.
AstStrings	getAstStrings() Get copy of reference to current AstStrings.
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).
protected void	initUI() Create and initialise the user interface.
void	reset() Reset controls to the defaults.
void	setAstStrings(AstStrings astStrings) Set the AstStrings object.
protected void	setTextColour(Color colour) Set the text colour.
protected void	setTextFont(Font font) Set the text font.
void	stateChanged(ChangeEvent e) If the AstStrings object changes then we need to update the interface.
protected void	updateFont(FontChangedEvent e) Update the displayed font.
protected void	updateFromAstStrings() Update interface to reflect values of the current AstStrings.

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

astStrings

protected AstStrings astStrings

AstStrings model for current state.

sampleText

protected JLabel sampleText

The sample text field.

colourButton

protected JButton colourButton

Colour button.

colourIcon

protected ColourIcon colourIcon

Colour Icon of colour button.

fontControls

protected FontControls fontControls

FontControls.

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

StringsControls

public StringsControls(AbstractPlotControlsModel astStrings)

Create an instance.

Method Detail

initUI

protected void initUI()

Create and initialise the user interface.

setAstStrings

public void setAstStrings(AstStrings astStrings)

Set the AstStrings object.

updateFromAstStrings

protected void updateFromAstStrings()

Update interface to reflect values of the current AstStrings.

getAstStrings

public AstStrings getAstStrings()

Get copy of reference to current AstStrings.

updateFont

protected void updateFont(FontChangedEvent e)

Update the displayed font.

setTextFont

protected void setTextFont(Font font)

Set the text font.

chooseColour

protected void chooseColour()

Choose a text colour.

setTextColour

protected void setTextColour(Color colour)

Set the text colour.

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 controls to the defaults.

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 AstStrings object changes then we need to update the interface.

Specified by:

stateChanged in interface ChangeListener