ilog.tgo.graphic.renderer

Class IltCardCarrierBaseRenderer

java.lang.Object

ilog.tgo.graphic.renderer.IltBaseRenderer

ilog.tgo.graphic.renderer.IltShelfItemContainerBaseRenderer

ilog.tgo.graphic.renderer.IltCardCarrierBaseRenderer

Direct Known Subclasses:

IltCardCarrierBaseRenderer.Standard

public abstract class IltCardCarrierBaseRenderer
extends IltShelfItemContainerBaseRenderer

This class encapsulate the drawing functionality for the base of a card carrier.

Since:

JTGO 4.0

See Also:

IltCardCarrier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltCardCarrierBaseRenderer.Standard The base renderer for the standard CardCarrier representation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltCardCarrierBaseRenderer() Default constructor
protected	IltCardCarrierBaseRenderer(ilog.tgo.graphic.renderer.internal.IltBaseRendererState state) Used for compatibility with previous drawers.

Method Summary

Modifier and Type	Method and Description
protected ilog.tgo.graphic.renderer.internal.IltBaseRendererState	createBaseRendererState() Resets the properties
protected void	drawExtraBorders(Graphics g, IlvTransformer t, IlvRect rect) Draws the extra borders.
protected IlvRect	getBottomRect(IlvRect drawRect) Returns the rectangle at the bottom of the card carrier.
int	getBottomSpacing() Retuns the spacing that is part of the card carrier area.
protected IlvRect	getSlotRect(int slotIndex, double slotSpan, IlvRect drawRect) Returns the rectangle where the shelf item at the given slot index should be drawn.
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 slot index should be drawn.
protected IlvRect	getSlotsBBox(IlvRect drawRect) Returns the bounding box of all the slots in this shelf item container.
protected boolean	isExtraBorderOutside() Indicates whether the extra borders should be drawn inside or outside the rect used to call drawExtraBorders.
void	setBottomSpacing(int spacing) Sets the spacing of the card carrier area.

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

getDirection, getItem, getItem, getItemSpan, getSlotArray, getSlotBorderWidth, getSlotCount, getSlotCountX, getSlotCountY, getSlotRect, getSlotSepSize, getSlotSizes, getSlotSpanX, getSlotSpanY, isVertical, setDirection, setSlotArray, setSlotSizes

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

__isDottedBorderVisible, attach, boundingBox, boundingBoxWithTransformer, contains, containsExtraBorders, containsMain, draw, drawAlarmBorder, drawExtraBorder, drawExtraBorder, 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, 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

IltCardCarrierBaseRenderer

protected IltCardCarrierBaseRenderer()

Default constructor

IltCardCarrierBaseRenderer

protected IltCardCarrierBaseRenderer(ilog.tgo.graphic.renderer.internal.IltBaseRendererState state)

Used for compatibility with previous drawers.

Internal: do not use!

Method Detail

createBaseRendererState

protected ilog.tgo.graphic.renderer.internal.IltBaseRendererState createBaseRendererState()

Resets the properties

Overrides:

createBaseRendererState in class IltShelfItemContainerBaseRenderer

Internal: do not use!

getBottomSpacing

public int getBottomSpacing()

Retuns the spacing that is part of the card carrier area.

setBottomSpacing

public void setBottomSpacing(int spacing)

Sets the spacing of the card carrier area.

getBottomRect

protected IlvRect getBottomRect(IlvRect drawRect)

Returns the rectangle at the bottom of the card carrier.

This function is not meant to be overridden in subclasses.

Parameters:

drawRect - the drawing rectangle of the IltCardCarrier

Returns:

an IlvRect with integer coordinates

getSlotsBBox

protected IlvRect getSlotsBBox(IlvRect drawRect)

Returns the bounding box of all the slots in this shelf item container.

This function is not meant to be overridden in subclasses.

This implementation returns drawRect reduced by the size of the bottom rectangle of the IltCardCarrier.

Specified by:

getSlotsBBox in class IltShelfItemContainerBaseRenderer

Parameters:

drawRect - the drawing rectangle of the IltCardCarrier

getSlotRect

public 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.

Specified by:

getSlotRect in class IltShelfItemContainerBaseRenderer

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 (not used for this version of Card Carrier)

slotYSpan - The span of the slot along the y axis (not used for this version of Card Carrier)

drawRect - The drawing rectangle of the shelf item container

Returns:

An IlvRect with integer coordinates

drawExtraBorders

protected void drawExtraBorders(Graphics g,
                                IlvTransformer t,
                                IlvRect rect)

Draws the extra borders.

Overrides:

drawExtraBorders in class IltBaseRenderer

Parameters:

g - as in draw

t - as in draw

rect - as in draw

This implementation of this function calls drawExtraBorder once for each border that has to be drawn. The borders are drawn inside the bottom rectangle of the IltCardCarrier.

See Also:

IltBaseRenderer.drawExtraBorder(Graphics, IlvTransformer, IlvRect, IltPalette, int, int)

isExtraBorderOutside

protected boolean isExtraBorderOutside()

Indicates whether the extra borders should be drawn inside or outside the rect used to call drawExtraBorders.

This implementation returns false as we assume that for card carriers the borders should be drawn inside the bottom rectangle.

Specified by:

isExtraBorderOutside in class IltBaseRenderer

getSlotRect

protected IlvRect getSlotRect(int slotIndex,
                              IlvRect drawRect)

Returns the rectangle where the shelf item at the given slot index should be drawn.

This function is not meant to be overridden in subclasses.

Overrides:

getSlotRect in class IltShelfItemContainerBaseRenderer

Parameters:

slotIndex - the index of the slot

drawRect - the drawing rectangle of the IltCardCarrier

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 slot index should be drawn.

This function is not meant to be overridden in subclasses.

Overrides:

getSlotRect in class IltShelfItemContainerBaseRenderer

Parameters:

slotIndex - the index of the slot

slotSpan - the span of the shelf item at the given slotIndex

drawRect - the drawing rectangle of the IltCardCarrier

Returns:

an IlvRect with integer coordinates