ilog.tgo.graphic.renderer

Class IltShelfBaseRenderer

java.lang.Object

ilog.tgo.graphic.renderer.IltBaseRenderer

ilog.tgo.graphic.renderer.IltShelfItemContainerBaseRenderer

ilog.tgo.graphic.renderer.IltShelfBaseRenderer

Direct Known Subclasses:

IltShelfBaseRenderer.Standard

public abstract class IltShelfBaseRenderer
extends IltShelfItemContainerBaseRenderer

This class encapsulates the drawing functionality for the base of a shelf.

Since:

JTGO 4.0

See Also:

IltShelf

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected IlvRect	boundingBoxWithTransformer(IlvTransformer t, IlvRect rect, boolean withSelection) Computes the shelf bounding box taking the given transfomer into account.
protected ilog.tgo.graphic.renderer.internal.IltBaseRendererState	createBaseRendererState() Resets the properties
void	draw(Graphics g, IlvTransformer t, IlvRect rect) Draws the entire base, such that it fits into a given rectangle.
void	drawSlotNumbers(Graphics g, IlvTransformer t, IlvRect drawRect) Draws the slot numbers in the bounding box of the slot numbers.
Color	getFrameForeground() Returns the color of the shelf frame.
protected Ilt2DPalette	getFramePalette() Returns the palette of the shelf frame.
Font	getLabelFont() Returns the font of the slot numbers.
Color	getLabelForeground() Returns the color of the slot numbers.
int	getLabelPosition() Returns the label position relative to the base.
int	getLabelSpacing() Returns the height of the space separating displayed logical numbers from the shelf outline.
IlvRect	getSlotNumbersBBox(IlvTransformer t, IlvRect drawRect) Returns the bounding box of the area where the slot numbers 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.
IlvRect	getSlotsBBox(IlvRect drawRect) Returns the bounding box of all the slots in this shelf item container.
int	getXSlotIndex() Returns the value of the first slot number for the numbers that will be displayed either below or above the shelf frame.
String	getXSlotLabel(int index) Returns the label that represents the given slot.
String[]	getXSlotLabels() Returns the value of the slot labels that will be displayed either below or above the shelf frame.
protected boolean	isExtraBorderOutside() Specifies whether the extra borders should be drawn inside or outside the rect used to call drawExtraBorders.
boolean	isLabelAntialiasing() Returns if the slot numbers label uses anti-aliasing.
boolean	isLabelVisible() Returns if the slot numbers are visible.
void	setFrameForeground(Color c) Sets the color of the shelf frame.
void	setLabelAntialiasing(boolean v) Sets if the slot numbers label uses anti-aliasing.
void	setLabelFont(Font f) Sets the font of the slot numbers.
void	setLabelForeground(Color c) Sets the color of the slot numbers.
void	setLabelPosition(int v) Sets the label position relative to the base.
void	setLabelSpacing(int v) Returns the height of the space separating displayed logical numbers from the shelf outline.
void	setLabelVisible(boolean v) Sets if the slot numbers are visible.
void	setXSlotIndex(int x) Sets the value of the first slot number for the numbers that will be displayed either below or above the shelf frame.
void	setXSlotLabels(String[] labels) Sets the value of slot labels that will be displayed either below or above the shelf frame.

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

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

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

__isDottedBorderVisible, attach, boundingBox, contains, containsExtraBorders, containsMain, 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, 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

IltShelfBaseRenderer

protected IltShelfBaseRenderer()

Default constructor

IltShelfBaseRenderer

