xal.extension.widgets.swing

Class Wheelswitch

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

xal.extension.widgets.swing.Wheelswitch

All Implemented Interfaces:

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

public class Wheelswitch
extends javax.swing.JPanel

Descedant of javax.swing.JPanel that contains a row of digits and optionally a two way up-down button. It can be used for displaying and modifying a single formatted double value with an optional unit string (also in digits) displyed next to the value. Value manipulation and display formatting is handled by the WheelswitchFormatter.

See Also:

UpDownButton, Digit, WheelswitchFormatter, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Wheelswitch.FocusHandler
protected class	Wheelswitch.KeyHandler
protected class	Wheelswitch.MouseHandler
protected class	Wheelswitch.MouseWheelHandler
protected class	Wheelswitch.TiltHandler
protected class	Wheelswitch.UpDownActionHandler

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DECREASE_SELECTION
static java.lang.String	EDITABLE DOCUMENT ME!
protected Wheelswitch.FocusHandler	focusHandler
protected static int	INCREASE_SELECTION
protected Wheelswitch.KeyHandler	keyHandler
protected Wheelswitch.MouseHandler	mouseHandler
protected Wheelswitch.TiltHandler	tiltHandler
static java.lang.String	VALUE DOCUMENT ME!

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
Wheelswitch() Constructor for Wheelswitch which sets no format or unit and the value is set to zero.
Wheelswitch(double newValue) Constructor for Wheelswitch setting only the value.
Wheelswitch(java.lang.String newFormat, double newValue, java.lang.String newUnit) Constructor for Wheelswitch creates a new Wheelswitch with the specified value, format and unit.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormat() Gets the format of the display.
double	getGraphMax() Gets the maximum alowed value.
double	getGraphMin() Gets the minimum alowed value.
java.awt.Dimension	getMinimumSize() This method has been overriden to implement correct layout and resizing features.
java.awt.Dimension	getPreferredSize() This method has been overriden to implement correct layout and resizing features.
protected int	getSelectedDigit()
java.lang.String	getUnit() Gets the unit displayed next to the value.
double	getValue() Gets the value displayed by the Wheelswitch and stored by the formatter.
protected void	initDigits()
boolean	isEditable() Returns whether the wheelswitch can be edited by the user.
boolean	isEnhanced() Gets the enhancement mode of the Wheelswitch.
boolean	isTiltingEnabled() Returns whether the component should indicate value out of bounds condition by visually tilting its border.
protected void	setDigitValue(int i, int newValue)
void	setEditable(boolean newEditable) Sets the editability of the wheelswitch.
void	setEnabled(boolean arg0) Overriden to implement digit and upDownButton enabling/disabling.
void	setEnhanced(boolean enhanced) Sets the enhanced property of the wheelswitch.
void	setFormat(java.lang.String newFormat) Sets the format of the value display.
void	setGraphMax(double newValue) Sets the maximum allowed value.
void	setGraphMin(double newValue) Sets the minimum allowed value.
void	setMaximumDigits(int bound) Sets the maximum number of value digits allowed to be displayed in the wheelswitch.
void	setMaxMin(double max, double min) Sets the maximum and minimum allowed values.
protected void	setSelectedDigit(int i)
void	setTiltingEnabled(boolean b) Sets the tilitng enabled property.
void	setUnit(java.lang.String newUnit) Sets the unit to be displayed next to the value.
void	setValue(double newValue) Sets the value and displays it in the wheelswitch.

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, getNextFocusableComponent, getPopupLocation, 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, 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

INCREASE_SELECTION

protected static int INCREASE_SELECTION

DECREASE_SELECTION

protected static int DECREASE_SELECTION

VALUE

public static final java.lang.String VALUE

DOCUMENT ME!

See Also:

Constant Field Values

EDITABLE

public static final java.lang.String EDITABLE

DOCUMENT ME!

See Also:

Constant Field Values

focusHandler

protected Wheelswitch.FocusHandler focusHandler

keyHandler

protected Wheelswitch.KeyHandler keyHandler

mouseHandler

protected Wheelswitch.MouseHandler mouseHandler

tiltHandler

protected Wheelswitch.TiltHandler tiltHandler

Constructor Detail

Wheelswitch

public Wheelswitch(java.lang.String newFormat,
                   double newValue,
                   java.lang.String newUnit)

Constructor for Wheelswitch creates a new Wheelswitch with the specified value, format and unit. No minimum or maximum values are set.

Parameters:

newFormat -

newValue -

newUnit -

