DESY ACOP Beans Home

com.cosylab.gui
Class CheckBoxController

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JToggleButton
                      javax.swing.JCheckBox
                          com.cosylab.gui.CheckBoxController

All Implemented Interfaces:

PopupManageable, CommonDisplayer, ConvertibleDisplayer, DataConsumer, DataSource, DataStateProvider, Displayer, DoubleConsumer, DoubleDisplayer, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

Direct Known Subclasses:

AcopCheckBox

public class CheckBoxController
extends javax.swing.JCheckBox
implements DoubleDisplayer, DataSource, ConvertibleDisplayer

CheckBox for displaying and switching double properties between two values. To set the values, see methods setSelectedValue(Number) and setDeselectedValue(Number).

Author:

Blaz Hostnik, Cosylab

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

Field Summary

protected static java.lang.String	DEFAULT_TEXT
static java.lang.String	DESELECTED_VALUE This value is going to be set to consumers when CheckBox is deselected.
static java.lang.String	SELECTED_VALUE This value is going to be set to consumers when CheckBox is selected.

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 com.cosylab.gui.displayers.ConvertibleDisplayer

CONVERTER_PROPERTY

Fields inherited from interface com.cosylab.gui.displayers.Displayer

C_EDITABLE, DATA_SOURCE

Fields inherited from interface com.cosylab.gui.displayers.CommonDisplayer

C_BIT_DESCRIPTIONS, C_BIT_MASK, C_COLOR, C_CONDITION_WHEN_CLEARED, C_CONDITION_WHEN_SET, C_DESCRIPTION, C_DISPLAY_NAME, C_FORMAT, C_GRAPH_MAX, C_GRAPH_MIN, C_MAXIMUM, C_MIN_STEP, C_MINIMUM, C_POSITION, C_PROPERTY_TYPE, C_SEQUENCE_LENGTH, C_UNITS

Fields inherited from interface com.cosylab.gui.displayers.DataStateProvider

DATA_STATE

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

CheckBoxController()
Default constructor: with DEFAULT_TEXT text in front of the check box.

CheckBoxController(java.lang.String text)
Constructor with parameters.

Method Summary

void	addConsumer(DataConsumer consumer) Accepts only consumers, which support NonblockingNumberConsumer which is used for receiving updates from user.
void	cleanup() Performs general cleanup of displayer resources.
java.lang.Class<DataConsumer>[]	getAcceptableConsumerTypes() Returns the array of consumer types, which are acceptable by this data source.
DataConsumer[]	getConsumers() Returns array of registered data consumer.
Converter	getConverter() Returns the converter that is used with the displayer.
protected AbstractCustomizerPanel	getCustomizer()
DataConsumer	getDataConsumer(java.lang.Class type) Returns data consumer for requested data consumer type.
DataSource	getDataSource() Returns data source.
DataState	getDataState() Returns data quality state.
DataConsumer	getDefaultDataConsumer() Returns the implementation of default consumer type supported by this data consumer.
java.lang.Number	getDeselectedValue() Get the value that will be set on consumers, when the CheckBox will be deselected.
java.lang.String	getFormat() Returns the C-style format string that is used to format the double value into text, if the displayer must perform such rendition.
protected javax.swing.JDialog	getInfoDialog()
double	getMaximum() Returns the upper limit for the value used to render the display.
double	getMinimum() Returns the lower limit for the value used to render the display.
PopupManager	getPopupManager() Returns popup manager, which manages popup menu.
java.lang.Number	getSelectedValue() Get the value that will be set on consumers, when the CheckBox will be selected.
java.lang.String[]	getSupportedCharacteristics() Resturns array with names of supported characteristics.
java.lang.Class<DataConsumer>[]	getSupportedConsumerTypes() Returns array of supported data consumer types, which can be used as parameter and returnned with getDataCosnumer(Class) method.
java.lang.String	getTitle() Returns the title of this displayer.
java.lang.String	getUnits() Returns the physical units of this value represented by a string.
double	getValue() Gets the value displayed by the displayer.
protected void	initialize()
protected void	internalSetTitle()
boolean	isEditable() Returns true if this displayer can interact with user and fire value updates requested by user.
boolean	isPopupEnabled() Return true if the popup menu is enabled or false otherwise.
boolean	isSuspended() Returns true if GUI updates are suspended.
void	removeAllConsumers() Removes all consumers from data source and releases all resources and bindings allocated inside datasource to the consumers.
void	removeConsumer(DataConsumer consumer) Deregisters data consumer from this data source.
void	resume() Resumes updates of GUI component.
void	setCharacteristics(java.util.Map characteristics) Sets new dynamic value characteristics to this data consumer.
void	setConverter(Converter converter) Sets the Converter that is used when displaying value with this.
void	setDataSource(DataSource dataSource) Sets data source and registeres this displayer as data consumer.
void	setDeselectedValue(java.lang.Number value) Set the value that will be set on consumers, when the CheckBox will be deselected.
void	setFormat(java.lang.String value) Sets the C printf style format specification used to render double value into a String.
void	setMaximum(double value) Sets the maximum value used for displaying in range.
void	setMinimum(double value) Sets the minimum value used for displaying in range.
void	setPopupEnabled(boolean enabled) Enables or disables the popup menu.
void	setSelectedValue(java.lang.Number value) Set the value that will be set on consumers, when the CheckBox will be selected.
void	setTitle(java.lang.String value) Sets the title of this displayer.
void	setUnits(java.lang.String value) Sets the physical units for this value.
void	setValue(double val) Sets the value displayed by the displayer.
void	suspend() Suspends all updates of displayer.
void	updateDataState(DataState state) Push data state (quality) update change for dynamic value.
void	updateValue(long timestamp, double value) Notifys this consumer about new dynamic value update.

