ilog.tgo.model

Class IltCard

java.lang.Object

ilog.cpl.model.IlpDefaultObject

ilog.tgo.model.IltObject

ilog.tgo.model.IltShelfItem

ilog.tgo.model.IltCard

All Implemented Interfaces:

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

Direct Known Subclasses:

IltEmptySlot

public class IltCard
extends IltShelfItem
implements ilog.tgo.model.internal.IltCardItemContainer, IltContainer

IltCard is the class for telecom objects that play the role of cards of telecom equipment.

A card can be either contained in a shelf or in a card-carrier card.

A card can strictly occupy one slot or can span several slots in its container. It can bear states, statuses and alarms like any telecom object.

When a card is created, it is associated with a beginning slot (at some integer position in the shelf or card-carrier card). The number of slots occupied by the card, which is not necessarily an integer, must be provided.

IltCard is also a container for IltCardItem objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltCard.Type This enumeration lists the types of cards.

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
protected ilog.tgo.model.internal.IltCardItemContainerSupport	_container Contains the ShelfItemContainer characteristics of this composite card.
static IltObjectInfo	metainfo Contains metainformation about this IltObject class.
static IltAttribute	TypeAttribute Attribute used to define the type of the shelf item.

Fields inherited from class ilog.tgo.model.IltShelfItem

DirectionAttribute, StateIconsStackingDirection, VerticalLabelStacksGlyphs

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
IltCard(IlpClass ilpClass, Object identifier) Creates a new card with a class and an identifier.
IltCard(IltCard.Type type, IltObjectState state, String label) Creates a new card.
IltCard(IltObjectState state) Creates a new card without a label and with the standard type.
IltCard(IltObjectState state, String label) Creates a new card with the standard type.
IltCard(Object identifier) Creates a new card with an identifier.

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, for use with the symbolic graphic representation style.
IlvPoint	getChildPosition(IltCardItem cardItem) Deprecated. Please use getPosition in the card item itself, or in the component view where it is being displayed.
Enumeration	getChildren() Returns the list of child objects contained in this 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.
IltChildrenModel	getDetailObjects() Deprecated. Container relationships should be declared at the data source level.
static IltObjectInfo	GetIlpClass() Returns the IlpClass corresponding to this Java class.
int	getItemCount() Deprecated. Container relationships should be declared and retrieved at the data source level.
Enumeration	getItems() Deprecated. Container relationships should be declared and retrieved at the data source level.
IltStateHolder	getOverviewObject() Deprecated. Container relationships should be declared at the data source level.
IlvPoint	getParentPosition(IltGraphicManager manager, IltGraphic graphic) Deprecated. Please retrieve the parent object and use getPosition instead.
IlpRelativePoint	getRelativePosition(IltGraphicManager manager, IlvPoint viewPos) Converts the absolute position (IlvPoint) of a card item into a relative position.
IltStatePropagator	getStatePropagator() Deprecated. State propagation at the graphic level is not supported in the network component.
IltCard.Type	getType() Returns the type of the card.
protected IlpAttribute	getTypeAttribute() Returns the attribute that stores type information
IlvPoint	getViewPosition(IltGraphicManager manager, IltCardItem item) Converts the relative position (IlpRelativePoint) of a card item into a view position.
protected void	initializeObject(IltObjectState state, String name) This method is only called by the constructor.
void	removeAllItems() Deprecated. Container relationships should be declared and retrieved at the data source level.
void	removeGraphic(IltGraphicManager manager) Deprecated. Removing an object from the data source that it is contained in is enough to make its graphic representation disappear.
void	removeItem(IltCardItem item) Deprecated. Container relationships should be declared and retrieved at the data source level.
void	setAttributeValue(IlpAttribute attribute, Object value) Sets the value of an attribute of this object.
void	setDetailObjects(IltChildrenModel details) Deprecated. Container relationships should be declared at the data source level.
void	setDirection(int containerDirection) Deprecated. Please use setAttributeValue using the attribute IltCard.DirectionAttribute
void	setItem(IltCardItem item, IlvPoint pos) Deprecated. Container relationships should be declared at the data source level. Please insert your card item in the data source, setting it as child of this card. It will also be necessary to define its position within the card. You can do this, by setting the card item position attribute to a relative point IlpRelativePoint.
void	setOverviewObject(IltStateHolder overview) Deprecated. Container relationships should be declared at the data source level. In the case of cards, the overview object cannot be changed, as it is the card instance itself.
void	setStatePropagator(IltStatePropagator propagator) Deprecated. State propagation at the graphic level is not supported in the network component.
void	setType(IltCard.Type type) Changes the type of the card.

