IltShelf (Perforce JViews 10.0 API)

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

All Implemented Interfaces:

IlpAttributeValueHolder, IlpObject, IltContainer, IltShelfItemContainer, IltStateHolder, ilog.tgo.model.state.event.IltObjectStateListener, IltWithProperties, IlWithProperties, EventListener
```
public class IltShelf
extends IltObject
implements IltShelfItemContainer, IltContainer
```
The IltShelf class is used to represent shelf configurations.
A shelf is made up of a given number of horizontal slots (x slots) and vertical slots (y slots) forming a rectangular matrix of variable-sized slots.

The shelf graphic representation consists of a frame divided into rectangles (one for each slot with its corresponding width and height). Each slot column is assigned a number which is displayed either below (default) or above the shelf outline. The slot columns are numbered continuously from a given initial value or according to the slot labels configured using cascading style sheets.

IltShelf objects play the role of graphic containers for any IltObject; they are especially suitable for shelf items of the following classes: IltCard, IltEmptySlot and IltCardCarrier.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IltShelf.Type
This enumeration lists the types of shelves.
- 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`	`IltShelf.Type` This enumeration lists the types of shelves.

Field Summary

Fields
Modifier and Type	Field and Description
`static IltAttribute`	`DirectionAttribute` Attribute used to define the direction of the shelf.
`static IlpColorKey`	`FrameColor` Deprecated. Please use CSS property `frameColor` instead.
`static IltObjectInfo`	`metainfo` Contains metainformation about this `IltObject` class.
`static IltAttribute`	`SlotSizesAttribute` Attribute that manages the number of slots and its dimensions.
`static IltAttribute`	`TypeAttribute` Attribute used to define the type of the shelf.
`static IltAttribute`	`XSlotFirstIndex` Deprecated. Please use `IltShelf.XSlotIndexAttribute` instead.
`static IltAttribute`	`XSlotIndexAttribute` Aa attribute used to define the logical first index for the slots along the `X` axis of a shelf.
`static IlpStringArrayKey`	`XSlotLabels` Stores the labels that shall be used as slot labels when drawing a shelf
`static IlpIntegerKey`	`XSlotNumbersOffset` Deprecated. Please use CSS property `XSlotNumbersOffset` instead.
`static IlpBooleanKey`	`XSlotNumbersOnTop` Deprecated. Please use CSS property `XSlotNumbersOnTop` 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
`IltShelf(IlpClass ilpClass, Object identifier)` Creates a new shelf with the given identifier.
`IltShelf(int[] xSlotWidths, int[] ySlotWidths, int xSlotIndex)` This constructor creates an instance of a standard `IltShelf` with variable-width slots.
`IltShelf(int[] slotWidths, int slotHeight, int logicalFirstIndex)` This constructor creates an instance of a standard type `IltShelf` with variable-width slots.
`IltShelf(int sCount, int sWidth, int sHeight, int index)` This constructor creates an instance of `IltShelf` with fixed-width slots, and with the Standard type.
`IltShelf(int numXSlots, int widthXSlot, int numYSlots, int widthYSlot, int xSlotIndex)` This constructor creates an instance of a standard `IltShelf` with fixed-width slots.
`IltShelf(Object identifier)` Creates a new shelf with the given identifier.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`applyTransform(IltGraphicManager manager, IltGraphic graphic, IlvTransformer t, IlpPositionSource reason)` Deprecated.
`boolean`	`areSlotNumsOnTop()` Deprecated. Please use the CSS property `XSlotNumbersOnTop` instead.
`void`	`checkItem(IltObject item, IlpShelfItemPosition position)` Check the position for a given item, verifying if indexes and spans are valid, and also checking if the item can fit into the container.
`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.
`protected void`	`copyFrom(IltObject o)` Copies the attributes from an original object.
`ilog.tgo.graphic.internal.base.IltBaseElement`	`createBase(IltcGraphicElementAggregate root)` Creates a base element, suitable for this particular kind of object.
`void`	`createGraphic(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.
`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.
`int`	`findItem(IltObject item)` Deprecated. Please use the `IltShelfItem.getPosition` or retrieve the shelf item position from the component view.
`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.
`Enumeration`	`getChildren()` Deprecated. In the future, relationships will only be defined at the datasource level.
`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. Containment relationships should be declared at the Datasource level.
`static IltObjectInfo`	`GetIlpClass()` Returns the `IlpClass` corresponding to this Java class.
`IltObject`	`getItem(int slotIndex)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`IltObject`	`getItem(int xSlotIndex, int ySlotIndex)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`IlpShelfItemPosition`	`getItemPosition(IltObject item)` Deprecated. Please use the `IltShelfItem.getPosition` or retrieve the shelf item position from the component view.
`IlvRect`	`getItemRect(IltGraphicManager manager, IltObject item)` Deprecated. Adding a object to a datasource, connected to a graphic component such as an `IlpNetwork`, is enough to make its graphic representation visible. Retrieve the bounding box of the children object from its graphic representation.
`Enumeration`	`getItems()` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`Enumeration`	`getItems(int slotIndex, double slotSpan)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`Enumeration`	`getItems(int xSlotIndex, double xSlotSpan, int ySlotIndex, double ySlotSpan)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`double`	`getItemSpan(int slotIndex)` Deprecated. Please use the `IltShelfItem.getPosition` or retrieve the shelf item position from the component view.
`int`	`getLogicalFirstIndex()` Deprecated. Use the method `getAttributeValue` to retrieve the `XSlotIndexAttribute` attribute instead.
`ilog.util.internal.IlAVector`	`getMappedForUserList()`
`IltStateHolder`	`getOverviewObject()` Deprecated. Containment relationships should be declared at the Datasource level.
`int`	`getSizeOtherDimension()` Returns the size of the other dimension for all the slots.
`int`	`getSlotCount()` Accesses the total number of slots in the container.
`int`	`getSlotNumSpace()` Deprecated. Please use the CSS property `XSlotNumbersOffset` instead.
`int[]`	`getSlotSizes()` Returns the slot sizes.
`double`	`getSlotSpanX(int xIndex, int yIndex)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`double`	`getSlotSpanY(int xIndex, int yIndex)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`IltStatePropagator`	`getStatePropagator()` Deprecated. State propagation at the graphic level is not supported in the Network Component.
`IlvPoint`	`getTopLeftPoint(IltGraphicManager manager)` Deprecated. Please use `getPosition` instead.
`protected IlvPoint`	`getTopLeftPoint(IltGraphicManager manager, IltGraphic graphic)` Returns the shape graphic setting.
`IltShelf.Type`	`getType()` Returns the type of the shelf.
`int[]`	`getXSlotSizes()` Accesses the sizes of the slots along the `x` axis.
`int[]`	`getYSlotSizes()` Accesses the sizes of the slots along the `y` axis.
`void`	`initializeCreatedGraphic(IltGraphicManager manager, IltGraphic graphic)` This method must be called just after preCreateGraphic to initialize any needed property or graphic setting.
`protected void`	`initializeObject(IltObjectState state, String name)` This method is only called by the constructor.
`protected void`	`initializeShelf(int[] xSlotWidths, int[] ySlotWidths, int xSlotIndex)` This method should be only called by the constructors.
`protected void`	`initializeShelf(int countXSlot, int slotWidth, int countYSlot, int slotHeight, int xSlotIndex)` This method should be only called by the constructors.
`boolean`	`isValidPosition(Object position)` Determines whether the argument is a valid position/shape for this type of object.
`protected void`	`recreateChildren(ilog.tgo.model.internal.IltSlotArray sArray, ilog.tgo.model.internal.IltSlotSizes sSizes)`
`void`	`removeAllItems()` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`void`	`removeGraphic(IltGraphicManager manager)` Removes the graphic representation of this object from a given `IltGraphicManager`.
`boolean`	`removeItem(IltObject item)` Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
`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`	`setDetailObjects(IltChildrenModel details)` Deprecated. Containment relationships should be declared at the Datasource level.
`void`	`setDirection(int direction)` Deprecated. Please use the method `setAttributeValue` to change the `IltShelf.DirectionAttribute` instead. The direction has changed from `IlvDirection` to `IlpDirection`.
`void`	`setDirection(int direction, int itemsDirection)` Deprecated. Whenever the direction of a shelf changes, all its children directions change accordingly. Update each child direction individually instead, by using the `setAttributeValue` method to change the `IltShelf.DirectionAttribute` of each child object. The direction has changed from `IlvDirection` to `IlpDirection`.
`void`	`setItem(int xSlotIndex, double xSlotSpan, int ySlotIndex, double ySlotSpan, IltObject item)` Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a `IlpShelfItemPosition`
`void`	`setItem(int slotIndex, IltObject item)` Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a `IlpShelfItemPosition`
`void`	`setItem(int slotIndex, IltObject item, double slotSpan)` Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a `IlpShelfItemPosition`
`void`	`setItem(int xSlotIndex, int ySlotIndex, IltObject item)` Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a `IlpShelfItemPosition`
`void`	`setLogicalFirstIndex(int logicalFirstIndex)` Deprecated. Use the method `setAttributeValue` to set the `XSlotIndexAttribute` attribute instead.
`void`	`setOverviewObject(IltStateHolder overview)` Deprecated. Containment relationships should be declared at the Datasource level. In case of shelves, the overview object can not be changed, as it is the shelf instance itself.
`void`	`setSizeOtherDimension(int sizeOtherDimension)` Changes the size of the other dimension for all the slots.
`void`	`setSlotNumsOnTop(boolean slotNumsOnTop)` Deprecated. Please use the CSS property `XSlotNumbersOnTop` instead.
`void`	`setSlotNumSpace(int slotNumSpace)` Deprecated. Please use the CSS property `XSlotNumbersOffset` instead.
`void`	`setSlotSizes(int[] slotSizes)` Changes the number and size of slots.
`void`	`setSlotSizes(int[] xSlotWidths, int[] ySlotWidths)` Changes the number and size of the slots in both `x` and `y` dimensions.
`void`	`setSlotSizes(int slotCount, int slotSize)` Changes the number and size of slots.
`void`	`setSlotSizes(int numXSlots, int widthXSlot, int numYSlots, int widthYSlot)` Changes the number of slots and their size in both `x` and `y` dimensions.
`void`	`setStatePropagator(IltStatePropagator propagator)` Deprecated. State propagation at the graphic level is not supported in the Network Component.
`void`	`setTopLeftPoint(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason)` Changes the shape graphic setting.
`void`	`setTopLeftPoint(IltGraphicManager manager, IlvPoint topLeftPoint)` Deprecated. Please use `setPosition` instead.
`void`	`setTopLeftPoint(IltGraphicManager manager, IlvPoint topLeftPoint, IlpPositionSource reason)` Deprecated. Please use `setPosition` instead.
`void`	`setTopLeftPointInManager(IltGraphicManager manager, IltGraphic graphic, IlvPoint position, IlpPositionSource reason)` Changes the position of the graphic representation in a given IltGraphicManager.
`void`	`setType(IltShelf.Type type)` Changes the type of the shelf.
`void`	`setXSlotSizes(int numXSlots, int widthXSlot)` Changes the number of slots and their size in the `x` dimension.
`void`	`setYSlotSizes(int numYSlots, int widthYSlot)` Changes the number of slots and their size in the `y` dimension.
`Object`	`transformPosition(IltGraphicManager manager, Object position)` Applies the manager transformer to the position parameter.
`void`	`updateFrom(IltObject other)` Updates the local cache of attributes stored in getObjectAttribute().
`void`	`updateShapeGraphicSettingInManager(IltGraphicManager manager, IltGraphic graphic, Object newShape, IlpPositionSource reason)` If the graphic representation is visible, updates the shape graphic setting in manager coordinates.
`protected void`	`updateSlotSizes(int[] xSlotWidths, int[] ySlotWidths)`

