ilog.tgo.model

Class IltLed

java.lang.Object

ilog.cpl.model.IlpDefaultObject

ilog.tgo.model.IltObject

ilog.tgo.model.IltCardItem

ilog.tgo.model.IltLed

All Implemented Interfaces:

IlpAttributeValueHolder, IlpObject, IltStateHolder, ilog.tgo.model.state.event.IltObjectStateListener, IltWithProperties, IlWithProperties, EventListener

public class IltLed
extends IltCardItem

This class defines a LED (light-emitting diode) element. A LED is a simple IltObject that displays a color. Like a real LED, it can be turned on and off and can support multiple colors as well.

To make it more simple and generic, the LED object doesn't need a state but can have its color set through the alarm color.

Normally, the LED color is set through its foreground color property. It is up to the user to change the LED color; the "off" representation is also a color defined and set by the user as a regular color.

An IltLed is a subclass of IltCardItem; it is designed to fit inside an IltCard container.

There are several predefined LED types; some of them can be customized using cascading style sheets. It is also possible to create new types using the predefined base renderers (IltLedBaseRenderer) or by defining a totally new base renderer. There are also two gif-based renderers, one to define a LED based on a single image, and another one, more complex, suited to create highly customizable LEDs.

Since:

JTGO 3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltLed.Type This enumeration lists the types of LED objects.

Nested classes/interfaces inherited from class ilog.tgo.model.IltObject

IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType

Field Summary

Fields

Modifier and Type	Field and Description
static IltLed.Type	DefaultType The default type of a new LED object.
static IltAttribute	HeightAttribute Attribute used to define the height of LEDs.
static IltObjectInfo	metainfo Contains metainformation about this IltObject implementation.
static IltAttribute	WidthAttribute Attribute used to define the width of LEDs.

Fields inherited from class ilog.tgo.model.IltCardItem

AntiAliasing, DirectionAttribute, TypeAttribute

Fields inherited from class ilog.tgo.model.IltObject