Methods inherited from class ilog.tgo.model.IltShelfItem

applyTransform, CheckDirection, copyFrom, createPositionUpdate, defaultShape, getBaseRectangle, getCenterPoint, getContainer, getDefaultLabelPosition, getLabelDirection, getLabelDirection, getLabelDirection, getMappedForUserList, getOutermostParentGraphic, getShape, getShape, getShapeInManager, isItemMoveable, isShelfItemContainer, isValidPosition, resetLabelDirection, resetLabelDirection, restoreVisibility, setAutomaticDecorationsDirection, setBaseRectangle, setCenterPoint, setContainer, setLabelDirection, setLabelDirection, setProperty, setShape, setShape, setShape, setShapeGraphicSetting, setShapeInManagerGraphicSetting, transformPosition, updateShapeGraphicSettingInManager, usingDefaultShape

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, createTinyBase, debug, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, 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, removeGraphicChangedListener, removeGraphicSetting, removeGraphicSetting, removeProperty, removeStateChangedListener, resetLabelOffset, resetLabelOffset, resetLabelPosition, resetLabelPosition, resetState, setAutomaticDecorationsDirection, setBaseRectangleInManager, setCenterPoint, setCenterPoint, setCenterPointInManager, setEditable, setGraphic, setGraphicSetting, setGraphicSetting, setGraphicSetting, setGraphicSettings, setIlpClass, setLabel, setLabelOffset, setLabelOffset, setLabelPosition, setLabelPosition, setLegend, setLogicalType, setName, setObjectState, setPosition, SetPropertyTransient, setSelected, setSelectedInternal, setState, setState, setTinyType, setVisible, startDelayingComputeGraphic, StartDelayingComputeGraphic, startVisibility, updateFrom

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

Methods inherited from interface ilog.tgo.model.IltContainer

setObjectState

Methods inherited from interface ilog.tgo.model.IltStateHolder

addStateChangedListener, getObjectState, removeStateChangedListener

Field Detail

metainfo

public static IltObjectInfo metainfo

Contains metainformation about this IltObject class.

Internal: do not use!

TypeAttribute

public static IltAttribute TypeAttribute

Attribute used to define the type of the shelf item.

Attribute name: type

Value type: IltCard.Type.

Since:

JTGO 4.0

See Also:

IltCard.Type

_container

protected transient ilog.tgo.model.internal.IltCardItemContainerSupport _container

Contains the ShelfItemContainer characteristics of this composite card.

Internal: do not use!

Constructor Detail

IltCard

public IltCard(Object identifier)

Creates a new card with an identifier.

The name can be set afterwards with setName function. The type can be modified afterwards with the setType method.

Parameters:

identifier - The identifier of this new instance.

Since:

JTGO 3.0

IltCard

public IltCard(IlpClass ilpClass,
               Object identifier)

Creates a new card with a class and an identifier.

The name can be set afterwards with the setName function. The type can be modified afterwards with the setType method.

Parameters:

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

identifier - The identifier of this new instance.

Since:

JTGO 3.0

IltCard

public IltCard(IltObjectState state)

Creates a new card without a label and with the standard type.

The name can be set afterwards with setName function. The type can be modified afterwards with the setType method.

Parameters:

state - The semantic state of the card.

IltCard

public IltCard(IltObjectState state,
               String label)

Creates a new card with the standard type.

The type can be modified afterwards with the setType method.

Parameters:

state - The semantic state of the card.

label - The name that will appear on the card.

IltCard

public IltCard(IltCard.Type type,
               IltObjectState state,
               String label)

Creates a new card.

Parameters:

type - The type of the card.

state - The semantic state of the card.

label - The name that will appear on the card.

Method Detail

getTypeAttribute

protected IlpAttribute getTypeAttribute()

Description copied from class: IltShelfItem