Methods inherited from class ilog.tgo.model.IltObject
__getIlpObject, addGraphicChangedListener, addStateChangedListener, applyTransform, applyTransform, applyTransform, applyTransformInManager, clearState, cloneForRendering, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphic, computeGraphicAtPosition, createTinyBase, debug, endDelayingComputeGraphic, EndDelayingComputeGraphic, fireAllGraphicChanged, fireGraphicChanged, ForceInit, forgetShapeGraphicSettingInManager, FromGraphic, getAlarmState, getAttacherInfo, getAttacherInfoController, getAutomaticDecorationsDirection, getBaseRectangleInManager, GetBaseStyleMapping, getCenterPoint, getCenterPointInManager, 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, 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, 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, setShapeInManagerGraphicSetting, setState, setState, setTinyType, setVisible, startDelayingComputeGraphic, StartDelayingComputeGraphic, startVisibility, 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

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!
  - FrameColor
```
@Deprecated
public static IlpColorKey FrameColor
```
    Deprecated. Please use CSS property frameColor instead.
    
    The legend property denoting the outline color of a shelf.
    
    See Also:
    
    IltObjectCustomization.getFrameColor()
    
    Deprecated Since:
    
    JTGO 3.5
  - XSlotNumbersOnTop
```
@Deprecated
public static IlpBooleanKey XSlotNumbersOnTop
```
    Deprecated. Please use CSS property XSlotNumbersOnTop instead.
    
    The style key denoting the position for the slot numbers along the x axis.
    The slot numbers may be positioned at the top or at the bottom of a shelf.
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltObjectCustomization.isXSlotNumbersOnTop()
    
    Deprecated Since:
    
    JTGO 3.5
  - XSlotNumbersOffset
