IltShelfItemContainerBaseRenderer (Perforce JViews 10.0 API)

java.lang.Object
- ilog.tgo.graphic.renderer.IltBaseRenderer
- - ilog.tgo.graphic.renderer.IltShelfItemContainerBaseRenderer

Direct Known Subclasses:

IltCardCarrierBaseRenderer, IltShelfBaseRenderer
```
public abstract class IltShelfItemContainerBaseRenderer
extends IltBaseRenderer
```
This class encapsulates the drawing functionality for the base of a shelf item container.

Since:

JTGO 4.0

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`IltShelfItemContainerBaseRenderer()` Default constructor.
`protected`	`IltShelfItemContainerBaseRenderer(ilog.tgo.graphic.renderer.internal.IltBaseRendererState state)` For compatibility purposes, internal use only !

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected ilog.tgo.graphic.renderer.internal.IltBaseRendererState`	`createBaseRendererState()` Resets the properties
`int`	`getDirection()` Returns the direction of the outermost shelf item container.
`protected IltObject`	`getItem(int slotIndex)` Returns the IltShelfItem at the given `slotIndex`.
`protected IltObject`	`getItem(int slotXIndex, int slotYIndex)` Returns the child item occupying the slot defined by `slotXIndex` and `slotYIndex`.
`protected double`	`getItemSpan(int slotIndex)` Returns the span value along the `x` axis for the `IltShelfItem` object at the given slot position.
`protected ilog.tgo.model.internal.IltSlotArray`	`getSlotArray()` Returns the information about slots present in this container.
`protected int`	`getSlotBorderWidth()` Returns the border thickness of the slots.
`protected int`	`getSlotCount()` Access the total number of slots the container has.
`protected int`	`getSlotCountX()` Access the total number of slots in the shelf along `x` axis.
`protected int`	`getSlotCountY()` Access the total number of slots in the shelf along `y` axis.
`protected IlvRect`	`getSlotRect(int slotIndex, double slotSpan, IlvRect drawRect)` Returns the rectangle where the shelf item at the given slotIndex should be drawn.
`abstract IlvRect`	`getSlotRect(int slotXIndex, double slotXSpan, int slotYIndex, double slotYSpan, IlvRect drawRect)` Returns the rectangle where the shelf item at the given slot position (defined by `slotXIndex` and `slotYIndex` indexes) should be drawn.
`protected IlvRect`	`getSlotRect(int slotIndex, IlvRect drawRect)` Returns the rectangle where the shelf item at the given slotIndex should be drawn.
`protected IlvRect`	`getSlotRect(int slotXIndex, int slotYIndex, IlvRect drawRect)` Returns the rectangle where the shelf item at the given slot position (defined by `slotXIndex` and `slotYIndex` indexes) should be drawn.
`protected abstract IlvRect`	`getSlotsBBox(IlvRect drawRect)` Returns the bounding box of all the slots in this shelf item container.
`protected int`	`getSlotSepSize()` Returns the distance separating two slots.
`protected ilog.tgo.model.internal.IltSlotSizes`	`getSlotSizes()` Returns the information about slots sizes present in this container.
`protected double`	`getSlotSpanX(int xIndex, int yIndex)` Retrieves the number of slots spanned through the `x` axis by the children occupying the given slot `x` and `y` position.
`protected double`	`getSlotSpanY(int xIndex, int yIndex)` Retrieves the number of slots spanned through the `y` axis by the children occupying the given slot `x` and `y` position.
`protected boolean`	`isVertical()` Returns if the shelf container is vertical or not.
`void`	`setDirection(int d)` Sets the direction of the outermost shelf item container.
`void`	`setSlotArray(ilog.tgo.model.internal.IltSlotArray s)` Sets the information about slots present in this container.
`void`	`setSlotSizes(ilog.tgo.model.internal.IltSlotSizes s)` Sets the information about slot sizes.

Methods inherited from class ilog.tgo.graphic.renderer.IltBaseRenderer
__isDottedBorderVisible, attach, boundingBox, boundingBoxWithTransformer, contains, containsExtraBorders, containsMain, draw, drawAlarmBorder, drawExtraBorder, drawExtraBorder, drawExtraBorders, drawMain, drawSelectionBorder, dropResources, getAlarmBorderColor, getAlarmBorderWidth, getAlarmColorLevel, getBackground, getBaseRenderer, getBaseRendererState, getBorderColor, getBorderColor2, getBorderLineStyle, getBorderPalette, getBorderPattern, getBorderWidth, getBrightPalette, getDarkPalette, getDeprecatedBlinkingMode, getDetailLevel, getDottedBorderBackground, getDottedBorderForeground, getDottedBorderLineStyle, getDottedBorderPalette, getExtraBorders, getFillAngle, getFillEnd, getFillStart, getFillStyle, getFillTexture, getForeground, getPalette, getPattern, getRepresentationObject, getSelectionBorderBackground, getSelectionBorderForeground, getSelectionBorderLineStyle, getSelectionBorderWidth, getSourceImage, getView, initBaseRenderer, initResources, isAlarmBorderVisible, isAlarmColorVisible, isBaseSelectionBorderVisible, isDottedBorderVisible, isExtraBorderOutside, isPolygonalBorder, isReliefBorders, isUsingBlinkingResources, setAlarmBorderColor, setAlarmBorderVisible, setAlarmBorderWidth, setAlarmColorLevel, setAlarmColorVisible, setBackground, setBaseRendererState, setBaseSelectionBorderVisible, setBorderColor, setBorderColor2, setBorderLineStyle, setBorderPattern, setBorderWidth, setDeprecatedBlinkingMode, setDetailLevel, setDottedBorderBackground, setDottedBorderForeground, setDottedBorderLineStyle, setDottedBorderVisible, setFillAngle, setFillEnd, setFillStart, setFillStyle, setFillTexture, setForeground, setPattern, setPolygonalBorder, setReliefBorders, setRepresentationObject, setSelectionBorderBackground, setSelectionBorderForeground, setSelectionBorderLineStyle, setSelectionBorderWidth, setSourceImage, setView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IltShelfItemContainerBaseRenderer
```
protected IltShelfItemContainerBaseRenderer()
```
    Default constructor.
  - IltShelfItemContainerBaseRenderer
```
protected IltShelfItemContainerBaseRenderer(ilog.tgo.graphic.renderer.internal.IltBaseRendererState state)
```
    For compatibility purposes, internal use only !
    
    Internal: do not use!
- Method Detail
  - createBaseRendererState
```
protected ilog.tgo.graphic.renderer.internal.IltBaseRendererState createBaseRendererState()
```
    Resets the properties
    
    Overrides:
    
    createBaseRendererState in class IltBaseRenderer
    
    Internal: do not use!
  - getDirection
```
public int getDirection()
```
    Returns the direction of the outermost shelf item container.
  - setDirection
```
public void setDirection(int d)
```
    Sets the direction of the outermost shelf item container.
  - setSlotArray
```
public void setSlotArray(ilog.tgo.model.internal.IltSlotArray s)
```
    Sets the information about slots present in this container.
    
    Internal: do not use!
  - getSlotArray
```
protected ilog.tgo.model.internal.IltSlotArray getSlotArray()
```
    Returns the information about slots present in this container.
    
    Internal: do not use!
  - setSlotSizes
```
public void setSlotSizes(ilog.tgo.model.internal.IltSlotSizes s)
```
    Sets the information about slot sizes.
    
    Internal: do not use!
  - getSlotSizes
```
protected ilog.tgo.model.internal.IltSlotSizes getSlotSizes()
```
    Returns the information about slots sizes present in this container.
    
    Internal: do not use!
  - isVertical
```
protected boolean isVertical()
```
    Returns if the shelf container is vertical or not.
    
    Internal: do not use!
  - getSlotCount
```
protected int getSlotCount()
```
    Access the total number of slots the container has.
    This function is not meant to be overridden in subclasses.
    
    Returns:
    
    The total number of slots, including x and y dimensions
  - getSlotCountX
```
protected int getSlotCountX()
```
    Access the total number of slots in the shelf along x axis.
    This function is not meant to be overridden in subclasses.
    
    Returns:
    
    The total number of slots in the x axis.
  - getSlotCountY
```
protected int getSlotCountY()
```
    Access the total number of slots in the shelf along y axis.
    This function is not meant to be overridden in subclasses.
    
    Returns:
    
    The total number of slots in the y axis.
  - getItem
```
protected IltObject getItem(int slotXIndex,
                            int slotYIndex)
