IlvGrid (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.chart.IlvChartOwnedDrawable
- - ilog.views.chart.IlvGrid

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable
```
public class IlvGrid
extends IlvChartOwnedDrawable
implements Serializable
```
Represents a grid that can be associated with a chart axis. The default implementation of this class draws grid lines that are positioned at the major and minor steps of the scale connected to the same axis. You can control the drawing order of the grid with the setDrawOrder(int) method, which lets you specify whether the grid must be drawn above or below the chart representations.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvGrid()` Creates a new grid that displays only major grid lines, with the default color.
`IlvGrid(Paint majPaint)` Creates a new grid that displays only major grid lines, with the specified paint.
`IlvGrid(Paint majPaint, Paint minPaint)` Creates a new grid that displays major and minor grid lines, with the specified paints.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`chartConnected(IlvChart oldChart, IlvChart newChart)` This method is called with a non-`null` argument when this drawable object is being attached to a chart.
`void`	`draw(Graphics g)` Draws the grid.
`protected void`	`draw(Graphics g, IlvDoubleArray values, boolean major)` Draws the grid using the specified grid line values.
`protected void`	`drawGridLine(Graphics g, Shape shape, boolean major)` Draws the grid line.
`IlvAxis`	`getAxis()` Returns the axis to which this grid is connected.
`static int`	`getAxisIndex(IlvGrid grid)` Returns the axis index of the specified grid.
`Rectangle2D`	`getBounds(Rectangle2D retBounds)` Returns the bounds of this grid.
`IlvChart`	`getChart()` Returns the chart that displays this grid.
`IlvCoordinateSystem`	`getCoordinateSystem()` Returns the coordinate system used by this grid.
`static Color`	`getDefaultGridColor()` Returns the default grids color.
`int`	`getDrawOrder()` Returns the drawing order of this grid.
`Shape[]`	`getGridShapes(IlvDoubleArray values)` Returns the grid lines for the specified values as an array of `Shape`.
`Paint`	`getMajorPaint()` Returns the paint used to draw major grid lines.
`Stroke`	`getMajorStroke()` Returns the stroke used to draw major grid lines.
`IlvStyle`	`getMajorStyle()` Returns the style used to draw major grid lines.
`Paint`	`getMinorPaint()` Returns the paint used to draw minor grid lines.
`Stroke`	`getMinorStroke()` Returns the stroke used to draw minor grid lines.
`IlvStyle`	`getMinorStyle()` Returns the style used to draw minor grid lines.
`boolean`	`has3DSupport()` Indicates whether the grid supports three-dimensional drawing.
`boolean`	`isMajorLineVisible()` Indicates whether major grid lines are visible.
`boolean`	`isMinorLineVisible()` Indicates whether minor grid lines are visible.
`boolean`	`isVisible()` Indicates whether this grid is visible.
`static void`	`setDefaultGridColor(Color color)` Sets the default grids color to the specified color.
`void`	`setDrawOrder(int drawOrder)` Sets the drawing order of this grid.
`void`	`setMajorLineVisible(boolean visible)` Toggles the visibility of major grid lines.
`void`	`setMajorPaint(Paint paint)` Sets the paint used to draw major grid lines.
`void`	`setMajorStroke(Stroke stroke)` Sets the stroke used to draw major grid lines.
`void`	`setMinorLineVisible(boolean visible)` Toggles the visibility of minor grid lines.
`void`	`setMinorPaint(Paint paint)` Sets the paint used to draw minor grid lines.
`void`	`setMinorStroke(Stroke stroke)` Sets the stroke used to draw minor grid lines.
`void`	`setVisible(boolean visible)` Toggles the visibility of both major an minor grid lines.

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

- Constructor Detail
  - IlvGrid
```
public IlvGrid()
```
    Creates a new grid that displays only major grid lines, with the default color. The draw order is set to IlvChart.DRAW_BELOW.
    
    See Also:
    
    setDrawOrder(int)
  - IlvGrid
```
public IlvGrid(Paint majPaint)
```
    Creates a new grid that displays only major grid lines, with the specified paint. The draw order is set to IlvChart.DRAW_BELOW.
    
    See Also:
    
    setDrawOrder(int)
  - IlvGrid
```
public IlvGrid(Paint majPaint,
               Paint minPaint)
```
    Creates a new grid that displays major and minor grid lines, with the specified paints.
    
    See Also:
    
    setMajorPaint(java.awt.Paint), setMinorPaint(java.awt.Paint), setDrawOrder(int)
- Method Detail
  - getDrawOrder
```
public final int getDrawOrder()
```
    Returns the drawing order of this grid.
    
    Specified by:
    
    getDrawOrder in interface IlvChartDrawable
    
    Returns:
    
    An integer that represents the drawing order. The IlvChartDrawable objects are drawn in ascending drawing order. The drawing order also specifies whether the object is drawn above (positive values) or below (negative values) the graphical representations of the chart data.
    
    See Also:
    
    setDrawOrder(int)
  - setDrawOrder
```
public void setDrawOrder(int drawOrder)
```
    Sets the drawing order of this grid. The default drawing order is IlvChart.DRAW_BELOW.
    
    See Also:
    
    IlvChart.DRAW_ABOVE, IlvChart.DRAW_BELOW, getDrawOrder()
  - isVisible
```
public boolean isVisible()
```
    Indicates whether this grid is visible. A grid is considered visible when either major or minor grid lines are visible.
    
    Specified by:
    
    isVisible in interface IlvChartDrawable
  - setVisible
```
public final void setVisible(boolean visible)
```
    Toggles the visibility of both major an minor grid lines.
  - isMajorLineVisible
```
public final boolean isMajorLineVisible()
```
    Indicates whether major grid lines are visible.
  - setMajorLineVisible
```
public void setMajorLineVisible(boolean visible)
```
    Toggles the visibility of major grid lines.
  - isMinorLineVisible
```
public final boolean isMinorLineVisible()
```
    Indicates whether minor grid lines are visible.
  - setMinorLineVisible
```
public void setMinorLineVisible(boolean visible)
```
    Toggles the visibility of minor grid lines.
  - getMajorStyle
```
public final IlvStyle getMajorStyle()
```
    Returns the style used to draw major grid lines.
    
    Since:
    
    JViews 5.5
  - getMajorStroke
```
public final Stroke getMajorStroke()
```
    Returns the stroke used to draw major grid lines.
    
    See Also:
    
    setMajorStroke(java.awt.Stroke)
  - setMajorStroke
```
public void setMajorStroke(Stroke stroke)
```
    Sets the stroke used to draw major grid lines.
    
    See Also:
    
    getMajorStroke()
  - getMajorPaint
```
public final Paint getMajorPaint()
```
    Returns the paint used to draw major grid lines.
    
    See Also:
    
    setMajorPaint(java.awt.Paint)
  - setMajorPaint
```
public void setMajorPaint(Paint paint)
```
    Sets the paint used to draw major grid lines.
    
    See Also:
    
    getMajorPaint()
  - getMinorStyle
```
public final IlvStyle getMinorStyle()
```
    Returns the style used to draw minor grid lines.
    
    Since:
    
    JViews 5.5
  - getMinorStroke
```
public final Stroke getMinorStroke()
```
    Returns the stroke used to draw minor grid lines.
    
    See Also:
    
    setMinorStroke(java.awt.Stroke)
  - setMinorStroke
```
public void setMinorStroke(Stroke stroke)
```
    Sets the stroke used to draw minor grid lines.
    
    See Also:
    
    getMinorStroke()
  - getMinorPaint
```
public final Paint getMinorPaint()
```
    Returns the paint used to draw minor grid lines.
    
    See Also:
    
    setMinorPaint(java.awt.Paint)
  - setMinorPaint
```
public void setMinorPaint(Paint paint)
```
    Sets the paint used to draw minor grid lines.
    
    See Also:
    
    getMinorPaint()
  - getChart
```
public final IlvChart getChart()
```
    Returns the chart that displays this grid. This method returns null until the grid is connected to a chart with the IlvChart.setXGrid(ilog.views.chart.IlvGrid) or IlvChart.setYGrid(int, ilog.views.chart.IlvGrid) method.
    
    Specified by:
    
    getChart in class IlvChartOwnedDrawable
  - chartConnected
```
protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)
```
    This method is called with a non-null argument when this drawable object is being attached to a chart. It is called with a null chart argument when this drawable object is being detached from its chart.
    You should not call this method directly.
    
    Specified by:
    
    chartConnected in class IlvChartOwnedDrawable
    
    Parameters:
    
    oldChart - The previous owning chart. May be null if this drawable object was not attached to a chart before.
    
    newChart - The new associated chart. May be null if if this drawable object is being detached from its chart.
    
    See Also:
    
    IlvChartOwnedDrawable.getChart()
  - getAxis
```
public final IlvAxis getAxis()
```
    Returns the axis to which this grid is connected. This method returns null until the grid is connected to a chart with the IlvChart.setXGrid(ilog.views.chart.IlvGrid) or IlvChart.setYGrid(int, ilog.views.chart.IlvGrid) method.
  - getCoordinateSystem
```
public final IlvCoordinateSystem getCoordinateSystem()
```
    Returns the coordinate system used by this grid. If the grid is connected to an x-axis, this method returns the main coordinate system of the chart. Otherwise, it returns the coordinate system corresponding to the y-axis.
    
    See Also:
    
    getAxis()
  - has3DSupport
```
public boolean has3DSupport()
```
    Indicates whether the grid supports three-dimensional drawing.
    
    Specified by:
    
    has3DSupport in interface IlvChart3DSupport
    
    Specified by:
    
    has3DSupport in interface IlvChartDrawable
    
    Returns:
    
    true if the grid is drawn by a Cartesian chart, and false otherwise.
    
    Since:
    
    JViews 5.5
  - draw
```
public void draw(Graphics g)
```
    Draws the grid. The default implementation calls the draw(Graphics, IlvDoubleArray, boolean) method with the step values of the scale connected to the same axis. If no scale exists, this method does not perform any drawing.
    
    Specified by:
    
    draw in interface IlvChartDrawable
  - draw
```
protected void draw(Graphics g,
                    IlvDoubleArray values,
                    boolean major)
