DESY ACOP Beans Home

com.cosylab.gui.displayers
Interface LongDisplayer

All Superinterfaces:

CommonDisplayer, DataConsumer, DataStateProvider, Displayer, LongConsumer, PopupManageable

public interface LongDisplayer
extends Displayer, LongConsumer

A specialization of Displayer interface for Java primitive type long.

Version:

$id$

Author:

Igor Kriznar

Field Summary

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

Method Summary

java.lang.String	getFormat() Returns the C-style format string that is used to format the long value into text, if the displayer must perform such rendition.
long	getMaximum() Returns the upper limit for the value used to render the display.
long	getMinimum() Returns the lower limit for the value used to render the display.
java.lang.String	getUnits() Returns the physical units of this value represented by a string.
long	getValue() Gets the value displayed by the displayer.
void	setFormat(java.lang.String value) Sets the C printf style format specification used to render long value into a String.
void	setMaximum(long value) Sets the maximum value used for graphing.
void	setMinimum(long value) Sets the minimum value used for graphing.
void	setUnits(java.lang.String value) Sets the physical units for this value.
void	setValue(long value) Sets the value displayed by the displayer.

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

getDataSource, getTitle, isEditable, setDataSource, setTitle

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

cleanup, isSuspended, resume, suspend

Methods inherited from interface com.cosylab.gui.components.util.PopupManageable

getPopupManager

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

addPropertyChangeListener, addPropertyChangeListener, getDataState, removePropertyChangeListener, removePropertyChangeListener

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

updateValue

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

getDataConsumer, getDefaultDataConsumer, getName, getSupportedCharacteristics, getSupportedConsumerTypes, setCharacteristics, updateDataState

Method Detail

setValue

void setValue(long value)

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

Parameters:

value - new value to be displayed

getValue

long getValue()

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.

Returns:

long currently displayed value

getMinimum

long getMinimum()

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.

Returns:

long the lower limit for the value rendition

getMaximum

long getMaximum()

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.

Returns:

long the upper limit for the value rendition

getUnits

java.lang.String getUnits()

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

Returns:

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

getFormat

java.lang.String getFormat()

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

Returns:

String printf style format specification

setMinimum

void setMinimum(long value)

Sets the minimum value used for graphing. Mainly called by the adapter or user during design time.

Parameters:

long - new graphing minimum

See Also:

#getGraphMin

setMaximum

void setMaximum(long value)

Sets the maximum value used for graphing. Mainly called by the adapter or user during design time.

Parameters:

long - new graphing maximum

See Also:

#getGraphMax

setUnits

void setUnits(java.lang.String value)

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

Parameters:

String - units for the value

See Also:

getUnits()

setFormat

void setFormat(java.lang.String value)

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

Parameters:

String - C-style format specification

See Also:

getFormat()