_automaticDecorationsDirection, _cloneConstructor, AbbreviateBalloonAlarmCount, AbbreviateBaseAlarmCount, AckAlarmHighestSeverityAttribute, AckImpactAlarmHighestSeverityAttribute, AlarmBalloonColor, AlarmBalloonContentsCollapsed, AlarmBalloonCountIcon, AlarmBalloonCountLabel, AlarmBalloonPosition, AlarmBalloonShadowColor, AlarmBalloonTextAntialiasing, AlarmBalloonTextBackgroundColor, AlarmBalloonTextFont, AlarmBalloonTextForegroundColor, AlarmBalloonVisible, AlarmBorderColor, AlarmBorderThickness, AlarmBorderVisible, AlarmBrightColor, AlarmColor, AlarmColorLevel, AlarmColorVisible, AlarmCountAntialiasing, AlarmCountAttribute, AlarmCountBackgroundColor, AlarmCountFont, AlarmCountForegroundColor, AlarmCountIcon, AlarmCountIconPosition, AlarmCountIconVisible, AlarmCountLabel, AlarmCountNumberAttribute, AlarmCountVisible, AlarmCriticalAbbreviation, AlarmCriticalBrightColor, AlarmCriticalColor, AlarmCriticalDarkColor, AlarmCriticalDescription, AlarmDarkColor, AlarmHighestSeverityAttribute, AlarmLossOfConnectivityAbbreviation, AlarmLossOfConnectivityBrightColor, AlarmLossOfConnectivityColor, AlarmLossOfConnectivityDarkColor, AlarmLossOfConnectivityOverride, AlarmMajorAbbreviation, AlarmMajorBrightColor, AlarmMajorColor, AlarmMajorDarkColor, AlarmMajorDescription, AlarmMinorAbbreviation, AlarmMinorBrightColor, AlarmMinorColor, AlarmMinorDarkColor, AlarmMinorDescription, AlarmNotReportingAbbreviation, AlarmsAsMarks, AlarmSeverityColorMap, AlarmSeverityDescriptionMap, AlarmUnknownAbbreviation, AlarmUnknownBrightColor, AlarmUnknownColor, AlarmUnknownDarkColor, AlarmUnknownDescription, AlarmWarningAbbreviation, AlarmWarningBrightColor, AlarmWarningColor, AlarmWarningDarkColor, AlarmWarningDescription, Alpha, BackgroundColor, BaseSelectionBorderVisible, BaseStyleEnabled, BlinkingBackgroundColor, BlinkingBorderColor, BlinkingBorderColor2, BlinkingForegroundColor, BorderColor, BorderColor2, BorderLineStyle, BorderPattern, BorderWidth, BUSINESS_OBJECT_PROPERTY, CanBeLogical, CenterWidth, ChildrenDecorationConstraints, ChildrenDecorations, ContainerCollapseIconVisible, ContainerExpansionIconVisible, ContainerOutsideExpansionIconVisible, ContainerStatusVisible, DetailLevel, Direction, DottedBorderBackgroundColor, DottedBorderForegroundColor, DottedBorderLineStyle, ForcedWidth, ForegroundColor, GraphicRepresentationAttribute, HasAlarmColor, IconsVisible, ImpactAlarmCountAttribute, ImpactAlarmCountNumberAttribute, ImpactAlarmHighestSeverityAttribute, InfoIconInteractor, InfoIconThreshold, InfoWindowAlwaysVisible, InfoWindowBorderColor, InfoWindowColor, InfoWindowShadowColor, InfoWindowTextAntialiasing, InfoWindowTextBackgroundColor, InfoWindowTextFont, InfoWindowTextForegroundColor, InfoWindowVisible, IsEditable, IsLogical, IsSelectable, IsTiny, IsVisible, LabelAntialiasing, LabelBackgroundColor, LabelBorderColor, LabelDirection, LabelFont, LabelForegroundColor, LabelOffset, LabelPosition, LabelVisible, LabelZoomable, LineStyle, LinkPorts, ListAlarmStateAbbreviated, ListPrimaryAlarmState, ListPrimaryState, ListSecondaryAlarmState, LogicalBorderThickness, LogicalHeight, LogicalLabelAntialiasing, LogicalLabelFont, LogicalTypeAttribute, LogicalWidth, MappedBorderColor, MappedBorderColor2, MappedBrightColor, MappedColor, MappedColor2, MappedDarkColor, MultilineBaseAlarmCount, NameAttribute, NewAlarmCountAttribute, NewAlarmCountNumberAttribute, NewAlarmHighestSeverityAttribute, NewImpactAlarmCountAttribute, NewImpactAlarmCountNumberAttribute, NewImpactAlarmHighestSeverityAttribute, ObjectStateAttribute, PassiveIcon, PassiveIconVisible, Pattern, PlinthBrightColor, PlinthColor, PlinthDarkColor, PlinthHorizontalMargin, PlinthVerticalMargin, PlinthVisible, PositionAttribute, PrimaryAlarmState, PrimaryStateAttribute, ReliefBorders, SecondaryStatesAttribute, SecondaryStateStackerPosition, SelectionBorderBackgroundColor, SelectionBorderForegroundColor, SelectionBorderLineStyle, SelectionBorderThickness, ShortcutIcon, ShortcutIconMap, ShortcutIconVisible, ShortcutToolTipMap, SNMPSystemContact, SNMPSystemDescription, SNMPSystemLocation, SourceImage, TinyAlarmBorderThickness, TinyBorderThickness, TinyLabelAntialiasing, TinyLabelFont, TinyTypeAttribute, TrapAuthenticationFailureAbbreviation, TrapAuthenticationFailureBrightColor, TrapAuthenticationFailureColor, TrapAuthenticationFailureDarkColor, TrapAuthenticationFailureDescription, TrapColdStartAbbreviation, TrapColdStartBrightColor, TrapColdStartColor, TrapColdStartDarkColor, TrapColdStartDescription, TrapEGPNeighborLossAbbreviation, TrapEGPNeighborLossBrightColor, TrapEGPNeighborLossColor, TrapEGPNeighborLossDarkColor, TrapEGPNeighborLossDescription, TrapLinkFailureAbbreviation, TrapLinkFailureBrightColor, TrapLinkFailureColor, TrapLinkFailureDarkColor, TrapLinkFailureDescription, TrapWarmStartAbbreviation, TrapWarmStartBrightColor, TrapWarmStartColor, TrapWarmStartDarkColor, TrapWarmStartDescription

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder

