Package fr.esrf.tangoatk.widget.attribute

Class DigitalNumberScalarViewer

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
fr.esrf.tangoatk.widget.util.DigitalNumberViewer
fr.esrf.tangoatk.widget.attribute.DigitalNumberScalarViewer
All Implemented Interfaces:
fr.esrf.tangoatk.core.IAttributeStateListener, fr.esrf.tangoatk.core.IErrorListener, fr.esrf.tangoatk.core.INumberScalarListener, JDrawable, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener
public class DigitalNumberScalarViewer extends DigitalNumberViewer implements fr.esrf.tangoatk.core.INumberScalarListener, PropertyChangeListener, fr.esrf.tangoatk.core.IErrorListener, JDrawable
A class which displays a number scalar attribute. Here is an example of use: 
 fr.esrf.tangoatk.core.AttributeList attributeList = new
    fr.esrf.tangoatk.core.AttributeList();
 DigitalNumberScalarViewer dnsv = new DigitalNumberScalarViewer();
 INumberScalar model = (INumberScalar) attributeList.add("jlp/test/1/att_quatre");
 dnsv.setModel(model);
 attributeList.startRefresher();
See Also:

  • Constructor Details

    • DigitalNumberScalarViewer

      public DigitalNumberScalarViewer()
      Contructs a SimpleScalar viewer. Display a scalar atribute and its unit.

  • Method Details

    • getBackgroundColor

      public Color getBackgroundColor()
      Returns:
      the current background color of this viewer. Color used for the VALID attribute quality state

    • setBackgroundColor

      public void setBackgroundColor(Color bg)
      Sets the 'VALID' background color of this viewer. Color used for the VALID attribute quality state.
      Parameters:
      bg - Background color.
      See Also:

    • setUserFormat

      public void setUserFormat(String format)
      Overrides the format property of the attribute.
      Parameters:
      format - C like Format (ex: %5.2f) , null or "" to disable.

    • getUserFormat

      public String getUserFormat()
      Returns the user format.
      Returns:
      User format
      See Also:

    • 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 name)
      Description copied from interface: JDrawable
      Get a description of this extensions.
      Specified by:
      getDescription in interface JDrawable
      Parameters:
      name - 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.

    • numberScalarChange

      public void numberScalarChange(fr.esrf.tangoatk.core.NumberScalarEvent evt)
      Specified by:
      numberScalarChange in interface fr.esrf.tangoatk.core.INumberScalarListener

    • setAlarmEnabled

      public void setAlarmEnabled(boolean b)
      Enables or disables alarm background (represents the attribute quality factor).
      Parameters:
      b - True to enable alarm.
      See Also:

    • isAlarmEnabled

      public boolean isAlarmEnabled()
      Determines whether the background color is overrided by the quality factor.
      Returns:
      Alarm enabled flag
      See Also:

    • 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

    • propertyChange

      public void propertyChange(PropertyChangeEvent evt)
      Specified by:
      propertyChange in interface PropertyChangeListener

    • setModel

      public void setModel(fr.esrf.tangoatk.core.INumberScalar scalar)
      Sets the model for this viewer.
      Parameters:
      scalar - scalar model

    • clearModel

      public void clearModel()
      Clears all model and listener attached to the components

    • getModel

      public fr.esrf.tangoatk.core.INumberScalar getModel()

    • 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

    • getQualityInTooltip

      public boolean getQualityInTooltip()
      getQualityInTooltip returns true if the attribute quality factor is displayed inside the viewer's tooltip
      Returns:
      a boolean value

    • setQualityInTooltip

      public void setQualityInTooltip(boolean b)
      setQualityInTooltip display or not the attribute quality factor inside the tooltip
      Parameters:
      b - If True the attribute quality factor will be displayed inside the tooltip.

    • main

      public static void main(String[] args)
      Test function
      Parameters:
      args - Not used