Package com.uc4.api.objects

Class CockpitBox

java.lang.Object

com.uc4.api.objects.CockpitControl

com.uc4.api.objects.CockpitValueControl

com.uc4.api.objects.CockpitBox

public class CockpitBox
extends CockpitValueControl

Represents the Box control of the Cockpit.

Nested Class Summary

Nested classes/interfaces inherited from class com.uc4.api.objects.CockpitValueControl

CockpitValueControl.ValueFormat

Field Summary

Fields inherited from class com.uc4.api.objects.CockpitValueControl

dataSource, minColorRed, thresholds, valueFormat

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CockpitBox(com.uc4.util.XMLDocument doc, org.w3c.dom.Element control)

Method Summary

Modifier and Type	Method	Description
boolean	isOnOff()	Return true if the On/Off function is used, false if the threshold values.
void	setOnOff(boolean onOff)	Specify, whether the On/Off mode is used or not.

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

dataSource, getValueFormat, isMinColorRed, setMinColorRed, setValueFormat, thresholds

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

Constructor Detail

CockpitBox

protected CockpitBox(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element control)

Method Detail

isOnOff

public boolean isOnOff()

Return true if the On/Off function is used, false if the threshold values. It also returns false if the value format is set to ValueFormat.TEXT.

Returns:

OnOff

setOnOff

public void setOnOff(boolean onOff)

Specify, whether the On/Off mode is used or not. If set to false the threshold values are used.

Parameters:

onOff - On/Off mode