Package com.uc4.api.objects

Class CockpitValueControl

java.lang.Object

com.uc4.api.objects.CockpitControl

com.uc4.api.objects.CockpitValueControl

Direct Known Subclasses:

CockpitBar, CockpitBox, CockpitLamp, CockpitPie, CockpitTrafficLights

public abstract class CockpitValueControl
extends CockpitControl

Basis for all Cockpit control with values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CockpitValueControl.ValueFormat	Format of the 2nd caption of the CockpitControl.

Field Summary

Fields

Modifier and Type	Field	Description
protected CockpitControlDataSource	dataSource
protected boolean	minColorRed
protected final CockpitThresholds	thresholds
protected CockpitValueControl.ValueFormat	valueFormat

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CockpitValueControl(com.uc4.util.XMLDocument doc, Element control)

Method Summary

Modifier and Type	Method	Description
CockpitControlDataSource	dataSource()	Returns the CockpitControlDataSource of the CockpitControl.
CockpitValueControl.ValueFormat	getValueFormat()	Returns the format of the 2nd caption.
boolean	isMinColorRed()	Returns true if the color for the minimum value is red, false if the color for the minimum value is green.
void	setMinColorRed(boolean minColorRed)	Sets the color for the minimum value to red.
void	setValueFormat(CockpitValueControl.ValueFormat valueFormat)	Sets the format of the 2nd caption.
CockpitThresholds	thresholds()	Returns the CockpitThresholds of the CockpitControl.

Methods inherited from class com.uc4.api.objects.CockpitControl

getCaption, getHeight, getId, getLeft, getTop, getWidth, setCaption, setHeight, setLeft, setTop, setWidth, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

valueFormat

protected CockpitValueControl.ValueFormat valueFormat

minColorRed

protected boolean minColorRed

thresholds

protected final CockpitThresholds thresholds

dataSource

protected CockpitControlDataSource dataSource

Constructor Details

CockpitValueControl

protected CockpitValueControl(com.uc4.util.XMLDocument doc,
 Element control)

Method Details

thresholds

public CockpitThresholds thresholds()

Returns the CockpitThresholds of the CockpitControl.

Returns:

use thresholds

dataSource

public CockpitControlDataSource dataSource()

Returns the CockpitControlDataSource of the CockpitControl.

Returns:

CockpitControlDataSource

getValueFormat

public CockpitValueControl.ValueFormat getValueFormat()

Returns the format of the 2nd caption.

Returns:

ValueFormat

setValueFormat

public void setValueFormat(CockpitValueControl.ValueFormat valueFormat)

Sets the format of the 2nd caption.

Parameters:

valueFormat - ValueFormat

setMinColorRed

public void setMinColorRed(boolean minColorRed)

Sets the color for the minimum value to red.

Parameters:

minColorRed - Minimum color is red

isMinColorRed

public boolean isMinColorRed()

Returns true if the color for the minimum value is red, false if the color for the minimum value is green.

Returns:

color red