ilog.tgo.model
Class IltCardItem

java.lang.Object
  ilog.cpl.model.IlpDefaultObject
      ilog.tgo.model.IltObject
          ilog.tgo.model.IltCardItem

All Implemented Interfaces:

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

Direct Known Subclasses:

IltLed, IltPort

public abstract class IltCardItem
extends IltObject

Abstract class to define common characteristics of card item objects.

Nested Class Summary

static class

IltCardItem.Type The abstract class used to manage the types of the subclasses of IltCardItem.

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

IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType

Field Summary

static IlpBooleanKey	AntiAliasing Deprecated. Please use CSS property antialiasing instead.
static IltAttribute	DirectionAttribute Attribute used to define the direction of the card item.
static IltObjectInfo	metainfo Contains metainformation about this IltObject implementation.
static IltAttribute	TypeAttribute Attribute used to define the type of the LED or Port object.

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

IltCardItem(IlpClass ilpClass, Object identifier)
Creates a new instance of IltCardItem with a given class and identifier.

IltCardItem(IltObjectState oState, String label)
Creates a new instance of IltCardItem with label and object state.

IltCardItem(Object identifier)
Creates a new instance of IltCardItem with an identifier.

Method Summary

void	applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer transf, IlpPositionSource reason) Deprecated.
void	computeGraphic(IltGraphicManager manager, IlvPoint position) Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. Once visible, it is updated automatically when needed.
protected void	copyFrom(IltCardItem other)
ilog.tgo.graphic.internal.IltGraphicUpdate	createPositionUpdate(Object position, Object positionInManager) Creates the graphic update responsible for setting the position/shape to a graphical representation.
ilog.tgo.graphic.internal.base.IltBaseElement	createTinyBase(IltcGraphicElementAggregate root) Creates a base element, suitable for this particular kind of object, for us with the Tiny Graphic Representation Style (GRS).
IlvRect	getBaseRectangle(IltGraphicManager manager) Returns the base rectangle of the graphic representation in a given IltGraphicManager.
protected IlvPoint	getCenterPoint(IltGraphicManager manager, IltGraphic graphic) Returns the position of the graphic representation in a given IltGraphicManager.
static IltLegend	GetClassLegend() Deprecated. Please use IlpStyleManager to retrieve the appropriate style for this IlpClass.
ilog.tgo.model.internal.IltCardItemContainer	getContainer() Returns the container of this card item.
static IltLegendModifier	GetDirectionMapping(int direction) Access the legend modifier associated with the given direction.
static IltObjectInfo	GetIlpClass() Returns the IlpClass corresponding to this Java class.
ilog.util.internal.IlAVector	getMappedForUserList() Access method to retrieve the user mappings.
boolean	isItemMoveable(IltGraphic graphic) Check whether or not a card item should be affected by transformations (when inside a composite card, a card item should not be affected by zooming transformations).
boolean	isValidPosition(Object position) Determines whether the argument is a valid position/shape for the card item object.
void	setAttributeValue(IlpAttribute attribute, Object value) Sets the value of an attribute of this object.
void	setBaseRectangle(IltGraphicManager manager, IlvRect newBaseRectangle) Applies a transformation to the graphic representation in a given IltGraphicManager, attempting to make the base rectangle resemble the given rectangle.
void	setCenterPoint(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason) Changes the position of the graphic representation in a given IltGraphicManager.
void	setContainer(ilog.tgo.model.internal.IltCardItemContainer cardContainer) Specifies the container of this card item.
static void	SetDirectionMapping(IltLegendModifier modifier, int direction) Set a new legend modifier for a given position.
void	setShapeInManagerGraphicSetting(IltGraphic graphic, Object position, IlpPositionSource reason) Set the ShapeInManager graphic setting.
Object	transformPosition(IltGraphicManager manager, Object position) Applies the manager transformer to the position parameter.
void	updateShapeGraphicSettingInManager(IltGraphicManager manager, IltGraphic graphic, Object newShape, IlpPositionSource reason) If the graphic representation is visible, updates the shape graphic setting in manager coordinates.

Methods inherited from class ilog.tgo.model.IltObject

__getIlpObject, addGraphicChangedListener, addStateChangedListener, applyTransform, applyTransform, applyTransform, applyTransformInManager, clearState, cloneForRendering, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphicAtPosition, copyFrom, createBase, createGraphic, debug, defaultShape, 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, initializeObject, 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

metainfo

public static IltObjectInfo metainfo

Contains metainformation about this IltObject implementation.