```
    Returns the child item occupying the slot defined by slotXIndex and slotYIndex.
    The slot might be partially occupied by the returned item (if the corresponding slot span are not an integer).
    This function is not meant to be overridden in subclasses.
    
    Parameters:
    
    slotXIndex - The slot index for the X coordinate
    
    slotYIndex - The slot index for the Y coordinate
  - getSlotSpanX
```
protected double getSlotSpanX(int xIndex,
                              int yIndex)
```
    Retrieves the number of slots spanned through the x axis by the children occupying the given slot x and y position.
    If no item is present in the slot, it returns the number of contiguous empty slots around (x axis) the given slot.
    This function is not meant to be overridden in subclasses.
    
    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
  - getSlotSpanY
```
protected double getSlotSpanY(int xIndex,
                              int yIndex)
```
    Retrieves the number of slots spanned through the y axis by the children occupying the given slot x and y position.
    If no item is present in the slot, it returns the number of contiguous empty slots around (y axis) the given slot.
    This function is not meant to be overridden in subclasses.
    
    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
  - getSlotSepSize
```
protected int getSlotSepSize()
```
    Returns the distance separating two slots.
    This function is not meant to be overridden in subclasses.
  - getSlotBorderWidth
```
protected int getSlotBorderWidth()
```
    Returns the border thickness of the slots.
    This function is not meant to be overridden in subclasses.
    
    Since:
    
    JTGO 4.0
  - getSlotsBBox
```
protected abstract IlvRect getSlotsBBox(IlvRect drawRect)
```
    Returns the bounding box of all the slots in this shelf item container.
    
    Parameters:
    
    drawRect - the drawing rectangle of the shelf item container
  - getSlotRect
```
protected IlvRect getSlotRect(int slotXIndex,
                              int slotYIndex,
                              IlvRect drawRect)