protected IltShelfBaseRenderer(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!

getFrameForeground

public Color getFrameForeground()

Returns the color of the shelf frame.

setFrameForeground

public void setFrameForeground(Color c)

Sets the color of the shelf frame.

isLabelVisible

public boolean isLabelVisible()

Returns if the slot numbers are visible.

setLabelVisible

public void setLabelVisible(boolean v)

Sets if the slot numbers are visible.

isLabelAntialiasing

public final boolean isLabelAntialiasing()

Returns if the slot numbers label uses anti-aliasing.

setLabelAntialiasing

public final void setLabelAntialiasing(boolean v)

Sets if the slot numbers label uses anti-aliasing.

getLabelFont

public Font getLabelFont()

Returns the font of the slot numbers.

setLabelFont

public void setLabelFont(Font f)

Sets the font of the slot numbers.

getLabelForeground

public Color getLabelForeground()

Returns the color of the slot numbers.

setLabelForeground

public void setLabelForeground(Color c)

Sets the color of the slot numbers.

getLabelSpacing

public int getLabelSpacing()

Returns the height of the space separating displayed logical numbers from the shelf outline.

setLabelSpacing

public void setLabelSpacing(int v)

Returns the height of the space separating displayed logical numbers from the shelf outline.

getLabelPosition

public int getLabelPosition()

Returns the label position relative to the base.

Possible values are:

• IlvDirection.Top
• IlvDirection.Bottom

setLabelPosition

public void setLabelPosition(int v)

Sets the label position relative to the base.

Possible values are:

• IlvDirection.Top
• IlvDirection.Bottom

getXSlotIndex

public int getXSlotIndex()

Returns the value of the first slot number for the numbers that will be displayed either below or above the shelf frame.

setXSlotIndex

public void setXSlotIndex(int x)

Sets the value of the first slot number for the numbers that will be displayed either below or above the shelf frame.

getXSlotLabels

public String[] getXSlotLabels()

Returns the value of the slot labels that will be displayed either below or above the shelf frame.

Returns:

The labels as defined by CSS property XSlotLabels or null if nothing was defined in CSS.

See Also:

getXSlotLabel(int)

setXSlotLabels

public void setXSlotLabels(String[] labels)

Sets the value of slot labels that will be displayed either below or above the shelf frame.

Parameters:

labels - Slot label array.

See Also:

getXSlotLabel(int)

getXSlotLabel

public String getXSlotLabel(int index)

Returns the label that represents the given slot.

This method executes the following steps to compute the slot label:

• First, it verifies if property slotLabels is defined. If this property is defined, this method retrieves the label that corresponds to the given slot, if there is one. If a label is not found, this method returns an empty label.
• If the slotLabels property is not defined, this method will compute a slot label based on the slot index parameter and the value of X Slot index property defined in this base renderer.

In case of horizontal shelves, the slot label should not exceed the width of the slot. Whenever this happens, the label is automatically truncated by this base renderer. In order to have a better graphic representation, the use of short labels is recommended.

Parameters:

index - Slot index.

See Also:

setXSlotIndex(int), setXSlotLabels(java.lang.String[])

getFramePalette

protected Ilt2DPalette getFramePalette()

Returns the palette of the shelf frame.

The value depends on the semantic state of the object. This palette is automatically built depending on CSS properties.

See the description array at the beginning of this file, for more information on the policy used to build this palette.

isExtraBorderOutside

protected boolean isExtraBorderOutside()

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

This implementation returns true as the borders should be drawn outside rectfor shelves.

Specified by:

isExtraBorderOutside in class IltBaseRenderer

getSlotsBBox

public IlvRect getSlotsBBox(IlvRect drawRect)

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

This implementation returns drawRect reduced by the outline thickness of the shelf.

Specified by:

getSlotsBBox in class IltShelfItemContainerBaseRenderer

Parameters:

drawRect - As in draw.

See Also:

IltObject.BorderWidth

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.

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

getSlotNumbersBBox

public IlvRect getSlotNumbersBBox(IlvTransformer t,
                                  IlvRect drawRect)

Returns the bounding box of the area where the slot numbers should be drawn.

Parameters:

t - Transformer applied to the slot numbers.

drawRect - As in draw.

Since:

JTGO 4.0

drawSlotNumbers

public void drawSlotNumbers(Graphics g,
                            IlvTransformer t,
                            IlvRect drawRect)

Draws the slot numbers in the bounding box of the slot numbers.

Parameters:

g - As in draw.

t - As in draw.

drawRect - As in draw.

draw

public void draw(Graphics g,
                 IlvTransformer t,
                 IlvRect rect)

Draws the entire base, such that it fits into a given rectangle.

Overrides:

draw in class IltBaseRenderer

Parameters:

g - The graphics context to draw into.

t - The transformer that has been applied to rect. (It is only passed because drawing with an Ilt2DPalette requires it.)

rect - The rectangle to draw into. This is a rectangle with integer coordinates. Its corners have the following coordinates: x₁ = rect.x, x₂ = rect.x + rect.width - 1, y₁ = rect.y, y₂ = rect.y + rect.height - 1.

This implementation of the function calls drawMain, then drawExtraBorders, and finally drawSlotNumbers.

boundingBoxWithTransformer

protected IlvRect boundingBoxWithTransformer(IlvTransformer t,
                                             IlvRect rect,
                                             boolean withSelection)

Computes the shelf bounding box taking the given transfomer into account.

Overrides:

boundingBoxWithTransformer in class IltBaseRenderer

Parameters:

t - Transformer currently set in the view.

rect - Rectangle with the raw value.

withSelection - Indicates if bounding box will include selection border or not.

Internal: do not use!