Methods inherited from class javax.swing.JCheckBox

getAccessibleContext, getUIClassID, isBorderPaintedFlat, paramString, setBorderPaintedFlat, updateUI

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, setEnabled, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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

Methods inherited from interface com.cosylab.gui.displayers.DataConsumer

getName

Methods inherited from interface com.cosylab.gui.displayers.DataStateProvider

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

SELECTED_VALUE

public static final java.lang.String SELECTED_VALUE

This value is going to be set to consumers when CheckBox is selected.

See Also:

Constant Field Values

DESELECTED_VALUE

public static final java.lang.String DESELECTED_VALUE

This value is going to be set to consumers when CheckBox is deselected.

See Also:

Constant Field Values

DEFAULT_TEXT

protected static final java.lang.String DEFAULT_TEXT

See Also:

Constant Field Values

Constructor Detail

CheckBoxController

public CheckBoxController()

Default constructor: with DEFAULT_TEXT text in front of the check box.

CheckBoxController

public CheckBoxController(java.lang.String text)

Constructor with parameters.

Parameters:

text - in front of the check box

Method Detail

initialize

protected void initialize()

setSelectedValue

public void setSelectedValue(java.lang.Number value)

Set the value that will be set on consumers, when the CheckBox will be selected.

getSelectedValue

public java.lang.Number getSelectedValue()

Get the value that will be set on consumers, when the CheckBox will be selected.

setDeselectedValue

public void setDeselectedValue(java.lang.Number value)

Set the value that will be set on consumers, when the CheckBox will be deselected.

getDeselectedValue

public java.lang.Number getDeselectedValue()

Get the value that will be set on consumers, when the CheckBox will be deselected.

getFormat

public java.lang.String getFormat()

Description copied from interface: DoubleDisplayer

Returns the C-style format string that is used to format the double value into text, if the displayer must perform such rendition.

Specified by:

getFormat in interface DoubleDisplayer

Returns:

String printf style format specification

getMaximum

public double getMaximum()

Description copied from interface: DoubleDisplayer

Returns the upper limit for the value used to render the display. This upper limit must be greater or equal to the actual upper limit that the value can take. It may only be greater (and not equal) in order to round the maximum to some easiliy depictable value.

Specified by:

getMaximum in interface DoubleDisplayer

Returns:

double the upper limit for the value rendition

getMinimum

public double getMinimum()

Description copied from interface: DoubleDisplayer

Returns the lower limit for the value used to render the display. This lower limit must be lower or equal to the actual limit that the value can take. If may only be lower (and not equal) in order to round the minimum to some easily depictable value.

Specified by:

getMinimum in interface DoubleDisplayer

Returns:

double the lower limit for the value rendition

getUnits

public java.lang.String getUnits()

Description copied from interface: DoubleDisplayer

Returns the physical units of this value represented by a string.

Specified by:

getUnits in interface DoubleDisplayer

Returns:

String the units of the value, to be rendered, if possible, near the actual value

getValue

public double getValue()

Description copied from interface: DoubleDisplayer

Gets the value displayed by the displayer. This method can be invoked by any object and will probably most often be invoked by the GUI rendition code.

Specified by:

getValue in interface DoubleDisplayer

Returns:

double currently displayed value

setFormat

public void setFormat(java.lang.String value)

Description copied from interface: DoubleDisplayer

Sets the C printf style format specification used to render double value into a String. Mainly called by the adapter or user during design time.

Specified by:

setFormat in interface DoubleDisplayer

See Also:

DoubleDisplayer.getFormat()

setMaximum

public void setMaximum(double value)

