ilog.tgo.graphic

Class IltCounterMapping

java.lang.Object

ilog.tgo.graphic.IltCounterMapping

public class IltCounterMapping
extends Object

This class stores the configuration used to create an IltCounter decoration.

Constructor Summary

Constructors

Constructor and Description
IltCounterMapping() Creates a counter decoration with default parameters.
IltCounterMapping(NumberFormat format, Font font, boolean antialiasing, Color fg, Color bg, Color border, int xPadding, int yPadding, int heading, boolean stackGlyphs) Creates a counter decoration.
IltCounterMapping(NumberFormat format, Font font, Color fg, Color bg, Color border, int xPadding, int yPadding, int heading, boolean stackGlyphs) Creates a counter decoration.
IltCounterMapping(NumberFormat format, IlpFontKey font, Font defaultFontValue, IlpBooleanKey antialiasing, boolean defaultAntialiasingValue, IlpColorKey fg, Color defaultFgValue, IlpColorKey bg, Color defaultBgValue, IlpColorKey border, Color defaultBorderValue, int xPadding, int yPadding, int heading, boolean stackGlyphs) Deprecated. Styles have been replaced by CSS customization.
IltCounterMapping(NumberFormat format, IlpFontKey font, Font defaultFontValue, IlpColorKey fg, Color defaultFgValue, IlpColorKey bg, Color defaultBgValue, IlpColorKey border, Color defaultBorderValue, int xPadding, int yPadding, int heading, boolean stackGlyphs) Deprecated. Styles have been replaced by CSS customization.
IltCounterMapping(NumberFormat format, IltKey.Font font, Font defaultFontValue, IltKey.Boolean antialiasing, boolean defaultAntialiasingValue, IltKey.Color fg, Color defaultFgValue, IltKey.Color bg, Color defaultBgValue, IltKey.Color border, Color defaultBorderValue, int xPadding, int yPadding, int heading, boolean stackGlyphs) Deprecated. Please use IlpKey version instead.
IltCounterMapping(NumberFormat format, IltKey.Font font, Font defaultFontValue, IltKey.Color fg, Color defaultFgValue, IltKey.Color bg, Color defaultBgValue, IltKey.Color border, Color defaultBorderValue, int xPadding, int yPadding, int heading, boolean stackGlyphs) Deprecated. Please use IlpKey version instead.

Method Summary

Modifier and Type	Method and Description
Color	getBackgroundColor() Returns the background color value to be used in the counter decoration.
Color	getBackgroundColor(IltGraphic g) Returns the background color value to be used in the counter decoration.
Color	getBorderColor() Returns the border color value to be used in the counter decoration.
Color	getBorderColor(IltGraphic g) Returns the border color value to be used in the counter decoration.
Font	getFont() Returns the font value to be used in the counter decoration.
Font	getFont(IltGraphic g) Returns the font value to be used in the counter decoration.
Color	getForegroundColor() Returns the foreground color value to be used in the counter decoration.
Color	getForegroundColor(IltGraphic g) Returns the foreground color value to be used in the counter decoration.
NumberFormat	getFormat() Returns the format used for the digits.
int	getHeading() Returns the direction of the label.
boolean	getStackGlyphs() Returns true if the glyphs are kept upright but stacked under each other, if the heading is vertical; otherwise, returns false.
int	getXPadding() Returns the distance, on the x axis, between the digits and the counter border.
int	getYPadding() Returns the distance, on the y axis, between the digits and the counter border.
boolean	isAntialiasing() Returns the anti-aliasing value to be used in the counter decoration.
boolean	isAntialiasing(IltGraphic g) Returns the anti-aliasing value to be used in the counter decoration.
void	registerLegendKeys() This method registers the legend keys in the IltObject class legend, if the keys are being used instead of local values.
void	setAntialiasing(boolean antialiasing) Sets the anti-aliasing value to be used in the counter decoration.
void	setBackgroundColor(Color bg) Sets the background color value to be used in the counter decoration.
void	setBorderColor(Color border) Sets the border color value to be used in the counter decoration.
void	setFont(Font font) Sets the font value to be used in the counter decoration.
void	setForegroundColor(Color fg) Sets the foreground color value to be used in the counter decoration.
void	setFormat(NumberFormat format) Sets the format used for the digits.
void	setHeading(int value) Sets the direction of the label.
void	setStackGlyphs(boolean value) Specifies whether the glyphs are kept upright but stacked under each other, if the heading is vertical.
void	setXPadding(int value) Sets the distance, on the x axis, between the digits and the counter border.
void	setYPadding(int value) Sets the distance, on the y axis, between the digits and the counter border.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IltCounterMapping

public IltCounterMapping()

Creates a counter decoration with default parameters.

IltCounterMapping

