DESY ACOP Beans Home

com.cosylab.gui.displayers
Interface Displayer

All Superinterfaces:

CommonDisplayer, DataConsumer, DataStateProvider, PopupManageable

All Known Subinterfaces:

AcopDisplayer, ConvertibleDisplayer, DoubleDisplayer, DoubleSeqDisplayer, EnumDisplayer, IconDisplayer, LongDisplayer, ObjectDisplayer, PatternDisplayer, StringDisplayer

All Known Implementing Classes:

AbstractDisplayerPanel, AcopButton, AcopCheckBox, AcopDialKnob, AcopGauger, AcopIcon, AcopLabel, AcopNumberLabel, AcopSlider, AcopWheelswitch, ButtonController, CharacteristicsMapPanel, CheckBoxController, DialKnobDisplayer, DoubleNumberDisplayer, GaugerDisplayer, IconDisplayer, LabelDisplayer, SliderDisplayer, SliderDisplayerSetter, WheelswitchDisplayer

public interface Displayer
extends DataConsumer, CommonDisplayer

Displayer interface describes GUI component, which is able to dispaly on screen single dynamic data source.

If displayer GUI commponent is editable, this means can receive input from the end user, then such displayer will want to send this value change to the datasource back. In this case the displayer must implement also DataSource interface and accept consumers of type NonblockingNumberConsumer at least or other Nonblocking<TYPPE>Consumer, Synchronous<TYPPE>Consumer and Asynchronous<TYPPE>Consumer consumers. Displayer then sends user data change request to this consumers.

Since:

Nov 24, 2003.

Version:

$Id: Displayer.java,v 1.9 2008-04-22 12:31:02 jbobnar Exp $

Author:

Igor Kriznar

Field Summary

static java.lang.String	C_EDITABLE Characteristic name for editable displayer JavaBean property.
static java.lang.String	DATA_SOURCE Java Bean property name for DataSource property.

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

DataSource	getDataSource() Returns data source.
java.lang.String	getTitle() Returns the title of this displayer.
boolean	isEditable() Returns true if this displayer can interact with user and fire value updates requested by user.
void	setDataSource(DataSource dataSource) Sets data source and registeres this displayer as data consumer.
void	setTitle(java.lang.String title) Sets the title of this displayer.

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

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

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

Field Detail

DATA_SOURCE

static final java.lang.String DATA_SOURCE

Java Bean property name for DataSource property.

See Also:

Constant Field Values

C_EDITABLE

static final java.lang.String C_EDITABLE

Characteristic name for editable displayer JavaBean property. Displayers which support value editing MUST implement also setter setEditable(booelan) and support this characteristic name.

See Also:

isEditable(), Constant Field Values

Method Detail

isEditable

boolean isEditable()

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

Returns:

true if this displayer can receive value change requestes by user

getTitle

java.lang.String getTitle()

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

Returns:

the title of this displayer

setTitle

void setTitle(java.lang.String title)

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.

Parameters:

title - new title of this displayer, can be null

setDataSource

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

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.

Parameters:

dataSource - new data source of this displayer

Throws:

java.beans.PropertyVetoException - DOCUMENT ME!

getDataSource

DataSource getDataSource()

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.

Returns:

the data source for this displayer, if set by setter