Description copied from interface: DoubleDisplayer

Sets the maximum value used for displaying in range.

Specified by:

setMaximum in interface DoubleDisplayer

See Also:

#getGraphMax

setMinimum

public void setMinimum(double value)

Description copied from interface: DoubleDisplayer

Sets the minimum value used for displaying in range.

Specified by:

setMinimum in interface DoubleDisplayer

See Also:

DoubleDisplayer.getMinimum()

setUnits

public void setUnits(java.lang.String value)

Description copied from interface: DoubleDisplayer

Sets the physical units for this value. Manly called by the adapter or user during design time.

Specified by:

setUnits in interface DoubleDisplayer

See Also:

DoubleDisplayer.getUnits()

setValue

public void setValue(double val)

Description copied from interface: DoubleDisplayer

Sets the value displayed by the displayer. This method may be invoked only by the adapter delivering a new value from the modeling layer.

Specified by:

setValue in interface DoubleDisplayer

Parameters:

val - new value to be displayed

getDataSource

public DataSource getDataSource()

Description copied from interface: Displayer

Returns data source. This is convenience method for integration with VCE development tools. If null returned does not mean that this displayer is not connected to data source, it only means that setDataSource() method was not used.

Specified by:

getDataSource in interface Displayer

Returns:

the data source for this displayer, if set by setter

getTitle

public java.lang.String getTitle()

Description copied from interface: Displayer

Returns the title of this displayer. Title migth be used to identfy which particular remote entity this is displayed.

Specified by:

getTitle in interface Displayer

Returns:

the title of this displayer

isEditable

public boolean isEditable()

Description copied from interface: Displayer

Returns true if this displayer can interact with user and fire value updates requested by user. If displayer is editable, mus implement DataSource interface.

Displayers, which does not support value editing will return allways false. Displayers which support value editing MUST implement also setter setEditable(booelan).

Specified by:

isEditable in interface Displayer

Returns:

true if this displayer can receive value change requestes by user

setDataSource

public void setDataSource(DataSource dataSource)
                   throws java.beans.PropertyVetoException

Description copied from interface: Displayer

Sets data source and registeres this displayer as data consumer. This is convenience method for integration with VCE development tools, you can connect displayers directly to data sources without using this method.

Specified by:

setDataSource in interface Displayer

Parameters:

dataSource - new data source of this displayer

Throws:

java.beans.PropertyVetoException - DOCUMENT ME!

internalSetTitle

protected void internalSetTitle()

setTitle

public void setTitle(java.lang.String value)

Description copied from interface: Displayer

Sets the title of this displayer. Title migth be used to identfy which particular remote entity this is displayed. Setting to null will hide title.

Specified by:

setTitle in interface Displayer

Parameters:

value - new title of this displayer, can be null

getDataConsumer

public DataConsumer getDataConsumer(java.lang.Class type)

Description copied from interface: DataConsumer

Returns data consumer for requested data consumer type. If this data consumer does not support required data consumer, null is returned.

If this data cosnumer does not support specific data consumer type, then it means, that it is not desirable to cast data of that type to any by this consumer supported data consumer types.

Specified by:

getDataConsumer in interface DataConsumer

Parameters:

type - Class of specific data consumer (e.g. DoubleConsumer)

Returns:

implementation of required data consumer or null if not supported

getDefaultDataConsumer

public DataConsumer getDefaultDataConsumer()

Description copied from interface: DataConsumer

Returns the implementation of default consumer type supported by this data consumer.

Specified by:

getDefaultDataConsumer in interface DataConsumer

Returns:

the implementation of default consumer type supported by this data consumer

getSupportedCharacteristics

public java.lang.String[] getSupportedCharacteristics()

Description copied from interface: DataConsumer

Resturns array with names of supported characteristics. Data source can use this method to optimize setting characteristics to this data consumer. If arrray of length 0 is return, then consumer does not need or support any characteristic. If null is returned, than consumer expect all existing characteristics from data source.

Specified by:

getSupportedCharacteristics in interface DataConsumer

Returns:

array with names of supported characteristics

getSupportedConsumerTypes

public java.lang.Class<DataConsumer>[] getSupportedConsumerTypes()

Description copied from interface: DataConsumer

Returns array of supported data consumer types, which can be used as parameter and returnned with getDataCosnumer(Class) method.

Specified by:

getSupportedConsumerTypes in interface DataConsumer

Returns:

array of supported data consumer types

setCharacteristics

public void setCharacteristics(java.util.Map characteristics)

Description copied from interface: DataConsumer

Sets new dynamic value characteristics to this data consumer. This is usually called only at initializaation, before first data state or value is updated. Usually carries characteristics such as value minimum or maximum. Name and meaning of atributes is defined with contract betwean data consumer and source implementation.