Internal method or field: do not use!

TypeAttribute

public static IltAttribute TypeAttribute

Attribute used to define the type of the LED or Port object.

Attribute name: type.

Value type: IltCardItem.Type.

Since:

JTGO 3.0

DirectionAttribute

public static IltAttribute DirectionAttribute

Attribute used to define the direction of the card item. Its value is an instance of IlpDirection.

Attribute name: direction.

Value type: IlpDirection.

Since:

JTGO 3.0

See Also:

IlpDirection

AntiAliasing

public static IlpBooleanKey AntiAliasing

Deprecated. Please use CSS property antialiasing instead.

Allows you to define anti-aliasing for the card item and improve drawer capabilities. This method is set to false by default.

See Also:

IltObjectCustomization.isAntialiasing()

Deprecated Since:

JTGO 3.5

Constructor Detail

IltCardItem

public IltCardItem(Object identifier)

Creates a new instance of IltCardItem with an identifier.

Parameters:

identifier - The identifier of this new instance

Since:

JTGO 3.0

IltCardItem

public IltCardItem(IlpClass ilpClass,
                   Object identifier)

Creates a new instance of IltCardItem with a given class and identifier.

Parameters:

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

identifier - The identifier of this new instance

Since:

JTGO 3.0

IltCardItem

public IltCardItem(IltObjectState oState,
                   String label)

Creates a new instance of IltCardItem with label and object state.

Parameters:

oState - The object state

label - The card label

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.

Since:

JTGO 3.0

getContainer

public ilog.tgo.model.internal.IltCardItemContainer getContainer()

Returns the container of this card item.

Returns:

A reference to the IltCardItemContainer object that contains this card item

Since:

JTGO 3.0

GetDirectionMapping

public static IltLegendModifier GetDirectionMapping(int direction)

Access the legend modifier associated with the given direction.

Every time when a card item is rotated to a specific direction, JTGO updates a set of legend values so decorations follow the new orientation.

Parameters:

direction - The direction

Returns:

The legend modifier associated with the given direction

Internal method or field: do not use!

SetDirectionMapping

public static void SetDirectionMapping(IltLegendModifier modifier,
                                       int direction)

Set a new legend modifier for a given position.

The legend modifier defines the legend keys and values that will be set when the card item is set to the given direction.

Parameters:

modifier - The new legend modifier

direction - The corresponding direction

Internal method or field: do not use!

setContainer

public void setContainer(ilog.tgo.model.internal.IltCardItemContainer cardContainer)

Specifies the container of this card item.

This method must only be called internally.

Parameters:

cardContainer - A reference to the IltCardItemContainer object that contains this card item.

Internal method or field: do not use!

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 for the value argument.

Specified by:

setAttributeValue in interface IlpAttributeValueHolder

Overrides:

setAttributeValue in class IltObject

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.

Since:

JTGO 3.0

getBaseRectangle

public IlvRect getBaseRectangle(IltGraphicManager manager)

Returns the base rectangle of the graphic representation in a given IltGraphicManager.

Specified by:

getBaseRectangle in class IltObject

Returns:

null if the base has no extent at all

Internal method or field: do not use!

GetClassLegend

public static IltLegend GetClassLegend()

Deprecated. Please use IlpStyleManager to retrieve the appropriate style for this IlpClass.

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

Deprecated Since:

JTGO 3.0

getMappedForUserList

public ilog.util.internal.IlAVector getMappedForUserList()

Access method to retrieve the user mappings.

Overrides:

getMappedForUserList in class IltObject

Internal method or field: do not use!

computeGraphic

public void computeGraphic(IltGraphicManager manager,
                           IlvPoint position)

Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. Once visible, it is updated automatically when needed.

Makes sure that this object has a valid graphic representation in a given IltGraphicManager. The graphic representation is drawn at the given position.

Parameters:

manager - The graphic manager

position - The relative position of the graphic representation

Deprecated Since:

JTGO 3.5

createTinyBase

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

Creates a base element, suitable for this particular kind of object, for us with the Tiny Graphic Representation Style (GRS).

Overrides:

createTinyBase in class IltObject

See Also:

IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject), IltGraphicRepresentationStyle, IltTinyElementBase, IltObject.createBase(IltcGraphicElementAggregate)

Internal method or field: do not use!

transformPosition

public Object transformPosition(IltGraphicManager manager,
                                Object position)

Applies the manager transformer to the position parameter. This is called by computeGraphic(mgr, position)

Specified by:

transformPosition in class IltObject

Parameters:

