IltShelfItem (Perforce JViews 10.0 API)

java.lang.Object
- ilog.cpl.model.IlpDefaultObject
- - ilog.tgo.model.IltObject
  - - ilog.tgo.model.IltShelfItem

All Implemented Interfaces:

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

Direct Known Subclasses:

IltCard, IltCardCarrier
```
public abstract class IltShelfItem
extends IltObject
```
This class represents the telecom objects which play the role of shelf items:
- Cards,
- Card carriers and
- Empty slots.
This class is a base class that represents the graphics to be associated with one or several slots of instances of IltShelfGraphic. Three kinds of IltShelfItem are available as concrete subclasses: empty slots (IltEmptySlot class), cards (IltCard class) and card-carrier cards (IltCardCarrier class).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IltShelfItem.Type
The abstract class that is used to manage the types of the subclasses of IltShelfItem.
- Nested classes/interfaces inherited from class ilog.tgo.model.IltObject
  IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType

Nested Classes
Modifier and Type	Class and Description
`static class`	`IltShelfItem.Type` The abstract class that is used to manage the types of the subclasses of IltShelfItem.

Field Summary

Fields
Modifier and Type	Field and Description
`static IltAttribute`	`DirectionAttribute` Attribute used to define the direction of a shelf item.
`static IltObjectInfo`	`metainfo` Contains metainformation about this `IltObject` class.
`static IlpIntegerKey`	`StateIconsStackingDirection` Deprecated. Please use CSS property `secondaryStateDirection` instead.
`static IlpBooleanKey`	`VerticalLabelStacksGlyphs` Deprecated. Please use CSS property `verticalLabelStacksGlyphs` instead.

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
`IltShelfItem(IlpClass ilpClass, Object identifier)` Creates a new shelf item with the given class and identifier.
`IltShelfItem(IltObjectState state)` Creates a new instance of `IltShelfItem`, with a given semantic state.
`IltShelfItem(IltObjectState state, String label)` Creates a new instance of `IltShelfItem` with a given semantic state and label.
`IltShelfItem(IltShelfItem.Type type, IltObjectState state, String label)` Creates a new instance of `IltShelfItem` with a given type, semantic state and label.
`IltShelfItem(Object identifier)` Creates a new shelf item with the given identifier.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer t, IlpPositionSource reason)` Deprecated.
`static boolean`	`CheckDirection(int direction)` Checks if the given direction is valid to the shelf item.
`protected void`	`copyFrom(IltShelfItem 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.
`Object`	`defaultShape()` Returns the default shape, used when an object is made visible without having been assigned a shape.
`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 center point with the manager's transformer applies
`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.
`IltShelfItemContainer`	`getContainer()` Returns the container (an instance of `IltShelfItemContainer`) of this IltShelfItem.
`int`	`getDefaultLabelPosition(IltGraphic graphic)` Returns a default label position, if the value set in the legend is `IlvDirection.BadPosition`.
`static IltObjectInfo`	`GetIlpClass()` Returns the `IlpClass` corresponding to this Java class.
`int`	`getLabelDirection()` Deprecated. Please use CSS property `labelDirection` instead.
`int`	`getLabelDirection(IltGraphic graphic)` Returns the direction of the label set for the given graphic instance.
`int`	`getLabelDirection(IltGraphicManager manager)` Deprecated. Please use CSS property `labelDirection` instead.
`ilog.util.internal.IlAVector`	`getMappedForUserList()`
`IltGraphic`	`getOutermostParentGraphic(IltGraphicManager manager)` This method is overwritten by the subclasses which can be contained in other IltObjects.
`IlvRect`	`getShape(IltGraphicManager manager)` Deprecated. Adding a object to a datasource, connected to a graphic component such as an `IlpNetwork`, is enough to make its graphic representation visible. When working with datasource, please use `getPosition` instead.
`IlvRect`	`getShape(IltGraphicManager manager, IltGraphic graphic)` Returns the shape graphic setting.
`protected IlvRect`	`getShapeInManager(IltGraphicManager manager, IltGraphic graphic)` Returns the position of the graphic representation in a given IltGraphicManager.
`protected abstract IlpAttribute`	`getTypeAttribute()` Returns the attribute that stores type information
`protected void`	`initializeObject(IltObjectState state, String name)` This method is only called by the constructor.
`protected boolean`	`isItemMoveable(IltGraphic graphic)` Returns `true` if this item can be moved.
`boolean`	`isShelfItemContainer()` Returns `true` if this item can contain other shelf items.
`boolean`	`isValidPosition(Object position)` Determines whether the argument is a valid position/shape for this type of object.
`void`	`resetLabelDirection()` Deprecated. Please use CSS property `labelDirection` instead.
`void`	`resetLabelDirection(IltGraphicManager manager)` Deprecated. Please use CSS property `labelDirection` instead.
`void`	`restoreVisibility(IltGraphicManager manager, IltGraphicSettings settings)` 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.
`void`	`setAttributeValue(IlpAttribute attribute, Object value)` Sets the value of an attribute of this object.
`void`	`setAutomaticDecorationsDirection(IlpContext context, boolean automaticDecorationsDirection)` Overwrites the method from IltObject
`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(IltShelfItemContainer shelfCont)` Specifies the container of this IltShelfItem.
`void`	`setLabelDirection(IltGraphicManager manager, int direction)` Deprecated. Please use CSS property `labelDirection` instead.
`void`	`setLabelDirection(int direction)` Deprecated. Please use CSS property `labelDirection` instead.
`void`	`setProperty(Object name, Object value)` Sets the named property.
`void`	`setShape(IltGraphicManager manager, IltGraphic graphic, IlvRect position, IlpPositionSource reason)` Changes the shape graphic setting.
`void`	`setShape(IltGraphicManager manager, IlvRect shape)` Deprecated. Adding a object to a datasource, connected to a graphic component such as an `IlpNetwork`, is enough to make its graphic representation visible. When working with datasource, please use `getPosition` instead.
`void`	`setShape(IltGraphicManager manager, IlvRect shape, IlpPositionSource reason)` Deprecated. Adding a object to a datasource, connected to a graphic component such as an `IlpNetwork`, is enough to make its graphic representation visible. When working with datasource, use `IltObject.setPosition(IlpPosition)` instead.
`void`	`setShapeGraphicSetting(IltGraphic graphic, Object newShape)` Sets the graphic settings responsible for the shape of the object.
`void`	`setShapeInManagerGraphicSetting(IltGraphic graphic, Object newShape, IlpPositionSource reason)`
`Object`	`transformPosition(IltGraphicManager manager, Object position)` Calculates the transformed position according to the manager's transformer and the given 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.
`boolean`	`usingDefaultShape(IltGraphicManager manager)` Computes the graphic representation of the object in the given manager.

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, createTinyBase, debug, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, getChildren, 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, 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

- Field Detail
  - metainfo
```
public static IltObjectInfo metainfo
```
    Contains metainformation about this IltObject class.
    
    Internal: do not use!
  - DirectionAttribute
```
public static IltAttribute DirectionAttribute
```
    Attribute used to define the direction of a shelf item.
    Attribute name: direction.
    Value type: IlpDirection.
    The CSS property direction is, by default, set to the value of this attribute.
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IlpDirection
  - StateIconsStackingDirection
```
@Deprecated
public static IlpIntegerKey StateIconsStackingDirection
```
    Deprecated. Please use CSS property secondaryStateDirection instead.
    
    The legend property denoting the stacking direction of secondary states icons. Possible values are IlvDirection.Top, IlvDirection.Bottom, IlvDirection.Right, IlvDirection.Left.
    IlvDirection.Vertical and IlvDirection.Horizontal are also valid for historical reasons and are equivalent to IlvDirection.Top and IlvDirection.Right.
    
    See Also:
    
    IltObjectCustomization.getSecondaryStateDirection()
    
    Deprecated Since:
    
    JTGO 3.5
  - VerticalLabelStacksGlyphs
```
@Deprecated
public static IlpBooleanKey VerticalLabelStacksGlyphs
```
    Deprecated. Please use CSS property verticalLabelStacksGlyphs instead.
    
    The legend property denoting the way vertical labels are built.
    This value is used together with IltObject.LabelDirection. If true and if IltObject.LabelDirection is set to either IlvDirection.Top or IlvDirection.Bottom, the character glyphs are stacked under each other. If false, the label will be positioned according to the value of IltObject.LabelDirection.
    
    See Also:
    
    IltObjectCustomization.isVerticalLabelStacksGlyphs()
    
    Deprecated Since:
    
    JTGO 3.5
- Constructor Detail
  - IltShelfItem
```
public IltShelfItem(Object identifier)
```
    Creates a new shelf item with the given identifier.
    
    Parameters:
    
    identifier - the identifier of this new instance
    
    Since:
    
    JTGO 3.0
  - IltShelfItem
```
public IltShelfItem(IlpClass ilpClass,
                    Object identifier)
```
    Creates a new shelf item with the given class and identifier.
    
    Parameters:
    
    ilpClass - the business class of this new instance. It must be a subclass of IltShelfItem
    
    identifier - the identifier of this new instance
    
    Since:
    
    JTGO 3.0
  - IltShelfItem
```
public IltShelfItem(IltObjectState state)
```
    Creates a new instance of IltShelfItem, with a given semantic state. This state object is destructively modified later.
  - IltShelfItem
```
public IltShelfItem(IltObjectState state,
                    String label)
```
    Creates a new instance of IltShelfItem with a given semantic state and label.
  - IltShelfItem
```
public IltShelfItem(IltShelfItem.Type type,
                    IltObjectState state,
                    String label)
```
    Creates a new instance of IltShelfItem with a given type, semantic state and 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
  - 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
  - getTypeAttribute
```
protected abstract IlpAttribute getTypeAttribute()
```
    Returns the attribute that stores type information
    
    Internal: do not use!
  - 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!
  - setProperty
```
public void setProperty(Object name,
                        Object value)
```
    Sets the named property. This method was overwritten here just to avoid the set of the properties which were replaced by the legend keys: Label direction and offset.
    
    Specified by:
    
    setProperty in interface IlWithProperties
    
    Overrides:
    
    setProperty in class IltObject
    
    Parameters:
    
    name - Property identifier
    
    value - Property value
    
    Internal: do not use!
  - copyFrom
```
protected void copyFrom(IltShelfItem other)
```
    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 IltObject
    
    Parameters:
    
    attribute - The attribute which 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
  - getContainer
```
public IltShelfItemContainer getContainer()
```
    Returns the container (an instance of IltShelfItemContainer) of this IltShelfItem.
  - restoreVisibility
```
@Deprecated
public void restoreVisibility(IltGraphicManager manager,
                                          IltGraphicSettings settings)
```
    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.
    
    This implementation does nothing if this shelf item is contained. It calls super.restoreVisibility if it is not contained.
    
    Overrides:
    
    restoreVisibility in class IltObject
    
    See Also:
    
    IltObject.setGraphicSettings(ilog.tgo.graphic.IltGraphicManager, ilog.tgo.graphic.IltGraphicSettings)
    
    Deprecated Since:
    
    JTGO 3.5
  - setContainer
```
public void setContainer(IltShelfItemContainer shelfCont)
```
    Specifies the container of this IltShelfItem. Only JTGO can do it.
    
    Internal: do not use!
  - isShelfItemContainer
```
public boolean isShelfItemContainer()
```
    Returns true if this item can contain other shelf items.
    
    Internal: do not use!
  - isItemMoveable
```
protected boolean isItemMoveable(IltGraphic graphic)
```
    Returns true if this item can be moved. Shelf items can only be moved if they are outside a shelf or card carrier, or if they are in its logical/tiny representation.
    
    Internal: do not use!
  - getOutermostParentGraphic
```
public IltGraphic getOutermostParentGraphic(IltGraphicManager manager)
```
    This method is overwritten by the subclasses which can be contained in other IltObjects. This is valid for shelf items which are inside shelves.
    
    Internal: do not use!
  - transformPosition
```
public Object transformPosition(IltGraphicManager manager,
                                Object position)
```
    Calculates the transformed position according to the manager's transformer and the given parameter. the given shape.
    
    Specified by:
    
    transformPosition in class IltObject
    
    Internal: do not use!
  - isValidPosition
```
public boolean isValidPosition(Object position)
```
    Description copied from class: IltObject
    Determines whether the argument is a valid position/shape for this type of object.
    This function overridden in subclasses. Accepted positions are:
    - IlvPoint for IltNetworkElement, IltOffPageConnector, IltShelf,
    - IlvRect for IltRectGroup, IltShelfItem,
    - IlpPolyline for IltAbstractLink, IltLinearGroup,
    - IlpPolygon for IltPolyGroup.
    Specified by:
    
    isValidPosition in class IltObject
    
    Internal: 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: do not use!
  - usingDefaultShape
```
public boolean usingDefaultShape(IltGraphicManager manager)
```
    Computes the graphic representation of the object in the given manager. This method is used internally. If the graphical representation of the object is not yet created, then it creates the representation with the given shape. Otherwise, it verifies if the current shape is the default one, and only in this case it used the new shape. If the current shape is not the default, we assume it was set by the user, and let it as it is.
    
    Overrides:
    
    usingDefaultShape in class IltObject
    
    Internal: 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.
    
    Overrides:
    
    updateShapeGraphicSettingInManager in class IltObject
    
    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: do not use!
  - getShape
```
@Deprecated
public IlvRect getShape(IltGraphicManager manager)
```
    Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasource, please use getPosition instead.
    
    Returns the shape of the graphic representation in a given IltGraphicManager.
    Note that this method is not supposed to be used when this IltShelfItem is in a DataSource.
    
    Parameters:
    
    manager - The graphic manager where this object will be displayed.
    
    Deprecated Since:
    
    JTGO 3.5
  - getShape
```
public IlvRect getShape(IltGraphicManager manager,
                        IltGraphic graphic)
```
    Returns the shape graphic setting.
    
    Internal: do not use!
  - setShape
```
@Deprecated
public void setShape(IltGraphicManager manager,
                                 IlvRect shape)
```
    Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasource, please use getPosition instead.
    
    Changes the shape of the graphic representation in a given IltGraphicManager.
    Note that this method is not supposed to be used when this IltShelfItem is in a DataSource.
    
    Parameters:
    
    manager - The graphic manager where this object will be displayed.
    
    shape - The new shape.
    
    Deprecated Since:
    
    JTGO 3.5
  - setShape
```
@Deprecated
public void setShape(IltGraphicManager manager,
                                 IlvRect shape,
                                 IlpPositionSource reason)
```
    Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. When working with datasource, use IltObject.setPosition(IlpPosition) instead.
    
    Changes the shape of the graphic representation in a given IltGraphicManager.
    Note that this method is not supposed to be used when this IltShelfItem is in a DataSource.
    
    Parameters:
    
    manager - The graphic manager where this object will be displayed.
    
    shape - The new shape.
    
    reason - The reason for the shape change, or null if unknown
    
    Deprecated Since:
    
    JTGO 3.5
  - setShape
```
public void setShape(IltGraphicManager manager,
                     IltGraphic graphic,
                     IlvRect position,
                     IlpPositionSource reason)
```
    Changes the shape graphic setting.
    
    Internal: do not use!
  - getShapeInManager
```
protected IlvRect getShapeInManager(IltGraphicManager manager,
                                    IltGraphic graphic)
```
    Returns the position of the graphic representation in a given IltGraphicManager.
    
    Internal: do not use!
  - getCenterPoint
```
protected IlvPoint getCenterPoint(IltGraphicManager manager,
                                  IltGraphic graphic)
```
    Returns the center point with the manager's transformer applies
    
    Specified by:
    
    getCenterPoint in class IltObject
    
    Internal: do not use!
  - 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
    
    Internal: do not use!
  - applyTransform
```
@Deprecated
public void applyTransform(IltGraphicManager manager,
                                       IltGraphic graphic,
                                       IlvTransformer t,
                                       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.
    
    t - 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
  - setShapeGraphicSetting
```
public void setShapeGraphicSetting(IltGraphic graphic,
                                   Object newShape)
```
    Sets the graphic settings responsible for the shape of the object.
    
    Overrides:
    
    setShapeGraphicSetting in class IltObject
    
    Internal: do not use!
  - setShapeInManagerGraphicSetting
```
public void setShapeInManagerGraphicSetting(IltGraphic graphic,
                                            Object newShape,
                                            IlpPositionSource reason)
```
    Overrides:
    
    setShapeInManagerGraphicSetting in class IltObject
    
    Internal: do not use!
  - 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: 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
    
    Internal: do not use!
  - defaultShape
```
public Object defaultShape()
```
    Returns the default shape, used when an object is made visible without having been assigned a shape.
    
    Overrides:
    
    defaultShape in class IltObject
    
    Internal: do not use!
  - CheckDirection
```
public static boolean CheckDirection(int direction)
```
    Checks if the given direction is valid to the shelf item.
    
    Internal: do not use!
  - getDefaultLabelPosition
```
public int getDefaultLabelPosition(IltGraphic graphic)
```
    Returns a default label position, if the value set in the legend is IlvDirection.BadPosition.
    
    Overrides:
    
    getDefaultLabelPosition in class IltObject
    
    Internal: do not use!
  - getLabelDirection
```
@Deprecated
public int getLabelDirection()
```
    Deprecated. Please use CSS property labelDirection instead.
    
    Returns the direction of the label : Top, Bottom, Left or Right set as a default value for this telecom object.
    The value is retrieved from the object style that is present in the default application context.
    
    Deprecated Since:
    
    JTGO 3.0
  - getLabelDirection
```
@Deprecated
public int getLabelDirection(IltGraphicManager manager)
```
    Deprecated. Please use CSS property labelDirection instead.
    
    Returns the direction of the label set for the graphic instance in the given manager.
    
    Deprecated Since:
    
    JTGO 3.5
  - getLabelDirection
```
public int getLabelDirection(IltGraphic graphic)
```
    Returns the direction of the label set for the given graphic instance.
    
    Internal: do not use!
  - setLabelDirection
```
@Deprecated
public void setLabelDirection(int direction)
                                   throws IltSlotInvalidPositionException
```
    Deprecated. Please use CSS property labelDirection instead.
    
    Sets the label direction which is used as the default value for the graphical instances of this telecom object.
    This method updates also all the previously created instances which use the default value.
    This method throws an IltSlotInvalidPositionException if the given direction value is different from IlvDirection.Top, Bottom, Left or Right.
    The value is set in the object style that is present in the default application context.
    
    Throws:
    
    IltSlotInvalidPositionException
    
    Deprecated Since:
    
    JTGO 3.0
  - setLabelDirection
```
@Deprecated
public void setLabelDirection(IltGraphicManager manager,
                                          int direction)
                                   throws IltSlotInvalidPositionException
```
    Deprecated. Please use CSS property labelDirection instead.
    
    Sets the label direction of the graphic instances of the given manager.
    This method throws an IltSlotInvalidPositionException if the given direction value is different from IlvDirection.Top, Bottom, Left or Right.
    
    Throws:
    
    IltSlotInvalidPositionException
    
    Deprecated Since:
    
    JTGO 3.5
  - resetLabelDirection
```
@Deprecated
public void resetLabelDirection()
```
    Deprecated. Please use CSS property labelDirection instead.
    
    Resets the label direction to the default value.
    All instances which currently use this default value are updated.
    The value is reset in the object style that is present in the default application context.
    
    Deprecated Since:
    
    JTGO 3.0
  - resetLabelDirection
```
@Deprecated
public void resetLabelDirection(IltGraphicManager manager)
```
    Deprecated. Please use CSS property labelDirection instead.
    
    Resets the default value of the label direction of the graphical representation in the given manager.
    
    Deprecated Since:
    
    JTGO 3.5
  - setAutomaticDecorationsDirection
```
public void setAutomaticDecorationsDirection(IlpContext context,
                                             boolean automaticDecorationsDirection)
```
    Overwrites the method from IltObject
    
    Overrides:
    
    setAutomaticDecorationsDirection in class IltObject
    
    Internal: do not use!
  - getMappedForUserList
```
public ilog.util.internal.IlAVector getMappedForUserList()
```
    Overrides:
    
    getMappedForUserList in class IltObject
    
    Internal: do not use!

Class IltShelfItem

Nested Class Summary

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

Field Summary

Fields inherited from class ilog.tgo.model.IltObject

Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.model.IltObject

Methods inherited from class ilog.cpl.model.IlpDefaultObject

Methods inherited from class java.lang.Object

Field Detail

metainfo

DirectionAttribute

StateIconsStackingDirection

VerticalLabelStacksGlyphs

Constructor Detail

IltShelfItem

IltShelfItem

IltShelfItem

IltShelfItem

IltShelfItem

Method Detail

GetIlpClass

GetClassLegend

getTypeAttribute

initializeObject

setProperty

copyFrom

setAttributeValue

getContainer

restoreVisibility

setContainer

isShelfItemContainer

isItemMoveable

getOutermostParentGraphic

transformPosition

isValidPosition

createPositionUpdate

usingDefaultShape

updateShapeGraphicSettingInManager

getShape

getShape

setShape

setShape

setShape

getShapeInManager

getCenterPoint

setCenterPoint

applyTransform

setShapeGraphicSetting

setShapeInManagerGraphicSetting

getBaseRectangle

setBaseRectangle

defaultShape

CheckDirection

getDefaultLabelPosition

getLabelDirection

getLabelDirection

getLabelDirection

setLabelDirection

setLabelDirection

resetLabelDirection

resetLabelDirection

setAutomaticDecorationsDirection

getMappedForUserList