Specified by:

setCharacteristics in interface DataConsumer

Parameters:

characteristics - the Map with attri

updateDataState

public void updateDataState(DataState state)

Description copied from interface: DataConsumer

Push data state (quality) update change for dynamic value. Usually called by data source.

Specified by:

updateDataState in interface DataConsumer

Parameters:

state - new data state(quality) descriptor

cleanup

public void cleanup()

Description copied from interface: CommonDisplayer

Performs general cleanup of displayer resources. All by displayer issued object are not valid any more after cleanup. Displayer positions itself in initial state and DataState is changed to NOT_INITIALIZED state.

Specified by:

cleanup in interface CommonDisplayer

isSuspended

public boolean isSuspended()

Description copied from interface: CommonDisplayer

Returns true if GUI updates are suspended.

Specified by:

isSuspended in interface CommonDisplayer

Returns:

true if GUI updates are suspended

resume

public void resume()

Description copied from interface: CommonDisplayer

Resumes updates of GUI component.

Specified by:

resume in interface CommonDisplayer

See Also:

CommonDisplayer.suspend()

suspend

public void suspend()

Description copied from interface: CommonDisplayer

Suspends all updates of displayer. Displayer might receive data change updates, but does not call redraw on GUI components, which is time and CPU consuming.

Specified by:

suspend in interface CommonDisplayer

getPopupManager

public PopupManager getPopupManager()

Description copied from interface: PopupManageable

Returns popup manager, which manages popup menu.

Specified by:

getPopupManager in interface PopupManageable

Returns:

returns popup manager, which manages popup menu

isPopupEnabled

public boolean isPopupEnabled()

Return true if the popup menu is enabled or false otherwise.

Returns:

true if popup is enabled

setPopupEnabled

public void setPopupEnabled(boolean enabled)

Enables or disables the popup menu.

Parameters:

enabled - true if enable or false if disableds

getInfoDialog

protected javax.swing.JDialog getInfoDialog()

getCustomizer

protected AbstractCustomizerPanel getCustomizer()

getDataState

public DataState getDataState()

Description copied from interface: DataStateProvider

Returns data quality state. This property is changed by data consumer interface. In case of multiple displayer, this state indicates integral state for all contained data consumers.

Specified by:

getDataState in interface DataStateProvider

Returns:

dynamic data quality state

updateValue

public void updateValue(long timestamp,
                        double value)
                 throws CommonException

Description copied from interface: DoubleConsumer

Notifys this consumer about new dynamic value update.

Specified by:

updateValue in interface DoubleConsumer

Parameters:

timestamp - the time of dynamic value event

value - new value

Throws:

CommonException

addConsumer

public void addConsumer(DataConsumer consumer)
                 throws java.beans.PropertyVetoException

Accepts only consumers, which support NonblockingNumberConsumer which is used for receiving updates from user.

Specified by:

addConsumer in interface DataSource

Parameters:

consumer - the data consumer to be regitered at this data source

Throws:

java.beans.PropertyVetoException

See Also:

DataSource.addConsumer(com.cosylab.gui.displayers.DataConsumer)

getAcceptableConsumerTypes

public java.lang.Class<DataConsumer>[] getAcceptableConsumerTypes()

Description copied from interface: DataSource

Returns the array of consumer types, which are acceptable by this data source.

Specified by:

getAcceptableConsumerTypes in interface DataSource

Returns:

the array of acceptable data source types

getConsumers

public DataConsumer[] getConsumers()

Description copied from interface: DataSource

Returns array of registered data consumer.

Specified by:

getConsumers in interface DataSource

Returns:

array of registered data consumer

removeAllConsumers

public void removeAllConsumers()

Description copied from interface: DataSource

Removes all consumers from data source and releases all resources and bindings allocated inside datasource to the consumers.

Specified by:

removeAllConsumers in interface DataSource

removeConsumer

public void removeConsumer(DataConsumer consumer)

Description copied from interface: DataSource

Deregisters data consumer from this data source.

Specified by:

removeConsumer in interface DataSource

Parameters:

consumer - data consumer to be deregistered

getConverter

public Converter getConverter()

Description copied from interface: ConvertibleDisplayer

Returns the converter that is used with the displayer.

Specified by:

getConverter in interface ConvertibleDisplayer

Returns:

setConverter

public void setConverter(Converter converter)
                  throws java.beans.PropertyVetoException

Description copied from interface: ConvertibleDisplayer

Sets the Converter that is used when displaying value with this.

Specified by:

setConverter in interface ConvertibleDisplayer

Throws:

java.beans.PropertyVetoException