manager - The graphic manager

position - A valid position for the object

Returns:

The transformed position

Internal method or field: do not use!

isValidPosition

public boolean isValidPosition(Object position)

Determines whether the argument is a valid position/shape for the card item object.

Specified by:

isValidPosition in class IltObject

Parameters:

position - The given object to be validated, must be instance of IlvPoint class

Returns:

true if the given position is instance of IlvPoint class, false otherwise

Internal method or field: do not use!

createPositionUpdate

public ilog.tgo.graphic.internal.IltGraphicUpdate createPositionUpdate(Object position,
                                                                       Object positionInManager)

Creates the graphic update responsible for setting the position/shape to a graphical representation. If the given position is null, the position/shape set will be the default value.

Specified by:

createPositionUpdate in class IltObject

Parameters:

position - The shape in stationary coordinates

positionInManager - The shape in manager coordinates (takes into account the logical zoom transformer)

Internal method or field: do not use!

updateShapeGraphicSettingInManager

public void updateShapeGraphicSettingInManager(IltGraphicManager manager,
                                               IltGraphic graphic,
                                               Object newShape,
                                               IlpPositionSource reason)

If the graphic representation is visible, updates the shape graphic setting in manager coordinates.

This method must to be called after the shape graphic setting (in stationary coordinates) has changed.

Overrides:

updateShapeGraphicSettingInManager in class IltObject

Parameters:

manager - The graphic manager

graphic - The graphic representation in manager

newShape - The new shape in stationary coordinates; null means the current value of the shape graphic setting

reason - the reason for the shape change, or null if unknown

Internal method or field: do not use!

applyTransform

public void applyTransform(IltGraphicManager manager,
                           IltGraphic graphic,
                           IlvTransformer transf,
                           IlpPositionSource reason)

Deprecated.

Description copied from class: IltObject

Applies a transform to the location of the graphic representation in a given IltGraphicManager.

Note: t is given relative to the stationary coordinate system, which is the coordinate system used by the other IltObject subclasses API functions.

Note that this method is not supposed to be used when this IltObject is in a DataSource.

Specified by:

applyTransform in class IltObject

Parameters:

manager - The graphic manager where the object is displayed.

graphic - The graphic representation in the manager.

transf - The transform parameter.

reason - The reason for the shape change, or null if unknown

See Also:

IltObject.applyTransform(ilog.tgo.graphic.IltGraphicManager, ilog.views.IlvTransformer), IltGraphicManager.getZoomTransformer()

Deprecated Since:

JTGO 3.5

setCenterPoint

public void setCenterPoint(IltGraphicManager manager,
                           IltGraphic graphic,
                           IlvPoint position,
                           IlpPositionSource reason)

Changes the position of the graphic representation in a given IltGraphicManager.

Specified by:

setCenterPoint in class IltObject

Parameters:

manager - The graphic manager

graphic - The graphic representation in manager

position - The new position

Internal method or field: do not use!

getCenterPoint

protected IlvPoint getCenterPoint(IltGraphicManager manager,
                                  IltGraphic graphic)

Returns the position of the graphic representation in a given IltGraphicManager.

Specified by:

getCenterPoint in class IltObject

Parameters:

manager - The graphic manager

graphic - The graphic representation in manager

Returns:

The centerpoint for the object for the given input

Internal method or field: do not use!

setBaseRectangle

public void setBaseRectangle(IltGraphicManager manager,
                             IlvRect newBaseRectangle)

Applies a transformation to the graphic representation in a given IltGraphicManager, attempting to make the base rectangle resemble the given rectangle.

Specified by:

setBaseRectangle in class IltObject

Parameters:

manager - The graphic manager

newBaseRectangle - Rectangle for base

Internal method or field: do not use!

setShapeInManagerGraphicSetting

public void setShapeInManagerGraphicSetting(IltGraphic graphic,
                                            Object position,
                                            IlpPositionSource reason)

Set the ShapeInManager graphic setting.

Overrides:

setShapeInManagerGraphicSetting in class IltObject

Parameters:

graphic - The graphic associated to the object

position - The position to be set

Internal method or field: do not use!

isItemMoveable

public boolean isItemMoveable(IltGraphic graphic)

Check whether or not a card item should be affected by transformations (when inside a composite card, a card item should not be affected by zooming transformations).

Parameters:

graphic - The graphic associated to the card item

Returns:

true when the card item should be movable; false otherwise

Internal method or field: do not use!

copyFrom

protected void copyFrom(IltCardItem other)

Internal method or field: do not use!