```
    Draws the grid using the specified grid line values.
    
    Parameters:
    
    g - The destination graphics.
    
    values - The grid lines values.
    
    major - A boolean value indicating whether the values are associated with major or minor grid lines.
  - getBounds
```
public Rectangle2D getBounds(Rectangle2D retBounds)
```
    Returns the bounds of this grid. The default implementation returns the plotting rectangle of the chart displaying the grid, or an empty rectangle if the grid is not associated with any chart.
    
    Specified by:
    
    getBounds in interface IlvChartDrawable
    
    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 grid.
  - getGridShapes
```
public final Shape[] getGridShapes(IlvDoubleArray values)
```
    Returns the grid lines for the specified values as an array of Shape.
    
    Since:
    
    JViews 6.0
  - drawGridLine
```
protected void drawGridLine(Graphics g,
                            Shape shape,
                            boolean major)
```
    Draws the grid line.
    
    Parameters:
    
    g - The destination graphics.
    
    shape - The Shape representing the line.
    
    major - true if the current line is a major grid line.
    
    Since:
    
    JViews 6.0
  - setDefaultGridColor
```
public static void setDefaultGridColor(Color color)
```
    Sets the default grids color to the specified color.
  - getDefaultGridColor
```
public static Color getDefaultGridColor()
```
    Returns the default grids color.
  - getAxisIndex
```
public static int getAxisIndex(IlvGrid grid)
```
    Returns the axis index of the specified grid.
    
    Throws:
    
    IllegalArgumentException - The grid is not connected to a chart.
    
    Since:
    
    JViews 6.0

Class IlvGrid

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvGrid

IlvGrid

IlvGrid

Method Detail

getDrawOrder

setDrawOrder

isVisible

setVisible

isMajorLineVisible

setMajorLineVisible

isMinorLineVisible

setMinorLineVisible

getMajorStyle

getMajorStroke

setMajorStroke

getMajorPaint

setMajorPaint

getMinorStyle

getMinorStroke

setMinorStroke

getMinorPaint

setMinorPaint

getChart

chartConnected

getAxis

getCoordinateSystem

has3DSupport

draw

draw

getBounds

getGridShapes

drawGridLine

setDefaultGridColor

getDefaultGridColor

getAxisIndex