public IltCounterMapping(NumberFormat format,
                         Font font,
                         Color fg,
                         Color bg,
                         Color border,
                         int xPadding,
                         int yPadding,
                         int heading,
                         boolean stackGlyphs)

Creates a counter decoration.

Parameters:

format - The format of the value displayed by the counter.

font - The font used for the digits.

fg - The color of the digits.

bg - The background color.

border - The border color.

xPadding - The horizontal padding.

yPadding - The vertical padding.

heading - The direction of the label, one of IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

stackGlyphs - If true, glyphs are kept upright, but stacked under each other if the heading is vertical.

IltCounterMapping

public IltCounterMapping(NumberFormat format,
                         Font font,
                         boolean antialiasing,
                         Color fg,
                         Color bg,
                         Color border,
                         int xPadding,
                         int yPadding,
                         int heading,
                         boolean stackGlyphs)

Creates a counter decoration.

Parameters:

format - The format of the value displayed by the counter.

font - The font used for the digits.

antialiasing - (works only with Java2)

fg - The color of the digits.

bg - The background color.

border - The border color.

xPadding - The horizontal padding.

yPadding - The vertical padding.

heading - The direction of the label, one of IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

stackGlyphs - If true, glyphs are kept upright, but stacked under each other if the heading is vertical.

IltCounterMapping

@Deprecated
public IltCounterMapping(NumberFormat format,
                                     IlpFontKey font,
                                     Font defaultFontValue,
                                     IlpColorKey fg,
                                     Color defaultFgValue,
                                     IlpColorKey bg,
                                     Color defaultBgValue,
                                     IlpColorKey border,
                                     Color defaultBorderValue,
                                     int xPadding,
                                     int yPadding,
                                     int heading,
                                     boolean stackGlyphs)

Deprecated. Styles have been replaced by CSS customization.

Creates a counter decoration.

Parameters:

format - The format of the value displayed by the counter.

font - The legend key used to retrieve the font used for the digits.

defaultFontValue - The default value set for the font legend key.

fg - The legend key used to retrieve the color of the digits.

defaultFgValue - The default value set for the foreground color legend key.

bg - The background color.

defaultBgValue - The default value set for the background color legend key.

border - The legend key used to retrieve the border color.

defaultBorderValue - The default value set for the border color legend key.

xPadding - The horizontal padding.

yPadding - The vertical padding.

heading - The direction of the label, one of IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

stackGlyphs - If true, glyphs are kept upright, but stacked under each other if the heading is vertical.

Deprecated Since:

JTGO 3.5

IltCounterMapping

@Deprecated
public IltCounterMapping(NumberFormat format,
                                     IlpFontKey font,
                                     Font defaultFontValue,
                                     IlpBooleanKey antialiasing,
                                     boolean defaultAntialiasingValue,
                                     IlpColorKey fg,
                                     Color defaultFgValue,
                                     IlpColorKey bg,
                                     Color defaultBgValue,
                                     IlpColorKey border,
                                     Color defaultBorderValue,
                                     int xPadding,
                                     int yPadding,
                                     int heading,
                                     boolean stackGlyphs)

Deprecated. Styles have been replaced by CSS customization.

Creates a counter decoration.

Parameters:

format - The format of the value displayed by the counter.

font - The legend key used to retrieve the font used for the digits.

defaultFontValue - The default value set for the font legend key.

antialiasing - The legend key used to retrieve the anti-aliasing setting for the digits.

defaultAntialiasingValue - The default value set for the anti-aliasing legend key.

fg - The legend key used to retrieve the color of the digits.

defaultFgValue - The default value set for the foreground color legend key.

bg - The background color.

defaultBgValue - The default value set for the background color legend key.

border - The legend key used to retrieve the border color.

defaultBorderValue - The default value set for the border color legend key.

xPadding - The horizontal padding.

yPadding - The vertical padding.

heading - The direction of the label, one of IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

stackGlyphs - If true, glyphs are kept upright, but stacked under each other if the heading is vertical.

Deprecated Since:

JTGO 3.5

IltCounterMapping

@Deprecated
public IltCounterMapping(NumberFormat format,
                                     IltKey.Font font,
                                     Font defaultFontValue,
                                     IltKey.Color fg,
                                     Color defaultFgValue,
                                     IltKey.Color bg,
                                     Color defaultBgValue,
                                     IltKey.Color border,
                                     Color defaultBorderValue,
                                     int xPadding,
                                     int yPadding,
                                     int heading,
                                     boolean stackGlyphs)

Deprecated. Please use IlpKey version instead.

Creates a counter decoration.

Parameters:

format - The format of the value displayed by the counter.

font - The legend key used to retrieve the font used for the digits.

defaultFontValue - The default value set for the font legend key.

fg - The legend key used to retrieve the color of the digits.

