IltShelfItemContainer (Rogue Wave JViews 9.1 API)

All Known Implementing Classes:

IltCardCarrier, IltShelf

Deprecated.
Containment relationships are declared and retrieved at the Datasource level.
```
@Deprecated
public interface IltShelfItemContainer
```
This interface is used to model the subclasses of an IltObject that has slots, and sets the size of its children items.
The two concrete classes that implement this interface are IltShelf and IltCardCarrier.

See Also:

IltDefaultDataSource

Deprecated Since:

JTGO 4.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkItem(IltObject item, IlpShelfItemPosition position)` Deprecated. 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.
`int`	`findItem(IltObject item)` Deprecated. Please use `getItemPosition` method instead. It returns all position attributes as an `IlpShelfItemPosition` object.
`IltObject`	`getItem(int slotIndex)` Deprecated. Returns the child item occupying the slot of index `slotIndex`.
`IlpShelfItemPosition`	`getItemPosition(IltObject item)` Deprecated. Returns the position of the child object relative to its parent, based on an `IlpShelfItemPosition` object.
`IlvRect`	`getItemRect(IltGraphicManager manager, IltObject item)` Deprecated.
`Enumeration`	`getItems()` Deprecated. Returns all child items from the container (as an `Enumeration`).
`Enumeration`	`getItems(int slotIndex, double slotSpan)` Deprecated. Returns an `Enumeration` of the child items contained in the container starting at position `slotIndex` and spanning across `slotSpan`.
`double`	`getItemSpan(int slotIndex)` Deprecated. Please use `getItemPosition` method instead. It returns all position attributes as an `IlpShelfItemPosition` object.
`int`	`getSlotCount()` Deprecated. Returns the number of slots that the container has.
`void`	`removeAllItems()` Deprecated. Removes all child items from the container.
`boolean`	`removeItem(IltObject item)` Deprecated. Removes the `item` child item of the container.
`void`	`setDirection(int containerDirection)` Deprecated. Use `DirectionAttribute` from the implementing class.
`void`	`setDirection(int containerDirection, int itemsDirection)` Deprecated. Use `DirectionAttribute` from the implementing class. Update each child direction individually.
`void`	`setItem(int slotIndex, IltObject item)` Deprecated. Adds a child item to this container at a given position.
`void`	`setItem(int slotIndex, IltObject item, double slotSpan)` Deprecated. Adds a child item to this container, at a given position.

- Method Detail
  - setItem
```
void setItem(int slotIndex,
             IltObject item)
```
    Deprecated.
    
    Adds a child item to this container at a given position. Any other item occupying the given position is previously 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 contain the container.
    
    Parameters:
    
    slotIndex - The slot number of the container, where the item will be inserted.
    
    item - The item inserted in the container.
  - setItem
```
void setItem(int slotIndex,
             IltObject item,
             double slotSpan)
```
    Deprecated.
    
    Adds a child item to this container, at a given position. The child item is set at a position starting from slot number slotIndex and spanning across slotSpan slots. Child items previously occupying the slots used by the new item 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 that contain the container.
    
    Parameters:
    
    slotIndex - The slot number in this container, where the item starts from.
    
    item - The item inserted in the container.
    
    slotSpan - A positive double value representing the number of slots across which the item spans.
  - getItem
```
IltObject getItem(int slotIndex)
```
    Deprecated.
    
    Returns the child item occupying the slot of index slotIndex. The slot might be only partially occupied by the returned item if the slot span of the item is not an integer.
  - getItems
```
Enumeration getItems()
```
    Deprecated.
    
    Returns all child items from the container (as an Enumeration).
  - getItems
```
Enumeration getItems(int slotIndex,
                     double slotSpan)
```
    Deprecated.
    
    Returns an Enumeration of the child items contained in the container starting at position slotIndex and spanning across slotSpan. The child items returned might be only partially in the given interval.
  - findItem
```
@Deprecated
int findItem(IltObject item)
```
    Deprecated. Please use getItemPosition method instead. It returns all position attributes as an IlpShelfItemPosition object.
    
    Retrieves the first slot index on which the item child item is using. If the child item does not occupy any slot of the current shelf object, -1 is returned.
    
    Deprecated Since:
    
    JTGO 3.1
  - getItemPosition
```
IlpShelfItemPosition getItemPosition(IltObject item)
```
    Deprecated.
    
    Returns the position of the child object relative to its parent, based on an IlpShelfItemPosition object.
    
    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.1
  - removeItem
```
boolean removeItem(IltObject item)
```
    Deprecated.
    
    Removes the item child item of the container. Removes all graphic representations of the given item, if present.
    
    Returns:
    
    true if the item was found in the container; false otherwise.
  - removeAllItems
```
void removeAllItems()
```
    Deprecated.
    
    Removes all child items from the container. Removes also all associated graphic representations, if present.
  - getItemSpan
```
@Deprecated
double getItemSpan(int slotIndex)
```
    Deprecated. Please use getItemPosition method instead. It returns all position attributes as an IlpShelfItemPosition object.
    
    Returns the number of slots spanned by the child item occupying the slot of index slotIndex. If no item is present in the slot, returns the number of slots which are empty around the given index.
    
    Deprecated Since:
    
    JTGO 3.1
  - getSlotCount
```
int getSlotCount()
```
    Deprecated.
    
    Returns the number of slots that the container has.
  - getItemRect
```
@Deprecated
IlvRect getItemRect(IltGraphicManager manager,
                                IltObject item)
```
    Deprecated.
    
    Returns the dimension of a given item inside the container.
    
    Deprecated Since:
    
    JTGO 3.5
  - setDirection
```
@Deprecated
void setDirection(int containerDirection)
```
    Deprecated. Use DirectionAttribute from the implementing class.
    
    Changes the direction of the container and of its items. This method changes the IltObject.Direction local values of the container and of all the container items recursively. Call this method when all the items have been inserted in the container, and after each change in the container content.
    
    Parameters:
    
    containerDirection - Either IlvDirection.Top, IlvDirection.Bottom, IlvDirection.Left, or IlvDirection.Right
    
    Deprecated Since:
    
    JTGO 3.0
  - setDirection
```
@Deprecated
void setDirection(int containerDirection,
                              int itemsDirection)
```
    Deprecated. Use DirectionAttribute from the implementing class. Update each child direction individually.
    
    Changes the direction of the container and of its items. This method changes the local IltObject.Direction style values of the container and of all the container items recursively. Call this method when all the items have been inserted in the container, and after each change in the container content.
    
    Parameters:
    
    containerDirection - Either IlvDirection.Top, IlvDirection.Bottom, IlvDirection.Left, or IlvDirection.Right
    
    itemsDirection - Either IlvDirection.Top, IlvDirection.Bottom, IlvDirection.Left, or IlvDirection.Right
    
    Deprecated Since:
    
    JTGO 3.0
  - checkItem
```
void checkItem(IltObject item,
               IlpShelfItemPosition position)
```
    Deprecated.
    
    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.
    
    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.

Interface IltShelfItemContainer

Method Summary

Method Detail

setItem

setItem

getItem

getItems

getItems

findItem

getItemPosition

removeItem

removeAllItems

getItemSpan

getSlotCount

getItemRect

setDirection

setDirection

checkItem