Package fr.esrf.tangoatk.widget.attribute

Class SignalScalarCheckBoxViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

javax.swing.JCheckBox

fr.esrf.tangoatk.widget.attribute.SignalScalarCheckBoxViewer

All Implemented Interfaces:

fr.esrf.tangoatk.core.IAttributeStateListener, fr.esrf.tangoatk.core.IBooleanScalarListener, fr.esrf.tangoatk.core.IErrorListener, fr.esrf.tangoatk.core.INumberScalarListener, fr.esrf.tangoatk.core.ISetErrorListener, JDrawable, ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

public class SignalScalarCheckBoxViewer
extends JCheckBox
implements ActionListener, fr.esrf.tangoatk.core.IBooleanScalarListener, fr.esrf.tangoatk.core.INumberScalarListener, fr.esrf.tangoatk.core.ISetErrorListener, JDrawable

A SignalScalarCheckBoxViewer is a viewer, represented as a CheckBox, for a signal attribute (this means an attribute representing a boolean value, but of type BooleanScalar or NumberScalar). The viewer is updated when the attribute value changes. The checkBox is "checked" if the attribute value is "true" or does not equal "0" and it is unchecked if the attribute value is "false" are equals "0".

Author:

GIRARDOT

See Also:

• Serialized Form

Nested Class Summary

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

JCheckBox.AccessibleJCheckBox

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

JToggleButton.AccessibleJToggleButton, JToggleButton.ToggleButtonModel

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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	Description
protected fr.esrf.tangoatk.core.IAttribute	attModel
protected Color	background
protected boolean	enabled
protected String[]	exts
protected String	falseLabel
protected String	fixedLabel
protected boolean	hasToolTip
protected boolean	qualityEnabled
protected String	trueLabel

Fields inherited from class javax.swing.JCheckBox

BORDER_PAINTED_FLAT_CHANGED_PROPERTY

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
SignalScalarCheckBoxViewer()
SignalScalarCheckBoxViewer(String title)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	booleanScalarChange(fr.esrf.tangoatk.core.BooleanScalarEvent e)
void	clearModel()
void	errorChange(fr.esrf.tangoatk.core.ErrorEvent evt)
fr.esrf.tangoatk.core.IAttribute	getAttModel()
JComponent	getComponent()
String	getDescription(String extName)	Get a description of this extensions.
String	getExtendedParam(String name)	Returns the specified parameter value.
String[]	getExtensionList()
String	getFalseLabel()
boolean	getHasToolTip()	getHasToolTip returns true if the viewer has a tooltip (attribute full name)
boolean	getQualityEnabled()	getQualityEnabled returns a boolean to know whether quality will be displayed as background or not.
String	getTrueLabel()
void	initForEditing()	Call after a component of a JDSwingObject is created, this give a default look and feel for editing.
static void	main(String[] args)
void	numberScalarChange(fr.esrf.tangoatk.core.NumberScalarEvent e)
void	setBackground(Color bg)
void	setBooleanScalarModel(fr.esrf.tangoatk.core.IBooleanScalar boolModel)
protected void	setBoolValue(boolean val)
protected void	setBoolValue(double val)
void	setEnabled(boolean b)
void	setErrorOccured(fr.esrf.tangoatk.core.ErrorEvent evt)
boolean	setExtendedParam(String name, String value, boolean popupErr)	Sets the specified param.
void	setFalseLabel(String fLabel)
void	setHasToolTip(boolean b)	setHasToolTip display or not a tooltip for this viewer
void	setNumberScalarModel(fr.esrf.tangoatk.core.INumberScalar numModel)
void	setQualityEnabled(boolean b)	setQualityEnabled view or not the attribute quality for this viewer
void	setTrueLabel(String tLabel)
void	stateChange(fr.esrf.tangoatk.core.AttributeStateEvent evt)

Methods inherited from class javax.swing.JCheckBox

getAccessibleContext, getUIClassID, isBorderPaintedFlat, paramString, setBorderPaintedFlat, updateUI

Methods inherited from class javax.swing.JToggleButton

requestFocus, requestFocusInWindow

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, 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, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

attModel

protected fr.esrf.tangoatk.core.IAttribute attModel

trueLabel

protected String trueLabel

falseLabel

protected String falseLabel

fixedLabel

protected String fixedLabel

hasToolTip

protected boolean hasToolTip

qualityEnabled