defaultFgValue - The default value set for the foreground color legend key.

bg - The background color.

defaultBgValue - The default value set for the background color legend key.

border - The legend key used to retrieve the border color.

defaultBorderValue - The default value set for the border color legend key.

xPadding - The horizontal padding.

yPadding - The vertical padding.

heading - The direction of the label, one of IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

stackGlyphs - If true, glyphs are kept upright, but stacked under each other if the heading is vertical.

Deprecated Since:

JTGO 3.0

IltCounterMapping

@Deprecated
public IltCounterMapping(NumberFormat format,
                                     IltKey.Font font,
                                     Font defaultFontValue,
                                     IltKey.Boolean antialiasing,
                                     boolean defaultAntialiasingValue,
                                     IltKey.Color fg,
                                     Color defaultFgValue,
                                     IltKey.Color bg,
                                     Color defaultBgValue,
                                     IltKey.Color border,
                                     Color defaultBorderValue,
                                     int xPadding,
                                     int yPadding,
                                     int heading,
                                     boolean stackGlyphs)

Deprecated. Please use IlpKey version instead.

Creates a counter decoration.

Parameters:

format - The format of the value displayed by the counter.

font - The legend key used to retrieve the font used for the digits.

defaultFontValue - The default value set for the font legend key.

antialiasing - The legend key used to retrieve the anti-aliasing setting for the digits.

defaultAntialiasingValue - The default value set for the anti-aliasing legend key.

fg - The legend key used to retrieve the color of the digits.

defaultFgValue - The default value set for the foreground color legend key.

bg - The background color.

defaultBgValue - The default value set for the background color legend key.

border - The legend key used to retrieve the border color.

defaultBorderValue - The default value set for the border color legend key.

xPadding - The horizontal padding.

yPadding - The vertical padding.

heading - The direction of the label, one of IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

stackGlyphs - If true, glyphs are kept upright, but stacked under each other if the heading is vertical.

Deprecated Since:

JTGO 3.0

Method Detail

getFormat

public NumberFormat getFormat()

Returns the format used for the digits.

setFormat

public void setFormat(NumberFormat format)

Sets the format used for the digits.

getXPadding

public int getXPadding()

Returns the distance, on the x axis, between the digits and the counter border.

setXPadding

public void setXPadding(int value)

Sets the distance, on the x axis, between the digits and the counter border.

getYPadding

public int getYPadding()

Returns the distance, on the y axis, between the digits and the counter border.

setYPadding

public void setYPadding(int value)

Sets the distance, on the y axis, between the digits and the counter border.

getHeading

public int getHeading()

Returns the direction of the label. Possible values are: IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

setHeading

public void setHeading(int value)

Sets the direction of the label. Possible values are: IlvDirection.Bottom, IlvDirection.Top, IlvDirection.Left, or IlvDirection.Right.

getStackGlyphs

public boolean getStackGlyphs()

Returns true if the glyphs are kept upright but stacked under each other, if the heading is vertical; otherwise, returns false.

setStackGlyphs

public void setStackGlyphs(boolean value)

Specifies whether the glyphs are kept upright but stacked under each other, if the heading is vertical.

getFont

public Font getFont(IltGraphic g)

Returns the font value to be used in the counter decoration.

getFont

public Font getFont()

Returns the font value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

setFont

public void setFont(Font font)

Sets the font value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

isAntialiasing

public boolean isAntialiasing(IltGraphic g)

Returns the anti-aliasing value to be used in the counter decoration.

isAntialiasing

public boolean isAntialiasing()

Returns the anti-aliasing value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

setAntialiasing

public void setAntialiasing(boolean antialiasing)

Sets the anti-aliasing value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

getForegroundColor

public Color getForegroundColor(IltGraphic g)

Returns the foreground color value to be used in the counter decoration.

getForegroundColor

public Color getForegroundColor()

Returns the foreground color value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

setForegroundColor

public void setForegroundColor(Color fg)

Sets the foreground color value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

getBackgroundColor

public Color getBackgroundColor(IltGraphic g)

Returns the background color value to be used in the counter decoration.

getBackgroundColor

public Color getBackgroundColor()

Returns the background color value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

setBackgroundColor

public void setBackgroundColor(Color bg)

Sets the background color value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

getBorderColor

public Color getBorderColor(IltGraphic g)

Returns the border color value to be used in the counter decoration.

getBorderColor

public Color getBorderColor()

Returns the border color value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

setBorderColor

public void setBorderColor(Color border)

Sets the border color value to be used in the counter decoration. This method is used by CSS styling mechanism and is not meant to be called directly.

Internal: do not use!

registerLegendKeys

public void registerLegendKeys()

This method registers the legend keys in the IltObject class legend, if the keys are being used instead of local values.

Internal: do not use!