```
@Deprecated
public static IlpIntegerKey XSlotNumbersOffset
```
    Deprecated. Please use CSS property XSlotNumbersOffset instead.
    
    The legend denoting the offset of the slot numberings along the X axis.
    It defines the distance between the slot numbering and the shelf.
    
    See Also:
    
    IltObjectCustomization.getXSlotNumbersOffset()
    
    Deprecated Since:
    
    JTGO 3.5
  - XSlotLabels
```
public static IlpStringArrayKey XSlotLabels
```
    Stores the labels that shall be used as slot labels when drawing a shelf
    
    Since:
    
    JTGO 4.0
    
    Internal: do not use!
  - TypeAttribute
```
public static IltAttribute TypeAttribute
```
    Attribute used to define the type of the shelf.
    Attribute name: type.
    
    Value type: IltShelf.Type.
    
    Since:
    
    JTGO 3.0
  - SlotSizesAttribute
```
public static IltAttribute SlotSizesAttribute
```
    Attribute that manages the number of slots and its dimensions.
    Attribute name: slotSizes.
    
    Value type: IlpSlotSizes.
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IlpSlotSizes
  - DirectionAttribute
```
public static IltAttribute DirectionAttribute
```
    Attribute used to define the direction of the shelf.
    Attribute name: direction.
    
    Value type: IlpDirection.
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IlpDirection
  - XSlotIndexAttribute
```
public static IltAttribute XSlotIndexAttribute
```
    Aa attribute used to define the logical first index for the slots along the X axis of a shelf.
    The logical first index is the initial number displayed to count the slots, by default its value is 0 (zero).
    
    Attribute name: xslotindex.
    
    Value type: Integer.
    
    Since:
    
    JTGO 4.0
  - XSlotFirstIndex
```
@Deprecated
public static IltAttribute XSlotFirstIndex
```
    Deprecated. Please use IltShelf.XSlotIndexAttribute instead.
    
    Attribute used to define the logical first index for the slots along the X axis of a shelf. Its value is an instance of Integer.
    Logical first index is the initial number displayed to count the slots, by default its value is 0 (zero).
    
    Since:
    
    JTGO 3.0
    
    Deprecated Since:
    
    JTGO 4.0
- Constructor Detail
  - IltShelf
```
public IltShelf(Object identifier)
```
    Creates a new shelf with the given identifier.
    The shelf properties must be set using the accessors.
    
    Parameters:
    
    identifier - the identifier of this new instance
    
    Since:
    
    JTGO 3.0
  - IltShelf
```
public IltShelf(IlpClass ilpClass,
                Object identifier)
```
    Creates a new shelf with the given identifier.
    The shelf properties must be set using the accessors.
    
    Parameters:
    
    ilpClass - the business class of this new instance. It must be a subclass of IltShelf
    
    identifier - the identifier of this new instance
    
    Since:
    
    JTGO 3.0
  - IltShelf
```
public IltShelf(int numXSlots,
                int widthXSlot,
                int numYSlots,
                int widthYSlot,
                int xSlotIndex)
```
    This constructor creates an instance of a standard IltShelf with fixed-width slots.
    Note: The type can be modified with setType.
    
    Parameters:
    
    numXSlots - The number of slots along the x axis.
    
    widthXSlot - The width of each slot on the x axis.
    
    numYSlots - The number of slots along the y axis.
    
    widthYSlot - The width of each slot on the y axis.
    
    xSlotIndex - Specifies the value of the first slot number displayed below or above the shelf frame. Numbering is sequential.
    
    Since:
    
    JTGO 3.0
  - IltShelf
```
public IltShelf(int[] xSlotWidths,
                int[] ySlotWidths,
                int xSlotIndex)
```
    This constructor creates an instance of a standard IltShelf with variable-width slots.
    Note: The type can be modified with setType.
    
    Parameters:
    
    xSlotWidths - An array of integers, each one corresponding to the width of a slot along the x axis. The width of a slot can be 0.
    
    ySlotWidths - An array of integers, each one corresponding to the width of a slot along the y axis. The width of a slot can be 0.
    
    xSlotIndex - Specifies the value of the first slot number displayed below or above the shelf frame. Numbering is sequential. Slots with a width of 0 are ignored, which may lead to non-sequential numbering.
    
    Since:
    
    JTGO 3.0
  - IltShelf
