fr.esrf.tangoatk.widget.attribute
Class BooleanScalarCheckBoxViewer

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.BooleanScalarCheckBoxViewer

All Implemented Interfaces:

IAttributeStateListener, IBooleanScalarListener, IErrorListener, ISetErrorListener, JDrawable, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.SwingConstants

Direct Known Subclasses:

NumberScalarCheckBoxViewer

public class BooleanScalarCheckBoxViewer
extends javax.swing.JCheckBox
implements java.awt.event.ActionListener, IBooleanScalarListener, ISetErrorListener, JDrawable

An BooleanScalarCheckBoxViewer is a BooleanScalar attribute viewer. This means that the attribute used as the model for this viewer should implement the IBooleanScalar interface. The viewer is updated when the boolean attribute value changes. The checkBox is "checked" if the attribute value is "true" and it is unchecked if the attribute value is "false".

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JCheckBox.AccessibleJCheckBox

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

javax.swing.JToggleButton.AccessibleJToggleButton, javax.swing.JToggleButton.ToggleButtonModel

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

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BooleanScalarCheckBoxViewer()

BooleanScalarCheckBoxViewer(java.lang.String title)

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
void	booleanScalarChange(BooleanScalarEvent e)
void	clearModel()
void	errorChange(ErrorEvent evt)
IBooleanScalar	getAttModel()
javax.swing.JComponent	getComponent() Returns the JComponent that implements this interface.
java.lang.String	getDescription(java.lang.String extName) Get a description of this extensions.
java.lang.String	getExtendedParam(java.lang.String name) Returns the specified parameter value.
java.lang.String[]	getExtensionList() Returns list of extension name for this objects (Empty array for none).
java.lang.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.
java.lang.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(java.lang.String[] args)
void	setAttModel(IBooleanScalar boolModel)
void	setBackground(java.awt.Color bg)
protected void	setBoolValue(boolean val)
void	setEnabled(boolean b)
void	setErrorOccured(ErrorEvent evt)
boolean	setExtendedParam(java.lang.String name, java.lang.String value, boolean popupErr) Sets the specified param.
void	setFalseLabel(java.lang.String fLabel)
void	setHasToolTip(boolean b) setHasToolTip display or not a tooltip for this viewer
void	setQualityEnabled(boolean b) setQualityEnabled view or not the attribute quality for this viewer
void	setTrueLabel(java.lang.String tLabel)
void	stateChange(AttributeStateEvent evt)

Methods inherited from class javax.swing.JCheckBox

configurePropertiesFromAction, createActionPropertyChangeListener, getAccessibleContext, getUIClassID, isBorderPaintedFlat, paramString, setBorderPaintedFlat, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, 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, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, 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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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, 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, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanScalarCheckBoxViewer

public BooleanScalarCheckBoxViewer()

BooleanScalarCheckBoxViewer

public BooleanScalarCheckBoxViewer(java.lang.String title)

Method Detail

getAttModel

public IBooleanScalar getAttModel()

setAttModel

public void setAttModel(IBooleanScalar boolModel)

getTrueLabel

public java.lang.String getTrueLabel()

setTrueLabel

public void setTrueLabel(java.lang.String tLabel)

getFalseLabel

public java.lang.String getFalseLabel()

setFalseLabel

public void setFalseLabel(java.lang.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 attribute full name will be displayed as tooltip for the viewer

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

clearModel

public void clearModel()

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 javax.swing.JComponent getComponent()

Description copied from interface: JDrawable

Returns the JComponent that implements this interface.

Specified by:

getComponent in interface JDrawable

getDescription

public java.lang.String getDescription(java.lang.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 java.lang.String[] getExtensionList()

Description copied from interface: JDrawable

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

Specified by:

getExtensionList in interface JDrawable

setExtendedParam

public boolean setExtendedParam(java.lang.String name,
                                java.lang.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 java.lang.String getExtendedParam(java.lang.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(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

booleanScalarChange

public void booleanScalarChange(BooleanScalarEvent e)

Specified by:

booleanScalarChange in interface IBooleanScalarListener

stateChange

public void stateChange(AttributeStateEvent evt)

Specified by:

stateChange in interface IAttributeStateListener

errorChange

public void errorChange(ErrorEvent evt)

Specified by:

errorChange in interface IErrorListener

setBoolValue

protected void setBoolValue(boolean val)

setErrorOccured

public void setErrorOccured(ErrorEvent evt)

Specified by:

setErrorOccured in interface ISetErrorListener

setBackground

public void setBackground(java.awt.Color bg)

Overrides:

setBackground in class javax.swing.JComponent

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class javax.swing.AbstractButton

main

public static void main(java.lang.String[] args)