ilog.views.chart
Class IlvLabelRenderer

ilog.views.chart.IlvLabelRenderer

public class IlvLabelRenderer

Renders a label. This class lets you control the appearance of labels.

CSS example:

ilvLabelRenderer {
    class : "ilog.views.chart.IlvLabelRenderer";
    alignment : "2";
    autoWrapping : "false";
    background : "green";
    backgroundPaint : "#000000";
    border : "@#emptyBorder";
    caching : "false";
    color : "green";
    font : "sansserif-BOLD-8";
    opaque : "false";
    outline : "false";
    rotation : "3.0";
    scalingFont : "false";
    wrappingWidth : "2.0";
}


Property Summary
 int alignment
          
Specifies the label alignment.
 boolean autoWrapping
          
Toggles automatic wrapping.
 java.awt.Color background
          
Sets the label background.
 Paint backgroundPaint
          
Sets the background paint.
 Border border
          
Sets a border for this label.
 boolean caching
          
Determines whether this label renderer caches previous text layouts and bounds, for speed.
 java.lang.String class
          
Creates a new IlvLabelRenderer object with a null rotation.
 java.awt.Color color
          
Sets the label color.
 java.awt.Font font
          
Sets the label font.
 boolean opaque
          
Specifies whether the background of the label is filled.
 boolean outline
          
Specifies whether the label is drawn in outline mode.
 double rotation
          
Sets the rotation applied to the label.
 boolean scalingFont
          
Sets whether this label renderer enables the font scaling.
 float wrappingWidth
          
Sets the wrapping width.
 

Property Detail

class

public java.lang.String class

Creates a new IlvLabelRenderer object with a null rotation.

CSS example:     class : "ilog.views.chart.IlvLabelRenderer";


alignment

public int alignment

Specifies the label alignment.

The alignment is only used for multiline labels. It can take the following values:


CSS example:     alignment : "2";


autoWrapping

public boolean autoWrapping

Toggles automatic wrapping.

CSS example:     autoWrapping : "false";


background

public java.awt.Color background

Sets the label background. The background is only filled when the label is opaque.

CSS example:     background : "green";

A color can either be a string representing a color or else an octal or hexadecimal string that starts with the character "#" or else a comma separated "RGB" value where the integer values are in the range 0..255.

See Also:
backgroundPaint

backgroundPaint

public Paint backgroundPaint

Sets the background paint. The background is only filled when the label is opaque.

CSS example:     backgroundPaint : "#000000";


border

public Border border

Sets a border for this label.

CSS example:     border : "@#emptyBorder";

See implementing class EmptyBorder for an example of implementing a border.


caching

public boolean caching

Determines whether this label renderer caches previous text layouts and bounds, for speed. This is tradeoff between use of memory and use of CPU time.

When set to true, this label renderer will memoize the line breaking, text layouts and bounds of all previous settings, as far as memory permits. This is useful when a label renderer is used to draw or measure many labels.

When set to false, this label renderer will memoize the line breaking, text layouts and bounds of the last setting. This is useful when a label renderer is used for a single label only.

The default value is true.

CSS example:     caching : "false";


color

public java.awt.Color color

Sets the label color.

CSS example:     color : "green";

A color can either be a string representing a color or else an octal or hexadecimal string that starts with the character "#" or else a comma separated "RGB" value where the integer values are in the range 0..255.


font

public java.awt.Font font

Sets the label font.

CSS example:     font : "sansserif-BOLD-8";


opaque

public boolean opaque

Specifies whether the background of the label is filled.

CSS example:     opaque : "false";


outline

public boolean outline

Specifies whether the label is drawn in outline mode. If true, the label is surrounded by a thin shadow border, increasing the contrast to the background.

CSS example:     outline : "false";


rotation

public double rotation

Sets the rotation applied to the label.

CSS example:     rotation : "3.0";


scalingFont

public boolean scalingFont

Sets whether this label renderer enables the font scaling. The scalingFont property is only used if a font has been specified for this renderer.

CSS example:     scalingFont : "false";


wrappingWidth

public float wrappingWidth

Sets the wrapping width.

CSS example:     wrappingWidth : "2.0";



Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.