```
public IltShelf(int sCount,
                int sWidth,
                int sHeight,
                int index)
```
    This constructor creates an instance of IltShelf with fixed-width slots, and with the Standard type.
    Note: The type can be modified with setType.
    
    Parameters:
    
    sCount - Number of slots in the shelf
    
    sWidth - Width of the slots in the shelf
    
    sHeight - Height of the slots in the shelf. This will also be the height of the shelf.
    
    index - Specifies the value of the first slot number to be displayed either below or above the shelf frame. Numbering is sequential.
  - IltShelf
```
public IltShelf(int[] slotWidths,
                int slotHeight,
                int logicalFirstIndex)
```
    This constructor creates an instance of a standard type IltShelf with variable-width slots.
    Note: The type can be modified with setType.
    
    Parameters:
    
    slotWidths - Array of integers, each one corresponding to the width of a slot. The width of a slot can be 0.
    
    slotHeight - Height of the slots in the shelf. This will also be the height of the shelf.
    
    logicalFirstIndex - Specifies the value of the first slot number to be displayed below or above the shelf frame. Numbering is sequential. Slots with a width of 0 are ignored, which may lead to non-sequential numbering.
- 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
  - 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!
  - initializeShelf
```
protected void initializeShelf(int countXSlot,
                               int slotWidth,
                               int countYSlot,
                               int slotHeight,
                               int xSlotIndex)
```
    This method should be only called by the constructors.
    
    Internal: do not use!
  - initializeShelf
```
protected void initializeShelf(int[] xSlotWidths,
                               int[] ySlotWidths,
                               int xSlotIndex)
```
    This method should be only called by the constructors.
    
    Internal: do not use!
  - updateFrom
```
public void updateFrom(IltObject other)
```
    Description copied from class: IltObject
    
    Updates the local cache of attributes stored in getObjectAttribute().
    
    Overrides:
    
    updateFrom in class IltObject
    
    Internal: do not use!
  - copyFrom
```
protected void copyFrom(IltObject o)
```
    Description copied from class: IltObject
    
    Copies the attributes from an original object.
    
    Overrides:
    
    copyFrom in class IltObject
    
    See Also:
    
    IltObject.cloneForRendering(boolean)
    
    Internal: do not use!
  - recreateChildren
```
protected void recreateChildren(ilog.tgo.model.internal.IltSlotArray sArray,
                                ilog.tgo.model.internal.IltSlotSizes sSizes)
```
    Internal: do not use!
  - getType
```
public IltShelf.Type getType()
```
    Returns the type of the shelf.
  - setType
```
public void setType(IltShelf.Type type)
```
    Changes the type of the shelf.
  - setSlotNumsOnTop
```
@Deprecated
public void setSlotNumsOnTop(boolean slotNumsOnTop)
```
    Deprecated. Please use the CSS property XSlotNumbersOnTop instead.
    
    Specifies whether the logical numbers for the x axis are displayed above or below the shelf outline.
    This method sets the value in the object style in the default application context only.
    
    Parameters:
    
    slotNumsOnTop - true means that the numbers display above the shelf, false that they display below.
    
    Deprecated Since:
    
    JTGO 3.0
  - areSlotNumsOnTop
```
@Deprecated
public boolean areSlotNumsOnTop()
```
    Deprecated. Please use the CSS property XSlotNumbersOnTop instead.
    
    Returns true if the slot logical numbers for the x axis display above the shelf outline.
    This method retrieves the value in the object style in the default application context only.
    
    Deprecated Since:
    
    JTGO 3.0
  - setSlotNumSpace
```
@Deprecated
public void setSlotNumSpace(int slotNumSpace)
```
    Deprecated. Please use the CSS property XSlotNumbersOffset instead.
    
    Specifies the vertical space separating the displayed logical numbers from the shelf outline.
    This method sets the value in the object styling the default application context only.
    
    Parameters:
    
    slotNumSpace - The vertical space in pixels
    
    Deprecated Since:
    
    JTGO 3.0
  - getSlotNumSpace
```
@Deprecated
public int getSlotNumSpace()
```
    Deprecated. Please use the CSS property XSlotNumbersOffset instead.
    
    Returns the height of the space separating displayed logical numbers from the shelf outline.
    This method retrieves the value in the object style in the default application context only.
    
    Deprecated Since:
    
    JTGO 3.0
  - setLogicalFirstIndex
```
@Deprecated
public void setLogicalFirstIndex(int logicalFirstIndex)
```
    Deprecated. Use the method setAttributeValue to set the XSlotIndexAttribute attribute instead.
    
    Changes the numbering of the displayed slot numbers.
    
    Parameters:
    
    logicalFirstIndex - Specifies the value of the first slot number for the numbers that will be displayed below or above the shelf frame. Numbering is sequential.
    
    See Also:
    
    XSlotIndexAttribute
    
    Deprecated Since:
    
    JTGO 3.0
  - getLogicalFirstIndex
```
@Deprecated
public int getLogicalFirstIndex()
```
    Deprecated. Use the method getAttributeValue to retrieve the XSlotIndexAttribute attribute instead.
    
    Returns the value of the first slot number for the numbers that will be displayed below or above the shelf frame.
    
    See Also:
    
    XSlotIndexAttribute
    
    Deprecated Since:
    
    JTGO 3.0
  - setSlotSizes
```
public void setSlotSizes(int[] xSlotWidths,
                         int[] ySlotWidths)
```
    Changes the number and size of the slots in both x and y dimensions.
    Shelf items are resized accordingly. If there are less slots than before, the excess items are removed.
    
    Parameters:
    
    xSlotWidths - An array of integers, each one corresponding to the size of a slot along the x axis. The size of a slot can be 0.
    
    ySlotWidths - An array of integers, each one corresponding to the size of a slot along the y axis. The size of a slot can be 0.
    
    Since:
    
    JTGO 3.0
  - updateSlotSizes
