IlvDataIndicator (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvChartOwnedDrawable
- - ilog.views.chart.IlvChartDecoration
  - - ilog.views.chart.graphic.IlvDataIndicator

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable

Direct Known Subclasses:

IlvThresholdIndicator
```
public class IlvDataIndicator
extends IlvChartDecoration
```
Represents a graphical indicator of data values.
An IlvDataIndicator can be used to represent different types of data values, each one with its own graphical representation. Here is the possible type of values that can be marked :
- A value along the x-axis.
- A value along the y-axis.
- A data range along the x-axis.
- A data range along the y-axis.
- A data window.
And here are two pictures showing the graphical representations associated with the different types of data values, for a Cartesian chart and a radar chart:
Since:

JViews 5.0

See Also:

IlvChart.addDecoration(ilog.views.chart.IlvChartDecoration), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`WINDOW` Type constant: specifies that the indicator is used to mark a data window.
`static int`	`X_RANGE` Type constant: specifies that the indicator is used to mark a data range along an x-axis.
`static int`	`X_VALUE` Type constant: specifies that the indicator is used to mark a value along an x-axis.
`static int`	`Y_RANGE` Type constant: specifies that the indicator is used to mark a data range along a y-axis.
`static int`	`Y_VALUE` Type constant: specifies that the indicator is used to mark a value along a y-axis.

Constructor Summary

Constructors
Constructor and Description
`IlvDataIndicator(int axisIndex, double value, String text)` Creates an indicator for the specified value with the specified text.
`IlvDataIndicator(int axisIndex, IlvDataInterval range, String text)` Creates an indicator for the specified range with the specified text.
`IlvDataIndicator(int yAxisIndex, IlvDataWindow dataWindow, String text)` Creates an indicator for the specified data window with the specified text.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterDraw(Graphics g)` Draws the border of the indicator into the specified `Graphics` context.
`protected void`	`baseTextDirectionChanged()` This method is invoked when the effective base text direction of the chart has changed.
`void`	`beforeDraw(Graphics g)` Draws the background of the indicator into the specified `Graphics` context.
`protected void`	`chartConnected(IlvChart oldChart, IlvChart newChart)` Called when the indicator is added to or removed from a chart.
`protected void`	`componentOrientationChanged(ComponentOrientation oldOrientation, ComponentOrientation newOrientation)` This method is invoked when the component orientation of the chart has changed.
`protected IlvDoublePoint`	`computeLabelLocation(IlvDataWindow dataWindow)` Returns the location of the label.
`boolean`	`contains(int x, int y)` Indicates whether the graphical representation of the indicator contains the specified point.
`void`	`draw(Graphics g)` Draws the indicator into the specified `Graphics` context.
`int`	`getAxisIndex()` Returns the index of the axis to which this indicator is attached.
`Rectangle2D`	`getBounds(Rectangle2D retBounds)` Returns the bounds of this decoration.
`IlvDataWindow`	`getDataWindow()` Returns the data window displayed by the indicator.
`IlvStyle`	`getDrawStyle()` Returns the rendering style actually used for this indicator.
`IlvLabelRenderer`	`getLabelRenderer()` Returns the renderer of the text displayed by this indicator.
`IlvDataInterval`	`getRange()` Returns the range displayed by this indicator.
`Shape`	`getShape()` Returns the `Shape` corresponding to this data indicator.
`IlvStyle`	`getStyle()` Returns the rendering style of this indicator.
`String`	`getText()` Returns the text associated with this indicator.
`int`	`getType()` Returns the type of this indicator.
`double`	`getValue()` Sets the value displayed by the indicator.
`boolean`	`has3DSupport()` Indicates whether the indicator supports three-dimensional drawing.
`void`	`setDataWindow(double xMin, double xMax, double yMin, double yMax)` Modifies the data window displayed by this indicator.
`void`	`setDataWindow(IlvDataWindow w)` Modifies the data window displayed by this indicator.
`void`	`setLabelRenderer(IlvLabelRenderer renderer)` Sets the renderer of the text displayed by this indicator.
`void`	`setRange(IlvDataInterval range)` Sets the range displayed by this indicator.
`void`	`setStyle(IlvStyle style)` Specifies the rendering style of this indicator.
`void`	`setText(String text)` Sets the text associated with this indicator.
`void`	`setValue(double value)` Sets the value displayed by the indicator.
`void`	`setVisible(boolean visible)` Toggles the visibility of this decoration.
`protected void`	`updateBoundsCache()` Updates the bounds cache of this decoration.

Methods inherited from class ilog.views.chart.IlvChartDecoration
getChart, getDrawOrder, isVisible, repaint, setDrawOrder

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

- Field Detail
  - X_VALUE
```
public static final int X_VALUE
```
    Type constant: specifies that the indicator is used to mark a value along an x-axis.
    
    See Also:
    
    getType(), Constant Field Values
  - Y_VALUE
```
public static final int Y_VALUE
```
    Type constant: specifies that the indicator is used to mark a value along a y-axis.
    
    See Also:
    
    getType(), Constant Field Values
  - X_RANGE
```
public static final int X_RANGE
```
    Type constant: specifies that the indicator is used to mark a data range along an x-axis.
    
    See Also:
    
    getType(), Constant Field Values
  - Y_RANGE
```
public static final int Y_RANGE
```
    Type constant: specifies that the indicator is used to mark a data range along a y-axis.
    
    See Also:
    
    getType(), Constant Field Values
  - WINDOW
```
public static final int WINDOW
```
    Type constant: specifies that the indicator is used to mark a data window.
    
    See Also:
    
    getType(), Constant Field Values
- Constructor Detail
  - IlvDataIndicator
```
public IlvDataIndicator(int axisIndex,
                        double value,
                        String text)
```
    Creates an indicator for the specified value with the specified text.
    
    Parameters:
    
    axisIndex - The index of the considered axis: -1 for the x-axis, or the index of a given y-axis. The type of this indicator is set to X_VALUE or Y_VALUE accordingly.
    
    value - The considered value.
    
    text - The text to display. May be null if no text is drawn.
    
    See Also:
    
    getType()
  - IlvDataIndicator
```
public IlvDataIndicator(int axisIndex,
                        IlvDataInterval range,
                        String text)
```
    Creates an indicator for the specified range with the specified text.
    
    Parameters:
    
    axisIndex - The index of the considered axis: -1 for the x-axis, or the index of a given y-axis. The type of this indicator is set to X_RANGE or Y_RANGE accordingly.
    
    range - The considered range.
    
    text - The text to display. May be null if no text is drawn.
    
    See Also:
    
    getType()
  - IlvDataIndicator
```
public IlvDataIndicator(int yAxisIndex,
                        IlvDataWindow dataWindow,
                        String text)
```
    Creates an indicator for the specified data window with the specified text. The type of this indicator is set to WINDOW.
    
    Parameters:
    
    yAxisIndex - The index of the considered y-axis.
    
    dataWindow - The considered data window.
    
    text - The text to display. May be null if no text is drawn.
    
    See Also:
    
    getType()
- Method Detail
  - chartConnected
```
protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)
```
    Called when the indicator is added to or removed from a chart.
    
    Overrides:
    
    chartConnected in class IlvChartDecoration
    
    Parameters:
    
    oldChart - The chart with which the decoration was associated, or null if the decoration is added to a new chart.
    
    newChart - The chart to which the decoration is added, or null if the decoration is removed from its current chart.
    
    Throws:
    
    IndexOutOfBoundsException - If the index of the y-axis is not valid.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    IlvChartOwnedDrawable.getChart()
  - has3DSupport
```
public boolean has3DSupport()
```
    Indicates whether the indicator supports three-dimensional drawing.
    
    Specified by:
    
    has3DSupport in interface IlvChart3DSupport
    
    Specified by:
    
    has3DSupport in interface IlvChartDrawable
    
    Overrides:
    
    has3DSupport in class IlvChartDecoration
    
    Returns:
    
    true if the indicator is drawn by a Cartesian chart, and false otherwise.
    
    Since:
    
    JViews 5.5
  - getAxisIndex
```
public final int getAxisIndex()
```
    Returns the index of the axis to which this indicator is attached.
    
    Returns:
    
    -1 if the type of the indicator is X_VALUE or X_RANGE, or the index of the associated y-axis otherwise.
  - getType
```
public final int getType()
```
    Returns the type of this indicator.
    
    See Also:
    
    X_VALUE, Y_VALUE, X_RANGE, Y_RANGE, WINDOW
  - getValue
```
public final double getValue()
```
    Sets the value displayed by the indicator. The returned value is only relevant if the type of the indicator is X_VALUE or Y_VALUE.
  - setValue
```
public void setValue(double value)
```
    Sets the value displayed by the indicator. This method can only be used if the type of the indicator is X_VALUE or Y_VALUE.
    
    Throws:
    
    UnsupportedOperationException - The type of the indicator is different from X_VALUE or Y_VALUE.
  - getRange
```
public final IlvDataInterval getRange()
```
    Returns the range displayed by this indicator.
    
    Returns:
    
    The range displayed by this indicator, or null if the type of the indicator is different from X_RANGE or Y_RANGE.
    
    See Also:
    
    setRange(ilog.views.chart.IlvDataInterval)
  - setRange
```
public void setRange(IlvDataInterval range)
```
    Sets the range displayed by this indicator. This method can only be used if the type of the indicator is X_RANGE or Y_RANGE.
    
    Throws:
    
    UnsupportedOperationException - The type of the indicator is different from X_RANGE or Y_RANGE.
  - getDataWindow
```
public final IlvDataWindow getDataWindow()
```
    Returns the data window displayed by the indicator. The returned window is only relevant if the type of the indicator is X_RANGE, Y_RANGE, or WINDOW.
  - setDataWindow
```
public void setDataWindow(IlvDataWindow w)
```
    Modifies the data window displayed by this indicator. This method can only be used if the type of the indicator is WINDOW.
    
    Throws:
    
    UnsupportedOperationException - The type of the indicator is not WINDOW.
  - setDataWindow
```
public void setDataWindow(double xMin,
                          double xMax,
                          double yMin,
                          double yMax)
