public class StateViewer extends javax.swing.JPanel implements IDevStateScalarListener
State
State is a viewer to surveil and attribute of type DevState.
Normally one connects the device with the viewer like this:
IEntity ie =attributeList.add("mydeviceName/StateAtt"); // some method to obtain the state attribute.
DevStateScalar stateAtt = (DevStateScalar) stateAtt;
fr.esrf.tangoatk.widget.attribute.StateViewer statev = new StateViewer();
statev.setModel(stateAtt);
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
StateViewer() |
Modifier and Type | Method and Description |
---|---|
void |
clearModel() |
void |
devStateScalarChange(DevStateScalarEvent evt) |
void |
errorChange(ErrorEvent evt) |
java.lang.String |
getCurrentState()
getCurrentState |
java.lang.String |
getLabel() |
IDevStateScalar |
getModel()
getModel gets the model of this stateviewer. |
javax.swing.border.Border |
getStateBorder() |
java.awt.Font |
getStateFont() |
java.awt.Color |
getStateForeground() |
int |
getStateHorizontalAlignment() |
boolean |
getStateInTooltip()
getStateInTooltip returns true if the device state is displayed inside the viewer's tooltip |
java.awt.Dimension |
getStatePreferredSize() |
java.lang.String |
getStateText()
getStateText gets the text that is on the
colored state box |
boolean |
getUseDeviceAlias()
getUseDeviceAlias returns true if the device alias is displayed instead of device name |
boolean |
isLabelVisible()
isLabelVisible returns the visibility of the label |
boolean |
isStateVisible()
isStateVisible returns the visibility of the
state value label |
static void |
main(java.lang.String[] args) |
void |
setFont(java.awt.Font font) |
void |
setForeground(java.awt.Color color) |
void |
setLabel(java.lang.String label)
setLabel set the text of the label. |
void |
setLabelVisible(boolean visible)
setLabelVisisble makes the label visible or not. |
void |
setModel(IDevStateScalar stateAtt)
setModel sets the model of this viewer. |
void |
setStateBorder(javax.swing.border.Border border) |
void |
setStateFont(java.awt.Font font) |
void |
setStateForeground(java.awt.Color color) |
void |
setStateHorizontalAlignment(int i)
setStateHorizontalAlignement |
void |
setStateInTooltip(boolean b)
setStateInTooltip display or not the device state inside the tooltip |
void |
setStatePreferredSize(java.awt.Dimension dimension) |
void |
setStateText(java.lang.String text)
setStateText sets the text on the colored state box |
void |
setStateVisible(boolean visible)
setStateVisible makes the state value lable visible or not. |
void |
setUseDeviceAlias(boolean b)
setUseDeviceAlias use or not use device alias |
void |
stateChange(AttributeStateEvent e)
stateChange inherited from IAttributeStateListener called when the
attribute quality factor changes. |
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
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
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
public void clearModel()
public void setModel(IDevStateScalar stateAtt)
setModel
sets the model of this viewer.
If the textLabel property is not set, the name of the devState attribute is
shown on the textLabel.stateAtt
- a DevStateScalar
to surveilpublic IDevStateScalar getModel()
getModel
gets the model of this stateviewer.DevStateScalar
valuepublic void setLabel(java.lang.String label)
setLabel
set the text of the label. The
default value is to show the name of the devState attribute.label
- a String
valuepublic java.lang.String getLabel()
public void setLabelVisible(boolean visible)
setLabelVisisble
makes the label visible or not.visible
- a boolean
valuepublic boolean isLabelVisible()
isLabelVisible
returns the visibility of the labelboolean
valuepublic boolean getUseDeviceAlias()
getUseDeviceAlias
returns true if the device alias is displayed instead of device nameboolean
valuepublic void setUseDeviceAlias(boolean b)
setUseDeviceAlias
use or not use device aliasb
- True to enable the usage of device alias.public void setStateVisible(boolean visible)
setStateVisible
makes the state value lable visible or not.visible
- a boolean
valuepublic boolean isStateVisible()
isStateVisible
returns the visibility of the
state value labelboolean
valuepublic boolean getStateInTooltip()
getStateInTooltip
returns true if the device state is displayed inside the viewer's tooltipboolean
valuepublic void setStateInTooltip(boolean b)
setStateInTooltip
display or not the device state inside the tooltipb
- If True the device state will be displayed inside the tooltip.public void stateChange(AttributeStateEvent e)
stateChange
inherited from IAttributeStateListener called when the
attribute quality factor changes.stateChange
in interface IAttributeStateListener
e
- A AttributeStateEvent
valuepublic void devStateScalarChange(DevStateScalarEvent evt)
devStateScalarChange
in interface IDevStateScalarListener
public void errorChange(ErrorEvent evt)
errorChange
in interface IErrorListener
public java.lang.String getCurrentState()
getCurrentState
String
value presenting the current value of the DevStateScalar attributepublic void setStateText(java.lang.String text)
setStateText
sets the text on the colored state boxtext
- a String
valuepublic java.lang.String getStateText()
getStateText
gets the text that is on the
colored state boxString
valuepublic void setStateFont(java.awt.Font font)
public void setFont(java.awt.Font font)
setFont
in class javax.swing.JComponent
public java.awt.Font getStateFont()
public void setStateForeground(java.awt.Color color)
public java.awt.Color getStateForeground()
public void setForeground(java.awt.Color color)
setForeground
in class javax.swing.JComponent
public void setStateHorizontalAlignment(int i)
setStateHorizontalAlignement
i
- an int
valueSwingConstants
public int getStateHorizontalAlignment()
public void setStatePreferredSize(java.awt.Dimension dimension)
public java.awt.Dimension getStatePreferredSize()
public void setStateBorder(javax.swing.border.Border border)
public javax.swing.border.Border getStateBorder()
public static void main(java.lang.String[] args)