```
protected void updateSlotSizes(int[] xSlotWidths,
                               int[] ySlotWidths)
```
    Internal: do not use!
  - setSlotSizes
```
public void setSlotSizes(int numXSlots,
                         int widthXSlot,
                         int numYSlots,
                         int widthYSlot)
```
    Changes the number of slots and their size in both x and y dimensions.
    The shelf items are resized accordingly. If the number of slots decreases, the excess items are removed.
    
    Parameters:
    
    numXSlots - Number of slots along the x axis
    
    widthXSlot - Size of each slot along the x axis
    
    numYSlots - Number of slots along the y axis
    
    widthYSlot - Size of each slot along the y axis
    
    Since:
    
    JTGO 3.0
  - setXSlotSizes
```
public void setXSlotSizes(int numXSlots,
                          int widthXSlot)
```
    Changes the number of slots and their size in the x dimension.
    The shelf items are resized accordingly. If the number of slots decreases, the excess items are removed.
    
    Parameters:
    
    numXSlots - Number of slots along the x axis
    
    widthXSlot - Size of each slot along the x axis
    
    Since:
    
    JTGO 3.0
  - setYSlotSizes
```
public void setYSlotSizes(int numYSlots,
                          int widthYSlot)
```
    Changes the number of slots and their size in the y dimension.
    The shelf items are resized accordingly. If the number of slots decreases, the excess items are removed.
    
    Parameters:
    
    numYSlots - Number of slots along the y axis
    
    widthYSlot - Size of each slot along the y axis
    
    Since:
    
    JTGO 3.0
  - getXSlotSizes
```
public int[] getXSlotSizes()
```
    Accesses the sizes of the slots along the x axis.
    
    Returns:
    
    An array of integers representing the slot sizes.
    
    Since:
    
    JTGO 3.0
  - getYSlotSizes
```
public int[] getYSlotSizes()
```
    Accesses the sizes of the slots along the y axis.
    
    Returns:
    
    An array of integers representing the slot sizes.
    
    Since:
    
    JTGO 3.0
  - 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
    
    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!
  - 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!
  - 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
    
    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!
  - 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!
  - createGraphic
```
@Deprecated
public void createGraphic(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.
    
    Ensures that this object has a graphic representation in a given IltGraphicManager. If no graphic representation in this view exists, an invisible graphic representation is created.
    The graphic representations of the contained shelf items are also created.
    
    Overrides:
    
    createGraphic in class IltObject
    
    Deprecated Since:
    
    JTGO 3.5
  - computeGraphic
```
@Deprecated
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.
    
    Ensures that this shelf has a valid graphic representation in a given IltGraphicManager.
    
    Parameters:
    
    manager - manager in which this shelf will be represented graphically
    
    position - coordinates of the top left corner of the shelf in the given manager
    
    Deprecated Since:
    
    JTGO 3.5
  - removeGraphic
```
public void removeGraphic(IltGraphicManager manager)
```
    Description copied from class: IltObject
    
    Removes the graphic representation of this object from a given IltGraphicManager.
    Note that this method is not supposed to be used when this IltObject is in a DataSource.
    
    Overrides:
    
    removeGraphic in class IltObject
    
    Internal: do not use!
  - initializeCreatedGraphic
```
public void initializeCreatedGraphic(IltGraphicManager manager,
                                     IltGraphic graphic)
```
    Description copied from class: IltObject
    
    This method must be called just after preCreateGraphic to initialize any needed property or graphic setting. This method is the one implemented by sub-classes of IltObject in order to execute their proper initialization.
    
    Overrides:
    
    initializeCreatedGraphic 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
  - createBase
```
public ilog.tgo.graphic.internal.base.IltBaseElement createBase(IltcGraphicElementAggregate root)
```
    Creates a base element, suitable for this particular kind of object.
    
    Specified by:
    
    createBase in class IltObject
    
    See Also:
    
    IltCompositeGraphic.createBase(IltcGraphicElementAggregate, IltObject), IltObject.createTinyBase(IltcGraphicElementAggregate)
    
    Internal: do not use!
  - getTopLeftPoint
```
@Deprecated
public IlvPoint getTopLeftPoint(IltGraphicManager manager)
```
    Deprecated. Please use getPosition instead.
    
    Returns the position of the top left corner of the shelf in the given manager.
    
    Deprecated Since:
    
    JTGO 3.5
  - getTopLeftPoint
```
protected IlvPoint getTopLeftPoint(IltGraphicManager manager,
                                   IltGraphic graphic)
```
    Returns the shape graphic setting.
    
    Internal: do not use!
  - setTopLeftPoint
```
@Deprecated
public void setTopLeftPoint(IltGraphicManager manager,
                                        IlvPoint topLeftPoint)
```
    Deprecated. Please use setPosition instead.
    
    Changes the position of the shelf.
    
    Parameters:
    
    manager - a specific manager into which this shelf has already been inserted.
    
    topLeftPoint - the new position of the top left corner of the shelf. The size of the shelf is determined by the slot sizes.
    
    Deprecated Since:
    
    JTGO 3.5
  - setTopLeftPoint
```
@Deprecated
public void setTopLeftPoint(IltGraphicManager manager,
                                        IlvPoint topLeftPoint,
                                        IlpPositionSource reason)
```
    Deprecated. Please use setPosition instead.
    
    Changes the position of the shelf.
    
    Parameters:
    
    manager - a specific manager into which this shelf has already been inserted.
    
    topLeftPoint - the new position of the top left corner of the shelf. The size of the shelf is determined by the slot sizes.
    
    reason - the reason for the position change, or null if unknown
    
    Deprecated Since:
    
    JTGO 3.5
  - setTopLeftPoint