VALUE_NOT_SET

Constructor Summary

Constructors

Constructor and Description
IltLed(IlpClass ilpClass, Object identifier) Creates a new LED element with the given class and identifier.
IltLed(Object identifier) Creates a new LED element with the specified identifier.
IltLed(String label, IltLed.Type type) Creates a new LED element with the specified label and type.

Method Summary

Modifier and Type	Method and Description
ilog.tgo.graphic.internal.base.IltBaseElement	createBase(IltcGraphicElementAggregate root) Creates a base element, suitable for this particular kind of object.
static IltLegend	GetClassLegend() Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please refer to the User's Manual for further information.
static IltObjectInfo	GetIlpClass() Returns the IlpClass corresponding to this Java class.
IltLed.Type	getType() Retrieves the "type" of this object.
protected void	initializeObject(IltObjectState state, String name) This method is only called by the constructor.
void	setAttributeValue(IlpAttribute attribute, Object value) Sets the value of an attribute of this object.
void	setType(IltLed.Type type) Sets the "type" of this object.

Methods inherited from class ilog.tgo.model.IltCardItem

applyTransform, computeGraphic, copyFrom, createPositionUpdate, createTinyBase, defaultShape, getBaseRectangle, getCenterPoint, getContainer, GetDirectionMapping, getMappedForUserList, isItemMoveable, isValidPosition, setBaseRectangle, setCenterPoint, setContainer, SetDirectionMapping, setShapeInManagerGraphicSetting, transformPosition, updateShapeGraphicSettingInManager

Methods inherited from class ilog.tgo.model.IltObject

__getIlpObject, addGraphicChangedListener, addStateChangedListener, applyTransform, applyTransform, applyTransform, applyTransformInManager, clearState, cloneForRendering, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphicAtPosition, copyFrom, createGraphic, debug, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, getChildren, getDefaultLabelPosition, getGraphic, getGraphic, getGraphicInHierarchy, getGraphicInteractions, getGraphicNotNull, getGraphicNotNullInHierarchy, getGraphicRepresentationStyle, getGraphicSetting, getGraphicSetting, getGraphicSettings, GetIltObject, getLabel, getLabelOffset, getLabelOffset, getLabelOffset, getLabelPosition, getLabelPosition, getLabelPosition, getLayoutProxy, getLegend, getLegend, getLocalStyle, getLocalStyle, getLogicalType, getName, getObjectInfo, getObjectMapper, getObjectState, getObjectSystemMapper, getPosition, getProperty, getState, getTinyType, getTrapState, hasState, initializeCreatedGraphic, initializeDefaultValues, initializeVisibleGraphic, InitStyle, isEditable, isNearlyVisible, IsPropertyTransient, isSelected, isSelected, isVisible, mapDirection, mappedForUser, objectStateChanged, objectStateCleared, objectStateSet, postCreateGraphic, preCreateGraphic, removeGraphic, removeGraphic, removeGraphic, removeGraphicChangedListener, removeGraphicSetting, removeGraphicSetting, removeProperty, removeStateChangedListener, resetLabelOffset, resetLabelOffset, resetLabelPosition, resetLabelPosition, resetState, restoreVisibility, setAutomaticDecorationsDirection, setAutomaticDecorationsDirection, setBaseRectangleInManager, setCenterPoint, setCenterPoint, setCenterPointInManager, setEditable, setGraphic, setGraphicSetting, setGraphicSetting, setGraphicSetting, setGraphicSettings, setIlpClass, setLabel, setLabelOffset, setLabelOffset, setLabelPosition, setLabelPosition, setLegend, setLogicalType, setName, setObjectState, setPosition, setProperty, SetPropertyTransient, setSelected, setSelectedInternal, setShapeGraphicSetting, setState, setState, setTinyType, setVisible, startDelayingComputeGraphic, StartDelayingComputeGraphic, startVisibility, updateFrom, usingDefaultShape