```
    Modifies the data window displayed by this indicator. This method can only be used if the type of the indicator is WINDOW.
    
    Throws:
    
    UnsupportedOperationException - The type of the indicator is not WINDOW.
    
    Since:
    
    JViews 5.5
  - getText
```
public String getText()
```
    Returns the text associated with this indicator. May return null if no text is drawn.
  - setText
```
public void setText(String text)
```
    Sets the text associated with this indicator. Depending on the indicator type, the text is rendered using the fill color of the drawing style for the X_VALUE or Y_VALUE types, or with the stroke color of the drawing style in the other cases.
    
    Parameters:
    
    text - The text to draw. May be null.
    
    See Also:
    
    getType(), setStyle(ilog.views.chart.IlvStyle)
  - getLabelRenderer
```
public final IlvLabelRenderer getLabelRenderer()
```
    Returns the renderer of the text displayed by this indicator.
  - setLabelRenderer
```
public void setLabelRenderer(IlvLabelRenderer renderer)
```
    Sets the renderer of the text displayed by this indicator.
    
    Since:
    
    JViews 6.0
  - getStyle
```
public final IlvStyle getStyle()
```
    Returns the rendering style of this indicator.
  - setStyle
```
public void setStyle(IlvStyle style)
```
    Specifies the rendering style of this indicator.
  - getDrawStyle
```
public IlvStyle getDrawStyle()
```
    Returns the rendering style actually used for this indicator. The default implementation of this method uses getStyle() when it has a non-null value, and a style that depends on the chart otherwise.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    getStyle()
  - beforeDraw
```
public void beforeDraw(Graphics g)
```
    Draws the background of the indicator into the specified Graphics context.
    
    Overrides:
    
    beforeDraw in class IlvChartDecoration
    
    Since:
    
    JViews 8.1
  - draw
```
public void draw(Graphics g)
```
    Draws the indicator into the specified Graphics context.
    Note: This method draws nothing. The actual drawing is produced by the beforeDraw(java.awt.Graphics) and afterDraw(java.awt.Graphics) methods.
    
    Specified by:
    
    draw in interface IlvChartDrawable
    
    Specified by:
    
    draw in class IlvChartDecoration
  - afterDraw
```
public void afterDraw(Graphics g)
```
    Draws the border of the indicator into the specified Graphics context.
    
    Overrides:
    
    afterDraw in class IlvChartDecoration
    
    Since:
    
    JViews 8.1
  - computeLabelLocation
```
protected IlvDoublePoint computeLabelLocation(IlvDataWindow dataWindow)
```
    Returns the location of the label. The default implementation centers the label both vertically and/or horizontally, depending on the data indicator type.
    
    Parameters:
    
    dataWindow - The data window covered by this indicator. This parameter is the visible window for X_VALUE and Y_VALUE data indicators.
    
    Returns:
    
    The location of the label in the screen coordinates. The returned point is the center of the label.
  - getBounds
```
public Rectangle2D getBounds(Rectangle2D retBounds)
```
    Returns the bounds of this decoration.
    
    Specified by:
    
    getBounds in interface IlvChartDrawable
    
    Overrides:
    
    getBounds in class IlvChartDecoration
    
    Parameters:
    
    retBounds - A rectangle optionally used to store the result. If this parameter is null, a new Rectangle2D is allocated.
    
    Returns:
    
    The bounds of this decoration.
  - getShape
```
public Shape getShape()
```
    Returns the Shape corresponding to this data indicator.
    
    Since:
    
    JViews 6.0
  - contains
```
public boolean contains(int x,
                        int y)
