IlvLabelRenderer (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvLabelRenderer

All Implemented Interfaces:

Serializable, SwingConstants
```
public class IlvLabelRenderer
extends Object
implements Serializable, SwingConstants
```
Renders a label. This class lets you control the appearance of labels.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary
- Fields inherited from interface javax.swing.SwingConstants
  BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors
Constructor and Description
`IlvLabelRenderer()` Creates a new `IlvLabelRenderer` object with a null rotation.
`IlvLabelRenderer(Color bg, Color fg)` Creates a new filled and outlined `IlvLabelRenderer`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener to this object.
`void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue, int effects)` Notifies the listeners when a property change occurred.
`int`	`getAlignment()` Returns the label alignment.
`Color`	`getBackground()` Returns the background color.
`Paint`	`getBackgroundPaint()` Returns the background paint.
`Shape`	`getBackgroundShape(JComponent comp, double x, double y, String label)` Returns the combined background shapes of the text lines, according to the given position.
`Border`	`getBorder()` Returns the border of this label.
`Rectangle2D`	`getBounds(JComponent comp, double x, double y, String label, Rectangle2D bounds)` Returns the label bounds, according to the given position.
`Color`	`getColor()` Returns the label color.
`Font`	`getFont()` Returns the label font.
`double`	`getRotation()` Returns the rotation applied to the label.
`Dimension`	`getSize(JComponent comp, String label, boolean useBorder, boolean useRotation)` Returns the size of the specified label, when displayed by this renderer.
`Dimension2D`	`getSize2D(JComponent comp, String label, boolean useBorder, boolean useRotation)` Returns the size of the specified label, when displayed by this renderer.
`float`	`getWrappingWidth()` Returns the wrapping width.
`boolean`	`isAutoWrapping()` Indicates whether automatic wrapping is used.
`boolean`	`isCaching()` Returns `true` if this label renderer caches previous text layouts and bounds, for speed.
`boolean`	`isOpaque()` Indicates whether the background of the label is filled.
`boolean`	`isOutline()` Indicates whether the label is drawn in outline mode.
`boolean`	`isScalingFont()` Returns whether this label renderer enables the font scaling.
`void`	`paintLabel(JComponent comp, Color foreground, Graphics g, String label, double x, double y)` Paints the label at the given position.
`void`	`paintLabel(JComponent comp, Graphics g, String label, double x, double y)` Paints the label at the given position.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener from this object.
`void`	`setAlignment(int alignment)` Specifies the label alignment.
`void`	`setAutoWrapping(boolean autoWrapping)` Toggles automatic wrapping.
`void`	`setBackground(Color color)` Sets the label background.
`void`	`setBackgroundPaint(Paint paint)` Sets the background paint.
`void`	`setBorder(Border border)` Sets a border for this label.
`void`	`setCaching(boolean caching)` Determines whether this label renderer caches previous text layouts and bounds, for speed.
`void`	`setColor(Color color)` Sets the label color.
`void`	`setFont(Font font)` Sets the label font.
`void`	`setOpaque(boolean opaque)` Specifies whether the background of the label is filled.
`void`	`setOutline(boolean outline)` Specifies whether the label is drawn in outline mode.
`void`	`setRotation(double rotation)` Sets the rotation applied to the label.
`void`	`setScalingFont(boolean scalingFont)` Sets whether this label renderer enables the font scaling.
`void`	`setWrappingWidth(float wrappingWidth)` Sets the wrapping width.
`protected void`	`stateChanged()` Called when a change occurred.

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

- Constructor Detail
  - IlvLabelRenderer
```
public IlvLabelRenderer()
```
    Creates a new IlvLabelRenderer object with a null rotation.
  - IlvLabelRenderer
```
public IlvLabelRenderer(Color bg,
                        Color fg)
```
    Creates a new filled and outlined IlvLabelRenderer. The created renderer is opaque and uses a line border.
    
    See Also:
    
    setOpaque(boolean), setBorder(javax.swing.border.Border)
- Method Detail
  - getFont
```
public final Font getFont()
```
    Returns the label font.
  - setFont
```
public void setFont(Font font)
```
    Sets the label font.
  - isScalingFont
```
public final boolean isScalingFont()
```
    Returns whether this label renderer enables the font scaling.
    
    Since:
    
    JViews 5.5
  - setScalingFont
```
public void setScalingFont(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.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setFont(java.awt.Font), IlvChart.setScalingFont(boolean)
  - getColor
```
public final Color getColor()
```
    Returns the label color. It may be a normal Color or an IlvContrastingColor.
  - setColor
```
public void setColor(Color color)
```
    Sets the label color.
    
    Parameters:
    
    color - A normal Color or an IlvContrastingColor.
  - getBackground
```
public final Color getBackground()
```
    Returns the background color.
    
    Returns:
    
    The background color. Returns null if no background has been specified, or if the background paint is not an instance of java.awt.Color.
    
    See Also:
    
    setBackgroundPaint(java.awt.Paint)
  - getBackgroundPaint
```
public final Paint getBackgroundPaint()
```
    Returns the background paint.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setBackgroundPaint(java.awt.Paint)
  - setBackground
```
public void setBackground(Color color)
```
    Sets the label background. The background is only filled when the label is opaque.
    
    See Also:
    
    setOpaque(boolean)
  - setBackgroundPaint
```
public void setBackgroundPaint(Paint paint)
```
    Sets the background paint. The background is only filled when the label is opaque.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setOpaque(boolean)
  - getRotation
```
public final double getRotation()
```
    Returns the rotation applied to the label.
    
    Returns:
    
    The angle of the rotation expressed in degrees.
  - setRotation
```
public void setRotation(double rotation)
```
    Sets the rotation applied to the label.
    
    Parameters:
    
    rotation - The angle of the rotation in degrees.
  - isOpaque
```
public final boolean isOpaque()
```
    Indicates whether the background of the label is filled.
    
    See Also:
    
    setOpaque(boolean)
  - setOpaque
```
public void setOpaque(boolean opaque)
```
    Specifies whether the background of the label is filled.
    
    See Also:
    
    isOpaque()
  - isOutline
```
public final boolean isOutline()
```
    Indicates whether the label is drawn in outline mode. In outline mode, the label is surrounded by a thin shadow border, increasing the contrast to the background.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setOutline(boolean)
  - setOutline
```
public void setOutline(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.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    isOutline()
  - getAlignment
```
public final int getAlignment()
```
    Returns the label alignment.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setAlignment(int)
  - setAlignment
```
public void setAlignment(int alignment)
```
    Specifies the label alignment.
    The alignment is only used for multiline labels. It can take the following values:
    - SwingConstants.LEFT: left alignment.
    - SwingConstants.CENTER (default): centered alignment.
    - SwingConstants.RIGHT: right alignment.
    Throws:
    
    IllegalArgumentException - The alignment constant is incorrect.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setAutoWrapping(boolean), getAlignment()
  - isAutoWrapping
```
public final boolean isAutoWrapping()
```
    Indicates whether automatic wrapping is used.
    
    Since:
    
    JViews 5.5
  - setAutoWrapping
```
public void setAutoWrapping(boolean autoWrapping)
```
    Toggles automatic wrapping.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setWrappingWidth(float)
  - getWrappingWidth
```
public final float getWrappingWidth()
```
    Returns the wrapping width.
    
    Since:
    
    JViews 5.5
  - setWrappingWidth
```
public void setWrappingWidth(float wrappingWidth)
```
    Sets the wrapping width.
    
    Parameters:
    
    wrappingWidth - The maximum width of a line, in pixels, before a line break is forced (when isAutoWrapping() returns true).
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setAutoWrapping(boolean)
  - getBorder
```
public final Border getBorder()
```
    Returns the border of this label.
    
    See Also:
    
    setBorder(javax.swing.border.Border)
  - setBorder
```
public void setBorder(Border border)
```
    Sets a border for this label.
    
    See Also:
    
    getBorder()
  - isCaching
```
public final boolean isCaching()
```
    Returns true if this label renderer caches previous text layouts and bounds, for speed.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setCaching(boolean)
  - setCaching
```
public void setCaching(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.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    isCaching()
  - paintLabel
```
public void paintLabel(JComponent comp,
                       Graphics g,
                       String label,
                       double x,
                       double y)
```
    Paints the label at the given position. The position is defined as the invariant point of the rotation, that is, the center of the object.
    
    Parameters:
    
    comp - The component rendering the label. This argument is used to get properties such as background and foreground colors if they are not specified by the label renderer.
    
    g - The Graphics context to draw in.
    
    label - The string to draw.
    
    x - The x-coordinate of the label center.
    
    y - The y-coordinate of the label center.
    
    Since:
    
    JViews 8.1
  - paintLabel
```
public void paintLabel(JComponent comp,
                       Color foreground,
                       Graphics g,
                       String label,
                       double x,
                       double y)
```
    Paints the label at the given position. The position is defined as the invariant point of the rotation, that is, the center of the object.
    
    Parameters:
    
    comp - The component rendering the label. This argument is used to get properties such as background and foreground colors if they are not specified foregreound argument or by the label renderer.
    
    foreground - The foreground color to use, or null.
    
    g - The Graphics context to draw in.
    
    label - The string to draw.
    
    x - The x-coordinate of the label center.
    
    y - The y-coordinate of the label center.
    
    Since:
    
    JViews 8.1
  - getBounds
```
public Rectangle2D getBounds(JComponent comp,
                             double x,
                             double y,
                             String label,
                             Rectangle2D bounds)
```
    Returns the label bounds, according to the given position.
    
    Parameters:
    
    comp - The component rendering the label. This argument is used to get properties such as background and foreground colors if they are not specified by the label renderer.
    
    x - The x-coordinate of the label center.
    
    y - The y-coordinate of the label center.
    
    label - The string to draw.
    
    bounds - A rectangle used to store the result.
    
    Returns:
    
    The new bounds.
    
    Since:
    
    JViews 8.1
  - getSize2D
```
public Dimension2D getSize2D(JComponent comp,
                             String label,
                             boolean useBorder,
                             boolean useRotation)
```
    Returns the size of the specified label, when displayed by this renderer.
    
    Parameters:
    
    comp - The component rendering the label. This argument is used to get properties such as background and foreground colors if they are not specified by the label renderer.
    
    label - The considered label.
    
    useBorder - Whether to take into account the border insets.
    
    useRotation - Whether to take into account the rotation.
    
    Returns:
    
    The size of the label.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setBorder(javax.swing.border.Border), setRotation(double)
  - getSize
```
public Dimension getSize(JComponent comp,
                         String label,
                         boolean useBorder,
                         boolean useRotation)
```
    Returns the size of the specified label, when displayed by this renderer.
    
    Parameters:
    
    comp - The component rendering the label. This argument is used to get properties such as background and foreground colors if they are not specified by the label renderer.
    
    label - The considered label.
    
    useBorder - Whether to take into account the border insets.
    
    useRotation - Whether to take into account the rotation.
    
    Returns:
    
    The size of the label.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getSize2D(javax.swing.JComponent, java.lang.String, boolean, boolean)
  - getBackgroundShape
```
public Shape getBackgroundShape(JComponent comp,
                                double x,
                                double y,
                                String label)
```
    Returns the combined background shapes of the text lines, according to the given position. This shape does not include the border.
    
    Parameters:
    
    comp - The component rendering the label. This argument is used to get properties such as background and foreground colors if they are not specified by the label renderer.
    
    x - The x-coordinate of the label center.
    
    y - The y-coordinate of the label center.
    
    label - The string to draw.
    
    Returns:
    
    A shape, or null if empty.
    
    Since:
    
    JViews 8.7
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener to this object.
    Note: No events for the property "background" are sent. Instead, events are sent for the property "backgroundPaint".
    
    Since:
    
    JViews 8.7
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener from this object.
    
    Since:
    
    JViews 8.7
  - firePropertyChange
```
public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue,
                               int effects)
```
    Notifies the listeners when a property change occurred.
    This method is meant to be invoked by subclasses that define additional bean properties.
    
    Parameters:
    
    propertyName - The name of the bean property whose value has changed.
    
    oldValue - The previous value of the bean property.
    
    newValue - The new value of the bean property.
    
    effects - A bit mask consisting possibly of LabelRendererPropertyEvent.AFFECTS_DRAWING and LabelRendererPropertyEvent.AFFECTS_BOUNDS.
    
    Since:
    
    JViews 8.7
  - stateChanged
```
protected void stateChanged()
```
    Called when a change occurred.

Class IlvLabelRenderer

Field Summary

Fields inherited from interface javax.swing.SwingConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvLabelRenderer

IlvLabelRenderer

Method Detail

getFont

setFont

isScalingFont

setScalingFont

getColor

setColor

getBackground

getBackgroundPaint

setBackground

setBackgroundPaint

getRotation

setRotation

isOpaque

setOpaque

isOutline

setOutline

getAlignment

setAlignment

isAutoWrapping

setAutoWrapping

getWrappingWidth

setWrappingWidth

getBorder

setBorder

isCaching

setCaching

paintLabel

paintLabel

getBounds

getSize2D

getSize

getBackgroundShape

addPropertyChangeListener

removePropertyChangeListener

firePropertyChange

stateChanged