```
public void setTopLeftPoint(IltGraphicManager manager,
                            IltGraphic graphic,
                            IlvPoint position,
                            IlpPositionSource reason)
```
    Changes the shape graphic setting.
    
    Internal: do not use!
  - setTopLeftPointInManager
```
public void setTopLeftPointInManager(IltGraphicManager manager,
                                     IltGraphic graphic,
                                     IlvPoint position,
                                     IlpPositionSource reason)
```
    Changes the position of the graphic representation in a given IltGraphicManager.
    
    Internal: do not use!
  - getOverviewObject
```
@Deprecated
public IltStateHolder getOverviewObject()
```
    Deprecated. Containment relationships should be declared at the Datasource level.
    
    Returns the overview object, this in the case of an IltShelf.
    
    Specified by:
    
    getOverviewObject in interface IltContainer
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - setOverviewObject
```
@Deprecated
public void setOverviewObject(IltStateHolder overview)
```
    Deprecated. Containment relationships should be declared at the Datasource level. In case of shelves, the overview object can not be changed, as it is the shelf instance itself.
    
    Sets or replaces the overview object. It should not be called on IltShelf instances.
    
    Specified by:
    
    setOverviewObject in interface IltContainer
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - getDetailObjects
```
@Deprecated
public IltChildrenModel getDetailObjects()
```
    Deprecated. Containment relationships should be declared at the Datasource level.
    
    Returns the abstract model describing the set of detail objects.
    
    Specified by:
    
    getDetailObjects in interface IltContainer
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - setDetailObjects
```
@Deprecated
public void setDetailObjects(IltChildrenModel details)
```
    Deprecated. Containment relationships should be declared at the Datasource level.
    
    Sets or replaces the set of detail objects.
    Note that the set of detail objects can change dynamically, 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
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - getStatePropagator
```
@Deprecated
public IltStatePropagator getStatePropagator()
```
    Deprecated. State propagation at the graphic level is not supported in the Network Component.
    
    Returns the state propagation rules for the container's state.
    
    Specified by:
    
    getStatePropagator in interface IltContainer
    
    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 the state propagation rules for the container's state.
    
    Specified by:
    
    setStatePropagator in interface IltContainer
    
    Deprecated Since:
    
    JTGO 4.0
  - getChildren
```
@Deprecated
public Enumeration getChildren()
```
    Deprecated. In the future, relationships will only be defined at the datasource level.
    
    Returns the list of children objects, contained in this object. This method is overwritten by the objects which contain elements, such as shelves, card carriers and link sets.
    
    Overrides:
    
    getChildren in class IltObject
    
    Internal: do not use!
    
    Deprecated Since:
    
    JTGO 4.0
  - setItem
```
@Deprecated
public void setItem(int xSlotIndex,
                                int ySlotIndex,
                                IltObject item)
```
    Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a IlpShelfItemPosition
    
    Adds a child item to the container at a given position; any other children occupying the given position (or even part of it) are removed.
    If the container already has a graphic representation, the method computeGraphic will be automatically invoked on every manager that contains it.
    
    The container position is based on a two-dimensional matrix where each child is placed according to an origin point (x and y coordinates) plus a two-dimensional span (x span and y span).
    
    This method considers a span equal to 1.0, that is, no span at all.
    
    Parameters:
    
    xSlotIndex - The slot index for the x coordinate
    
    ySlotIndex - The slot index for the y coordinate
    
    item - The child object to be inserted in the container
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - setItem
```
@Deprecated
public void setItem(int xSlotIndex,
                                double xSlotSpan,
                                int ySlotIndex,
                                double ySlotSpan,
                                IltObject item)
```
    Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a IlpShelfItemPosition
    
    Adds a child item to the container at a given position and span.
    The child object will start at xSlotIndex and ySlotIndex, expanding over other slots according to xSlotSpan and ySlotSpan attributes.
    The container position is based on a two-dimensional matrix where each child is placed according to an origin point (x and y coordinates) plus a two-dimensional span (x span and y span).
    The span attribute is a positive double representing a fraction of a slot; 1.0 corresponds to one slot, 1.5 corresponds to one slot plus half of the next slot, and so on and so forth.
    Any child already located in the position defined by the new child will be removed from the container. If the container already has a graphic representation, the method computeGraphic will be automatically invoked on every manager that contains it.
    
    Parameters:
    
    xSlotIndex - The slot index for the x coordinate
    
    xSlotSpan - The slot spanning for the x coordinate
    
    ySlotIndex - The slot index for the y coordinate
    
    ySlotSpan - The slot spanning for the y coordinate
    
    item - The child object to be inserted in the container
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - removeItem
```
@Deprecated
public boolean removeItem(IltObject item)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Removes a child item from the container, including all its graphic representations, if any.
    
    Specified by:
    
    removeItem in interface IltShelfItemContainer
    
    Returns:
    
    true if item was found and removed, false if item does not belong to the container
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - removeAllItems
```
@Deprecated
public void removeAllItems()
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Removes all child items from the container, including all their graphic representations, if any.
    
    Specified by:
    
    removeAllItems in interface IltShelfItemContainer
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - getItem
```
@Deprecated
public IltObject getItem(int xSlotIndex,
                                     int ySlotIndex)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Returns the child item occupying the slot defined by xSlotIndex and ySlotIndex.
    The slot might be partially occupied by the returned item (if the corresponding slot span is not an integer).
    
    Parameters:
    
    xSlotIndex - The slot index for the x coordinate
    
    ySlotIndex - The slot index for the y coordinate
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - getItems
```
@Deprecated
public Enumeration getItems()
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Return all child items from the container.
    
    Specified by:
    
    getItems in interface IltShelfItemContainer
    
    Returns:
    
    An Enumeration of IltObject containing all child items
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - getItems
```
@Deprecated
public Enumeration getItems(int xSlotIndex,
                                        double xSlotSpan,
                                        int ySlotIndex,
                                        double ySlotSpan)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Returns an Enumeration of the child items (IltObject instances) in the container which are fully or partially covered by the area defined by xSlotIndex, ySlotIndex, xSlotSpan and ySlotSpan.
    
    Parameters:
    
    xSlotIndex - The slot index for the x coordinate
    
    xSlotSpan - Positive non-zero double representing the slot spanning for the x coordinate
    
    ySlotIndex - The slot index for the y coordinate
    
    ySlotSpan - Positive non-zero double representing the slot spanning for the y coordinate
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - getSlotSpanX
```
@Deprecated
public double getSlotSpanX(int xIndex,
                                       int yIndex)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Retrieves the number of slots on the x axis across which the children in the given slot span.
    If no item is present in the slot, the method returns the number of contiguous empty slots on either side (x axis) of the given slot.
    
    Parameters:
    
    xIndex - The x slot coordinate
    
    yIndex - The y slot coordinate
    
    Returns:
    
    The number of contiguous empty slots including the given slot, along the x axis
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - getSlotSpanY
```
@Deprecated
public double getSlotSpanY(int xIndex,
                                       int yIndex)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Retrieves the number of slots on the y axis across which the children in the given slot span.
    If no item is present in the slot, the method returns the number of contiguous empty slots on either side (y axis) of the given slot.
    
    Parameters:
    
    xIndex - The x slot coordinate
    
    yIndex - The y slot coordinate
    
    Returns:
    
    The number of contiguous empty slots including the given slot, along the y axis
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - getItemPosition
```
@Deprecated
public IlpShelfItemPosition getItemPosition(IltObject item)
```
    Deprecated. Please use the IltShelfItem.getPosition or retrieve the shelf item position from the component view.
    
    Returns the position of the child object relative to its parent, based on both x and y slot positioning.
    
    Specified by:
    
    getItemPosition in interface IltShelfItemContainer
    
    Parameters:
    
    item - The child object which slot position to retrieve
    
    Returns:
    
    An IlpShelfItemPosition object containing positioning information, or null if item does not belong to the container
    
    Since:
    
    JTGO 3.0
    
    See Also:
    
    IlpShelfItemPosition, IltObject.getPosition(), IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
    
    Deprecated Since:
    
    JTGO 4.0
  - getSlotCount
```
public int getSlotCount()
```
    Accesses the total number of slots in the container.
    
    Specified by:
    
    getSlotCount in interface IltShelfItemContainer
    
    Returns:
    
    The total number of slots, on both x and y dimensions
  - getItemRect
```
@Deprecated
public IlvRect getItemRect(IltGraphicManager manager,
                                       IltObject item)