```
    Indicates whether the graphical representation of the indicator contains the specified point.
    
    Parameters:
    
    x - The x-coordinate of the considered point, expressed in the projected space.
    
    y - The y-coordinate of the considered point, expressed in projected space.
    
    Returns:
    
    true if the point lies within the graphical representation of the indicator, false otherwise.
  - updateBoundsCache
```
protected void updateBoundsCache()
```
    Updates the bounds cache of this decoration. This needs to be called whenever the bounds of this decoration change while getChart() && isVisible() is true, or when getChart() && isVisible() becomes true.
    
    Overrides:
    
    updateBoundsCache in class IlvChartDecoration
  - componentOrientationChanged
```
protected void componentOrientationChanged(ComponentOrientation oldOrientation,
                                           ComponentOrientation newOrientation)
```
    This method is invoked when the component orientation of the chart has changed.
    
    Overrides:
    
    componentOrientationChanged in class IlvChartDecoration
    
    Parameters:
    
    oldOrientation - The component orientation before the change.
    
    newOrientation - The component orientation after the change.
    
    See Also:
    
    Component.getComponentOrientation()
  - baseTextDirectionChanged
```
protected void baseTextDirectionChanged()
```
    This method is invoked when the effective base text direction of the chart has changed. That is, it is invoked
    1. when the value of chart.getResolvedBaseTextDirection() has changed, or
    2. when the value of chart.getComponentOrientation() has changed and the value of chart.getResolvedBaseTextDirection() is IlvBidiUtil.CONTEXTUAL_DIRECTION.
    Overrides:
    
    baseTextDirectionChanged in class IlvChartDecoration
    
    See Also:
    
    IlvChart.getResolvedBaseTextDirection(), Component.getComponentOrientation()
  - setVisible
```
public void setVisible(boolean visible)
```
    Toggles the visibility of this decoration.
    
    Overrides:
    
    setVisible in class IlvChartDecoration
    
    See Also:
    
    IlvChartDecoration.isVisible()

Class IlvDataIndicator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ilog.views.chart.IlvChartDecoration

Methods inherited from class java.lang.Object

Field Detail

X_VALUE

Y_VALUE

X_RANGE

Y_RANGE

WINDOW

Constructor Detail

IlvDataIndicator

IlvDataIndicator

IlvDataIndicator

Method Detail

chartConnected

has3DSupport

getAxisIndex

getType

getValue

setValue

getRange

setRange

getDataWindow

setDataWindow

setDataWindow

getText

setText

getLabelRenderer

setLabelRenderer

getStyle

setStyle

getDrawStyle

beforeDraw

draw

afterDraw

computeLabelLocation

getBounds

getShape

contains

updateBoundsCache

componentOrientationChanged

baseTextDirectionChanged

setVisible