protected boolean qualityEnabled

background

protected Color background

exts

protected String[] exts

enabled

protected boolean enabled

Constructor Details

SignalScalarCheckBoxViewer

public SignalScalarCheckBoxViewer()

SignalScalarCheckBoxViewer

public SignalScalarCheckBoxViewer(String title)

Method Details

getAttModel

public fr.esrf.tangoatk.core.IAttribute getAttModel()

setBooleanScalarModel

public void setBooleanScalarModel(fr.esrf.tangoatk.core.IBooleanScalar boolModel)

setNumberScalarModel

public void setNumberScalarModel(fr.esrf.tangoatk.core.INumberScalar numModel)

clearModel

public void clearModel()

getTrueLabel

public String getTrueLabel()

setTrueLabel

public void setTrueLabel(String tLabel)

getFalseLabel

public String getFalseLabel()

setFalseLabel

public void setFalseLabel(String fLabel)

getHasToolTip

public boolean getHasToolTip()

getHasToolTip returns true if the viewer has a tooltip (attribute full name)

Returns:

a boolean value

setHasToolTip

public void setHasToolTip(boolean b)

setHasToolTip display or not a tooltip for this viewer

Parameters:

b - If True the attribute full name will be displayed as tooltip for the viewer

getQualityEnabled

public boolean getQualityEnabled()

getQualityEnabled returns a boolean to know whether quality will be displayed as background or not.

Returns:

a boolean value

setQualityEnabled

public void setQualityEnabled(boolean b)

setQualityEnabled view or not the attribute quality for this viewer

Parameters:

b - If True the background Color represents the attribute quality factor

initForEditing

public void initForEditing()

Description copied from interface: JDrawable

Call after a component of a JDSwingObject is created, this give a default look and feel for editing.

Specified by:

initForEditing in interface JDrawable

getComponent

public JComponent getComponent()

Specified by:

getComponent in interface JDrawable

Returns:

the JComponent that implements this interface.

getDescription

public String getDescription(String extName)

Description copied from interface: JDrawable

Get a description of this extensions.

Specified by:

getDescription in interface JDrawable

Parameters:

extName - Extension name

Returns:

Empty string for no description.

getExtensionList

public String[] getExtensionList()

Specified by:

getExtensionList in interface JDrawable

Returns:

list of extension name for this objects (Empty array for none).

setExtendedParam

public boolean setExtendedParam(String name,
 String value,
 boolean popupErr)

Description copied from interface: JDrawable

Sets the specified param.

Specified by:

setExtendedParam in interface JDrawable

Parameters:

name - Parameter name (Case unsensitive).

value - Parameter value.

popupErr - true when the JDrawable should display a popup if the parameter value is incorrect, false otherwise. Note that the JDrawable must not display an error message if the parameter does not exists even if popupAllowed is true.

Returns:

true if parameters has been succesfully applied, false otherwise.

getExtendedParam

public String getExtendedParam(String name)

Description copied from interface: JDrawable

Returns the specified parameter value.

Specified by:

getExtendedParam in interface JDrawable

Parameters:

name - Param name (Case unsensitive).

Returns:

Empty string if not exists, the value otherwise.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

booleanScalarChange

public void booleanScalarChange(fr.esrf.tangoatk.core.BooleanScalarEvent e)

Specified by:

booleanScalarChange in interface fr.esrf.tangoatk.core.IBooleanScalarListener

numberScalarChange

public void numberScalarChange(fr.esrf.tangoatk.core.NumberScalarEvent e)

Specified by:

numberScalarChange in interface fr.esrf.tangoatk.core.INumberScalarListener

stateChange

public void stateChange(fr.esrf.tangoatk.core.AttributeStateEvent evt)

Specified by:

stateChange in interface fr.esrf.tangoatk.core.IAttributeStateListener

errorChange

public void errorChange(fr.esrf.tangoatk.core.ErrorEvent evt)

Specified by:

errorChange in interface fr.esrf.tangoatk.core.IErrorListener

setBoolValue

protected void setBoolValue(boolean val)

setBoolValue

protected void setBoolValue(double val)

setErrorOccured

public void setErrorOccured(fr.esrf.tangoatk.core.ErrorEvent evt)

Specified by:

setErrorOccured in interface fr.esrf.tangoatk.core.ISetErrorListener

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class AbstractButton

main

public static void main(String[] args)