```
    Returns the rectangle where the shelf item at the given slot position (defined by slotXIndex and slotYIndex indexes) should be drawn.
    
    Parameters:
    
    slotXIndex - The x index coordinate of the slot for which the drawing rectangle will be computed
    
    slotYIndex - The y index coordinate of the slot for which the drawing rectangle will be computed
    
    drawRect - The drawing rectangle of the shelf item container
    
    Returns:
    
    An IlvRect with integer coordinates
  - getSlotRect
```
public abstract IlvRect getSlotRect(int slotXIndex,
                                    double slotXSpan,
                                    int slotYIndex,
                                    double slotYSpan,
                                    IlvRect drawRect)
```
    Returns the rectangle where the shelf item at the given slot position (defined by slotXIndex and slotYIndex indexes) should be drawn.
    
    Parameters:
    
    slotXIndex - The x index coordinate of the slot for which the drawing rectangle will be computed
    
    slotXSpan - The span of the slot along the x axis
    
    slotYIndex - The y index coordinate of the slot for which the drawing rectangle will be computed
    
    slotYSpan - The span of the slot along the y axis
    
    drawRect - The drawing rectangle of the shelf item container
    
    Returns:
    
    An IlvRect with integer coordinates
  - getItem
```
protected IltObject getItem(int slotIndex)
```
    Returns the IltShelfItem at the given slotIndex.
    This function is not meant to be overridden in subclasses.
  - getItemSpan
```
protected double getItemSpan(int slotIndex)
```
    Returns the span value along the x axis for the IltShelfItem object at the given slot position.
    This function is not meant to be overridden in subclasses.
  - getSlotRect
```
protected IlvRect getSlotRect(int slotIndex,
                              IlvRect drawRect)
```
    Returns the rectangle where the shelf item at the given slotIndex should be drawn.
    
    Parameters:
    
    slotIndex - the index of the slot for which the drawing rectangle will be computed
    
    drawRect - the drawing rectangle of the shelf item container
    
    Returns:
    
    an IlvRect with integer coordinates
  - getSlotRect
```
protected IlvRect getSlotRect(int slotIndex,
                              double slotSpan,
                              IlvRect drawRect)
```
    Returns the rectangle where the shelf item at the given slotIndex should be drawn.
    
    Parameters:
    
    slotIndex - the index of the slot for which the drawing rectangle will be computed
    
    slotSpan - the span of the shelf item at the given slotIndex
    
    drawRect - the drawing rectangle of the shelf item container
    
    Returns:
    
    an IlvRect with integer coordinates

Class IltShelfItemContainerBaseRenderer

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.graphic.renderer.IltBaseRenderer

Methods inherited from class java.lang.Object

Constructor Detail

IltShelfItemContainerBaseRenderer

IltShelfItemContainerBaseRenderer

Method Detail

createBaseRendererState

getDirection

setDirection

setSlotArray

getSlotArray

setSlotSizes

getSlotSizes

isVertical

getSlotCount

getSlotCountX

getSlotCountY

getItem

getSlotSpanX

getSlotSpanY

getSlotSepSize

getSlotBorderWidth

getSlotsBBox

getSlotRect

getSlotRect

getItem

getItemSpan

getSlotRect

getSlotRect