Returns the attribute that stores type information

Specified by:

getTypeAttribute in class IltShelfItem

Internal: do not use!

initializeObject

protected void initializeObject(IltObjectState state,
                                String name)

This method is only called by the constructor.

Overrides:

initializeObject in class IltShelfItem

See Also:

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

Internal: do not use!

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

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

removeGraphic

@Deprecated
public void removeGraphic(IltGraphicManager manager)

Deprecated. Removing an object from the data source that it is contained in is enough to make its graphic representation disappear.

Removes the graphic representation of this object from a given IltGraphicManager.

Overrides:

removeGraphic in class IltObject

Deprecated Since:

JTGO 3.5

getChildren

public Enumeration getChildren()

Returns the list of child objects contained in this object.

Overrides:

getChildren in class IltObject

Returns:

An Enumeration of IltStateHolder objects.

Internal: 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 IltShelfItem

Parameters:

attribute - The attribute for which the value is being 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

createBase

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

Creates a base element, suitable for this particular kind of object, for use with the symbolic graphic representation style.

Specified by:

createBase in class IltObject

See Also:

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

Internal: do not use!

getDetailObjects

@Deprecated
public IltChildrenModel getDetailObjects()

Deprecated. Container relationships should be declared at the data source level.

Access method for the child model describing the set of detail objects.

Specified by:

getDetailObjects in interface IltContainer

Returns:

A reference to the child model.

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

setDetailObjects

@Deprecated
public void setDetailObjects(IltChildrenModel details)

Deprecated. Container relationships should be declared at the data source level.

Sets or replaces the child model object.

Note that the set of a new detail object can be dynamic, see class IltChildrenModelListener.

To be able to use the setItem, removeItem and removeItems methods, details must be an instance of a subclass of IltDefaultChildrenModel.

Specified by:

setDetailObjects in interface IltContainer

Parameters:

details - The new detail object to be set, it must be a subclass of the IltDefaultChildrenModel class

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

getOverviewObject

@Deprecated
public IltStateHolder getOverviewObject()

Deprecated. Container relationships should be declared at the data source level.

Access method for the overview object.

Specified by:

getOverviewObject in interface IltContainer

Returns:

A reference to the card container itself.

Deprecated Since:

JTGO 4.0

setOverviewObject

@Deprecated
public void setOverviewObject(IltStateHolder overview)

Deprecated. Container relationships should be declared at the data source level. In the case of cards, the overview object cannot be changed, as it is the card instance itself.

Sets or replaces the overview object. Since the overview object of a IltCard instance is given by the instance itself, this method should not be called and will throw a runtime exception.

Specified by:

setOverviewObject in interface IltContainer

Parameters:

overview - The new overview object to be set.

Deprecated Since:

JTGO 4.0

getStatePropagator

@Deprecated
public IltStatePropagator getStatePropagator()

Deprecated. State propagation at the graphic level is not supported in the network component.

Access method for the state propagator rules which defines the state of the container.

Specified by:

getStatePropagator in interface IltContainer

Returns:

A reference to the state propagator.

Deprecated Since:

JTGO 4.0

setStatePropagator

@Deprecated
public void setStatePropagator(IltStatePropagator propagator)

Deprecated. State propagation at the graphic level is not supported in the network component.

Sets or replaces the state propagator which defines the state of the container.

Specified by:

setStatePropagator in interface IltContainer

Parameters:

propagator - The new state propagator set of rules.

Deprecated Since:

JTGO 4.0

setItem

@Deprecated
public void setItem(IltCardItem item,
                                IlvPoint pos)

Deprecated. Container relationships should be declared at the data source level. Please insert your card item in the data source, setting it as child of this card. It will also be necessary to define its position within the card. You can do this, by setting the card item position attribute to a relative point IlpRelativePoint.

Adds a child item to this container at a given position.

The position is relative to the container origin.

The container origin depends on the currently set direction: if the container direction is Top, the origin is the top-left corner of the base;

if the container direction is Right, the origin is the top-right corner of the base;

if the container direction is Bottom, the origin is the bottom-right corner of the base;

if the container direction is Left, the origin is the bottom-left corner of the base.

If the container already has a graphic representation, computeGraphic will automatically be called on the child item in all the managers that include the container.