```
    Deprecated. Adding a object to a datasource, connected to a graphic component such as an IlpNetwork, is enough to make its graphic representation visible. Retrieve the bounding box of the children object from its graphic representation.
    
    Access the dimension of a given child item in the given manager.
    
    Specified by:
    
    getItemRect in interface IltShelfItemContainer
    
    Parameters:
    
    manager - The container's graphic manager
    
    item - The child object
    
    Returns:
    
    The rectangle
    
    Deprecated Since:
    
    JTGO 3.5
  - setDirection
```
@Deprecated
public void setDirection(int direction)
```
    Deprecated. Please use the method setAttributeValue to change the IltShelf.DirectionAttribute instead. The direction has changed from IlvDirection to IlpDirection.
    
    Sets the Direction style value for the shelf.
    The directions of all child objects are also affected and changed accordingly.
    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 by this method; all style values are computed and set based on the default context only.
    
    Specified by:
    
    setDirection in interface IltShelfItemContainer
    
    Parameters:
    
    direction - Either IlvDirection.Top, IlvDirection.Bottom, IlvDirection.Left, or IlvDirection.Right
    
    See Also:
    
    DirectionAttribute
    
    Deprecated Since:
    
    JTGO 3.0
  - setDirection
```
@Deprecated
public void setDirection(int direction,
                                     int itemsDirection)
```
    Deprecated. Whenever the direction of a shelf changes, all its children directions change accordingly. Update each child direction individually instead, by using the setAttributeValue method to change the IltShelf.DirectionAttribute of each child object. The direction has changed from IlvDirection to IlpDirection.
    
    Sets the value of the Direction style value for the shelf.
    All child objects are also changed to the given direction. 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 by this method; all style values are computed and set based on the default context only.
    
    Specified by:
    
    setDirection in interface IltShelfItemContainer
    
    Parameters:
    
    direction - Either IlvDirection.Top, IlvDirection.Bottom, IlvDirection.Left, or IlvDirection.Right
    
    itemsDirection - Either IlvDirection.Top, CODE>IlvDirection.Bottom, IlvDirection.Left, or IlvDirection.Right
    
    See Also:
    
    DirectionAttribute
    
    Deprecated Since:
    
    JTGO 3.0
  - checkItem
```
public void checkItem(IltObject item,
                      IlpShelfItemPosition position)
```
    Check the position for a given item, verifying if indexes and spans are valid, and also checking if the item can fit into the container.
    
    Specified by:
    
    checkItem in interface IltShelfItemContainer
    
    Parameters:
    
    item - The new item being checked.
    
    position - The (relative) position where the item is being added.
    
    Throws:
    
    IllegalArgumentException - If the item has invalid position. All details are wrapped into the exception.
    
    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
  - getMappedForUserList
```
public ilog.util.internal.IlAVector getMappedForUserList()
```
    Overrides:
    
    getMappedForUserList in class IltObject
    
    Internal: do not use!
  - setSlotSizes
```
public void setSlotSizes(int[] slotSizes)
```
    Changes the number and size of slots.
    The shelf items are resized accordingly. If slotSizes specifies less slots than before, the excess items are removed.
    
    Parameters:
    
    slotSizes - Array of integers, each one corresponding to the size of a slot. The size of a slot can be 0.
  - setSlotSizes
```
public void setSlotSizes(int slotCount,
                         int slotSize)