Methods inherited from class ilog.cpl.model.IlpDefaultObject

addAttributeValueListener, fireEvent, getAttributeGroup, getAttributeValue, getAttributeValue, getAttributeValueByName, getIdentifier, getIlpClass, getLocalAttributeValues, getObjectSupport, hasAttributeValue, removeAttributeValueListener, setAttributeValue, setAttributeValueByName, setLocalAttributeValues, setObjectSupport, toString

Methods inherited from class java.lang.Object

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

Field Detail

WidthAttribute

public static IltAttribute WidthAttribute

Attribute used to define the width of LEDs.

Attribute name: width.

Value type: Float.

The CSS property shapeWidth is, by default, set to retrieve the value of this attribute.

HeightAttribute

public static IltAttribute HeightAttribute

Attribute used to define the height of LEDs.

Attribute name: height.

Value type: Float.

The CSS property shapeHeight is, by default, set to retrieve the value of this attribute.

metainfo

public static IltObjectInfo metainfo

Contains metainformation about this IltObject implementation.

Internal: do not use!

DefaultType

public static IltLed.Type DefaultType

The default type of a new LED object.

Default value: IltLed.Type.Circular

Constructor Detail

IltLed

public IltLed(String label,
              IltLed.Type type)

Creates a new LED element with the specified label and type.

Parameters:

label - The LED label.

type - The LED type.

IltLed

public IltLed(Object identifier)

Creates a new LED element with the specified identifier.

The user must set the other object properties using the appropriate accessors.

Parameters:

identifier - The identifier of this new instance.

IltLed

public IltLed(IlpClass ilpClass,
              Object identifier)

Creates a new LED element with the given class and identifier.

The user must set the other object properties using the appropriate accessors.

Parameters:

ilpClass - The business class of this new instance. It must be a subclass of IltLed.

identifier - The identifier of this new instance.

Method Detail

GetIlpClass

public static IltObjectInfo GetIlpClass()

Returns the IlpClass corresponding to this Java class. Here the IlpClass interface is implemented by IltObjectInfo.
This method is used by the class manager to retrieve predefined business object classes.

initializeObject

protected void initializeObject(IltObjectState state,
                                String name)

This method is only called by the constructor.

Overrides:

initializeObject in class IltObject

See Also:

IltObject.initializeObject(ilog.tgo.model.IltObjectState, java.lang.String)

Internal: do not use!

getType

public IltLed.Type getType()

Retrieves the "type" of this object.

Returns:

The object type.

setType

public void setType(IltLed.Type type)

Sets the "type" of this object.

Parameters:

type - The new object type.

setAttributeValue

public void setAttributeValue(IlpAttribute attribute,
                              Object value)

Sets the value of an attribute of this object. To remove the value of an attribute, you can pass VALUE_NOT_SET to the value argument.

Specified by:

setAttributeValue in interface IlpAttributeValueHolder

Overrides:

setAttributeValue in class IltCardItem

Parameters:

attribute - The attribute of which the value is set.

value - The new value of the attribute or VALUE_NOT_SET to remove the value of the attribute.

Throws:

IllegalArgumentException - If the attribute cannot have its value modified.

GetClassLegend

@Deprecated
public static IltLegend GetClassLegend()

Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please refer to the User's Manual for further information.

Returns the business class style as defined in the default application context style manager.

Deprecated Since:

JTGO 3.0

createBase

public ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)

Creates a base element, suitable for this particular kind of object.

Specified by:

createBase in class IltObject

Parameters:

root - The decoration hierarchy root

Returns:

The base element for the object

See Also:

IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject), IltObject.createTinyBase(IltcGraphicElementAggregate)

Internal: do not use!