Specified by:

setItem in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

item - Item inserted in the container.

pos - Position relative to the container origin.

See Also:

IltDefaultDataSource, IlpRelativePoint

Deprecated Since:

JTGO 4.0

getItems

@Deprecated
public Enumeration getItems()

Deprecated. Container relationships should be declared and retrieved at the data source level.

Access method to retrieve all child items.

Specified by:

getItems in interface ilog.tgo.model.internal.IltCardItemContainer

Returns:

An Enumeration containing all child items.

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

removeItem

@Deprecated
public void removeItem(IltCardItem item)

Deprecated. Container relationships should be declared and retrieved at the data source level.

Removes a child item from the container, and all its associated graphic representations, if any.

Specified by:

removeItem in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

item - The object to be removed from the container.

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

removeAllItems

@Deprecated
public void removeAllItems()

Deprecated. Container relationships should be declared and retrieved at the data source level.

Removes all the child items from the container, and all its associated graphic representations, if any.

Specified by:

removeAllItems in interface ilog.tgo.model.internal.IltCardItemContainer

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

getItemCount

@Deprecated
public int getItemCount()

Deprecated. Container relationships should be declared and retrieved at the data source level.

Returns the number of objects (children) associated with the container.

Specified by:

getItemCount in interface ilog.tgo.model.internal.IltCardItemContainer

Returns:

The number of child items within the container.

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

getParentPosition

@Deprecated
public IlvPoint getParentPosition(IltGraphicManager manager,
                                              IltGraphic graphic)

Deprecated. Please retrieve the parent object and use getPosition instead.

Method to retrieve the origin point of the container, used internally to compute the card item relative position.

Specified by:

getParentPosition in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

manager - The graphic manager holding the object representation.

graphic - The graphic associated to the object.

Returns:

A reference to the container origin.

Deprecated Since:

JTGO 3.5

getChildPosition

@Deprecated
public IlvPoint getChildPosition(IltCardItem cardItem)

Deprecated. Please use getPosition in the card item itself, or in the component view where it is being displayed.

Method to retrieve the original relative position of a card item.

Specified by:

getChildPosition in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

cardItem - The given card item.

Returns:

The relative card item position, or null if it could not be found.

See Also:

IltObject.getPosition(), IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)

Deprecated Since:

JTGO 4.0

getViewPosition

public IlvPoint getViewPosition(IltGraphicManager manager,
                                IltCardItem item)

Converts the relative position (IlpRelativePoint) of a card item into a view position.

Specified by:

getViewPosition in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

manager - The graphic manager for the objects.

item - The item containing the relative position.

Returns:

The corresponding absolute position.

Internal: do not use!

getRelativePosition

public IlpRelativePoint getRelativePosition(IltGraphicManager manager,
                                            IlvPoint viewPos)

Converts the absolute position (IlvPoint) of a card item into a relative position.

Specified by:

getRelativePosition in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

manager - The graphic manager for the objects.

viewPos - The absolute position (view position) for the item.

Returns:

The corresponding absolute position.

Internal: do not use!

setDirection

@Deprecated
public void setDirection(int containerDirection)

Deprecated. Please use setAttributeValue using the attribute IltCard.DirectionAttribute

Recursively changes the direction of the container and all its items by updating the local values of IltObject.Direction.

This method should be called when all card items have been inserted in the container and after each change in the container content.

The direction of the items are set accordingly, to meet the new position of the container. This method changes the IltObject.Direction style value, which is computed through a style value provider, based on the IltShelf.DirectionAttribute. Note that using this method will override the style value provider of the shelf and all its children.

Multiple context is not supported within this method, all legend values are computed and set based on the default context only.

This method is provided only to support IltShelf.setDirection and IltCardCarrier.setDirection, that are deprecated.

Specified by:

setDirection in interface ilog.tgo.model.internal.IltCardItemContainer

Parameters:

containerDirection - either IlvDirection.Top or IlvDirection.Bottom or IlvDirection.Left or IlvDirection.Right

Internal: do not use!

Deprecated Since:

JTGO 3.0

getType

public IltCard.Type getType()

Returns the type of the card.

setType

public void setType(IltCard.Type type)

Changes the type of the card.