```
    Changes the number and size of slots.
    The shelf items are resized accordingly. If slotSizes specifies less slots than before, the excess items are removed.
    
    Parameters:
    
    slotCount - Number of slots in the shelf
    
    slotSize - Width of the slots in the shelf
  - getSlotSizes
```
public int[] getSlotSizes()
```
    Returns the slot sizes.
    
    Returns:
    
    an array of integers corresponding to the sizes of the slots.
  - setSizeOtherDimension
```
public void setSizeOtherDimension(int sizeOtherDimension)
```
    Changes the size of the other dimension for all the slots.
  - getSizeOtherDimension
```
public int getSizeOtherDimension()
```
    Returns the size of the other dimension for all the slots.
  - setItem
```
@Deprecated
public void setItem(int slotIndex,
                                IltObject item)
```
    Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a IlpShelfItemPosition
    
    Adds a child item to this container at a given position. If the given position is already occupied by another item, the previous item is removed from the container. The new item will occupy exactly one slot.
    If the container already has a graphic representation, computeGraphic will automatically be called on the item in all the managers that display the container.
    
    Specified by:
    
    setItem in interface IltShelfItemContainer
    
    Parameters:
    
    slotIndex - The slot number of this container where the item will be set.
    
    item - The item inserted in the container.
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - setItem
```
@Deprecated
public void setItem(int slotIndex,
                                IltObject item,
                                double slotSpan)
```
    Deprecated. Containment relationships should be declared at the Datasource level. Please insert your shelf item in the datasource, setting it as child of this shelf. It will also be necessary to define its position within the shelf. You can do this, by setting the shelf item position attribute to a IlpShelfItemPosition
    
    Adds a child item to this container at a given position. The child item is set to a position starting at slot index slotIndex and spanning over slotSpan slots. The child items previously occupying these slots are removed from the container.
    If the container already has a graphic representation, computeGraphic will automatically be called on the item in all the managers displaying the container.
    
    Specified by:
    
    setItem in interface IltShelfItemContainer
    
    Parameters:
    
    slotIndex - Slot number of this container where the item will start.
    
    item - child Item inserted in the container.
    
    slotSpan - Positive double value representing the number of slots over which the item will span.
    
    Deprecated Since:
    
    JTGO 4.0
  - getItem
```
@Deprecated
public IltObject getItem(int slotIndex)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Returns the child item occupying the slot of index slotIndex. The returned item might only partially occupy the slot if the slot span of the item is not an integer.
    
    Specified by:
    
    getItem in interface IltShelfItemContainer
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition
    
    Deprecated Since:
    
    JTGO 4.0
  - getItems
```
@Deprecated
public Enumeration getItems(int slotIndex,
                                        double slotSpan)
```
    Deprecated. Containment relationships should be declared and retrieved at the Datasource level.
    
    Returns an Enumeration of the child items located in the container, starting at position slotIndex and spanning over slotSpan. The returned child items might only partially occupy the given interval. If slotSpan equals -1.0, all the items are returned, starting at position slotIndex.
    
    Specified by:
    
    getItems in interface IltShelfItemContainer
    
    Returns:
    
    an enumeration of IltObject
    
    See Also:
    
    IltDefaultDataSource
    
    Deprecated Since:
    
    JTGO 4.0
  - getItemSpan
```
@Deprecated
public double getItemSpan(int slotIndex)
```
    Deprecated. Please use the IltShelfItem.getPosition or retrieve the shelf item position from the component view.
    
    Returns the number of slots over which spans the child item in slot index slotIndex. If no item is present in the slot, the method returns the number of empty slots surrounding the given index.
    
    Specified by:
    
    getItemSpan in interface IltShelfItemContainer
    
    See Also:
    
    IltDefaultDataSource, IlpShelfItemPosition, IltObject.getPosition(), IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
    
    Deprecated Since:
    
    JTGO 4.0
  - findItem
```
@Deprecated
public int findItem(IltObject item)
```
    Deprecated. Please use the IltShelfItem.getPosition or retrieve the shelf item position from the component view.
    
    Retrieves the first slot index used by the item child item. If the child item does not occupy any slot in the current shelf object, the method returns -1.
    
    Specified by:
    
    findItem in interface IltShelfItemContainer
    
    See Also:
    
    IlpShelfItemPosition, IltObject.getPosition(), IlpGraphView.getPosition(ilog.cpl.model.IlpRepresentationObject)
    
    Deprecated Since:
    
    JTGO 4.0

Class IltShelf

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

Methods inherited from interface ilog.tgo.model.IltContainer

Methods inherited from interface ilog.tgo.model.IltStateHolder

Field Detail

metainfo

FrameColor

XSlotNumbersOnTop

XSlotNumbersOffset

XSlotLabels

TypeAttribute

SlotSizesAttribute

DirectionAttribute

XSlotIndexAttribute

XSlotFirstIndex

Constructor Detail

IltShelf

IltShelf

IltShelf

IltShelf

IltShelf

IltShelf

Method Detail

GetIlpClass

GetClassLegend

initializeObject

initializeShelf

initializeShelf

updateFrom

copyFrom

recreateChildren

getType

setType

setSlotNumsOnTop

areSlotNumsOnTop

setSlotNumSpace

getSlotNumSpace

setLogicalFirstIndex

getLogicalFirstIndex

setSlotSizes

updateSlotSizes

setSlotSizes

setXSlotSizes

setYSlotSizes

getXSlotSizes

getYSlotSizes

transformPosition

isValidPosition

createPositionUpdate

updateShapeGraphicSettingInManager

getCenterPoint

setCenterPoint

getBaseRectangle

setBaseRectangle

defaultShape

createGraphic

computeGraphic

removeGraphic

initializeCreatedGraphic

applyTransform

createBase

getTopLeftPoint

getTopLeftPoint

setTopLeftPoint

setTopLeftPoint

setTopLeftPoint

setTopLeftPointInManager

getOverviewObject

setOverviewObject

getDetailObjects

setDetailObjects