Wheelswitch

public Wheelswitch(double newValue)

Constructor for Wheelswitch setting only the value. No format or unit are set.

Parameters:

newValue -

See Also:

Wheelswitch(String, double, String)

Wheelswitch

public Wheelswitch()

Constructor for Wheelswitch which sets no format or unit and the value is set to zero.

See Also:

Wheelswitch(String, double, String)

Method Detail

setEditable

public void setEditable(boolean newEditable)

Sets the editability of the wheelswitch.

Parameters:

newEditable -

isEditable

public boolean isEditable()

Returns whether the wheelswitch can be edited by the user.

Returns:

boolean

setEnhanced

public void setEnhanced(boolean enhanced)

Sets the enhanced property of the wheelswitch. When enhanced the wheelswitch animates its digits when changing the value displayed.

See Also:

Digit.setEnhanced(boolean)

isEnhanced

public boolean isEnhanced()

Gets the enhancement mode of the Wheelswitch.

Returns:

DOCUMENT ME!

setFormat

public void setFormat(java.lang.String newFormat)

Sets the format of the value display. Format style is Wheelswitch specific.

Parameters:

newFormat -

Throws:

java.lang.NullPointerException - DOCUMENT ME!

See Also:

WheelswitchFormatter.setFormat(String)

getFormat

public java.lang.String getFormat()

Gets the format of the display.

Returns:

java.lang.String

See Also:

WheelswitchFormatter.getFormat()

setGraphMax

public void setGraphMax(double newValue)

Sets the maximum allowed value.

Parameters:

newValue -

See Also:

WheelswitchFormatter.setMaximum(double)

getGraphMax

public double getGraphMax()

Gets the maximum alowed value.

Returns:

double

See Also:

WheelswitchFormatter.getMaximum()

setGraphMin

public void setGraphMin(double newValue)

Sets the minimum allowed value.

Parameters:

newValue -

See Also:

WheelswitchFormatter.setMinimum(double)

getGraphMin

public double getGraphMin()

Gets the minimum alowed value.

Returns:

double

See Also:

WheelswitchFormatter.getMaximum()

setMaxMin

public void setMaxMin(double max,
                      double min)

Sets the maximum and minimum allowed values.

Parameters:

max -

min -

getMinimumSize

public java.awt.Dimension getMinimumSize()

This method has been overriden to implement correct layout and resizing features.

Overrides:

getMinimumSize in class javax.swing.JComponent

See Also:

Component.getMinimumSize()

getPreferredSize

public java.awt.Dimension getPreferredSize()

This method has been overriden to implement correct layout and resizing features.

Overrides:

getPreferredSize in class javax.swing.JComponent

See Also:

Component.getPreferredSize()

setTiltingEnabled

public void setTiltingEnabled(boolean b)

Sets the tilitng enabled property.

Parameters:

b - whether the component should tilt when value is out of bounds.

isTiltingEnabled

public boolean isTiltingEnabled()

Returns whether the component should indicate value out of bounds condition by visually tilting its border.

Returns:

boolean

setUnit

public void setUnit(java.lang.String newUnit)

Sets the unit to be displayed next to the value.

Parameters:

newUnit -

See Also:

WheelswitchFormatter.setUnit(String)

getUnit

public java.lang.String getUnit()

Gets the unit displayed next to the value.

Returns:

java.lang.String

See Also:

WheelswitchFormatter.getUnit()

setValue

public void setValue(double newValue)

Sets the value and displays it in the wheelswitch. The method may also change the current digit selection if neccessary in order to point to the same decimal digit of the displayed value.

Parameters:

newValue -

See Also:

WheelswitchFormatter.setValue(double)

getValue

public double getValue()

Gets the value displayed by the Wheelswitch and stored by the formatter.

Returns:

double

See Also:

WheelswitchFormatter.getValue()

setEnabled

public void setEnabled(boolean arg0)

Overriden to implement digit and upDownButton enabling/disabling.

Overrides:

setEnabled in class javax.swing.JComponent

See Also:

Component.setEnabled(boolean)

setMaximumDigits

public void setMaximumDigits(int bound)

Sets the maximum number of value digits allowed to be displayed in the wheelswitch. The default value is 0 and is ignored.

Parameters:

bound - is ignored if less or equal zero.

setDigitValue

protected void setDigitValue(int i,
                             int newValue)

setSelectedDigit

protected void setSelectedDigit(int i)

getSelectedDigit

protected int getSelectedDigit()

initDigits

protected void initDigits()