ilog.views.chart.renderer

Class IlvCompositeChartRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvCompositeChartRenderer

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvBubbleChartRenderer, IlvComboChartRenderer, IlvHiLoChartRenderer, IlvSimpleCompositeChartRenderer

public abstract class IlvCompositeChartRenderer
extends IlvChartRenderer

A chart renderer, implemented as a list of child renderers.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.IlvChartRenderer

AREA, BAR, BUBBLE, CANDLE, CENTERED_LABEL_LAYOUT, COMBO, DATA_LABEL, DEFAULT_LABEL_LAYOUT, DEFAULT_LABELING, HILO, HILO_ARROW, HILO_STICK, HLOC, OUTSIDE_LABEL_LAYOUT, PERCENT_LABEL, PIE, POLYLINE, SCATTER, STACKED_AREA, STACKED_BAR, STACKED_DIVERGING_BAR, STACKED_POLYLINE, STACKED_STAIR, STACKED100_AREA, STACKED100_BAR, STACKED100_POLYLINE, STACKED100_STAIR, STAIR, SUMMED_STAIR, SUPERIMPOSED_BAR, TREEMAP, X_VALUE_LABEL, XY_VALUES_LABEL, Y_VALUE_LABEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvCompositeChartRenderer() Creates a new IlvCompositeChartRenderer.

Method Summary

Modifier and Type	Method and Description
void	addImageMapAreas(IlvIMapDefinition mapDef, List<? super IlvIMapArea> areaList) Generates image map areas.
void	collectDisplayItems(IlvChartDataPicker picker, ArrayList<IlvDisplayPoint> accumulator) Collects the display items containing the specified picking point.
protected abstract IlvChartRenderer	createChild(IlvDataSet dataSet) Creates a new child renderer to display the specified data set.
IlvLegendItem[]	createLegendItems() Creates the legend item instances associated to this renderer.
void	draw(Graphics dst) Draws the renderer using the specified Graphics.
void	draw(Graphics dst, IlvDataSet dataSet, int iMin, int iMax) Deprecated. This method is not used by JViews.
void	drawAnnotations(Graphics dst) Draws the annotations of the renderer using the specified Graphics.
void	drawIntoHitmap(IlvChartHitmapDefinition definition, IlvChartHitmapAccumulator accumulator) Draws the rendering into a hitmap.
void	drawLegendSymbol(IlvLegendItem item, Graphics g, int x, int y, int w, int h) Draws the symbol of the given legend item.
void	drawSelectionHandles(Graphics g, IlvHandlesSelectionStyle style) Draws this renderer with selection handles.
IlvDataAnnotation	getAnnotation(IlvDataSet dataSet, int idx) Returns the annotation of the specified data point.
Rectangle2D	getBounds(IlvDataSet dataSet, int iMin, int iMax, Rectangle2D bounds, boolean includeAnnotations) Returns the bounds of the graphical representation for the specified data.
Rectangle2D	getBounds(Rectangle2D bounds, boolean includeAnnotations) Returns the bounds of the graphical representation for the visible data.
IlvChartRenderer	getChild(IlvDataSet dataSet) Returns the child renderer that is used to display the specified data set.
IlvChartRenderer	getChild(int idx) Returns the child renderer at the specified index.
IlvChartRenderer	getChild(String dataSetName) Returns the child renderer that is used to display the data set with the specified name.
int	getChildCount() Returns the number of child renderers.
Iterator<IlvChartRenderer>	getChildIterator() Returns an iterator over the children of this renderer.
List<IlvChartRenderer>	getChildren() Returns the children of this renderer.
IlvDisplayPoint	getDisplayItem(IlvChartDataPicker picker) Returns the display item containing the specified picking point.
IlvDisplayPoint	getDisplayPoint(IlvDataSet dataSet, int dataIdx) Returns the display point corresponding to the specified data point.
String	getLegendText(IlvLegendItem item) Returns the label of the specified legend item.
IlvDisplayPoint	getNearestItem(IlvChartDataPicker picker, double[] distanceResult) Returns the display item closest to the picking point defined by the specified data picker.
IlvDisplayPoint	getNearestPoint(IlvChartDataPicker picker) Returns the display point closest to the picking point defined by the specified data picker.
IlvDataRenderingHint	getRenderingHint(IlvDataSet dataSet) Returns the rendering hint that was specified globally for all the points of the given data set.
IlvDataRenderingHint	getRenderingHint(IlvDataSet dataSet, int idx) Returns the rendering hint of the specified data point.
IlvStyle	getStyle(IlvDataSet dataSet, int index) Returns the style used to display the specified data point.
IlvStyle[]	getStyles() Returns all the styles used by the child renderers.
IlvDataInterval	getXRange(IlvDataInterval retRange) Returns the range of the x-values displayed by this renderer.
IlvDataInterval	getYRange(IlvDataInterval retRange) Returns the range of the y-values displayed by this renderer.
IlvDataInterval	getYRange(IlvDataInterval xRange, IlvDataInterval retRange) Returns the range of the y-values displayed by this renderer within the specified X interval.
boolean	holdsAnnotations() Returns true if some annotations are defined for some data sets, data points, or data objects, in this renderer.
boolean	isViewable() Indicates whether this renderer can be displayed.
void	setAnnotation(IlvDataSet dataSet, IlvDataAnnotation annotation) Specifies an annotation for all the data points of a data set.
void	setAnnotation(IlvDataSet dataSet, int idx, IlvDataAnnotation annotation) Specifies an annotation for a data point.
void	setDataPoint(IlvDataSet dataSet, int dataIndex, double xData, double yData) Changes the value of a data point.
void	setDisplayPoint(IlvDataSet dataSet, int dataIndex, double xCoord, double yCoord) Changes the value of a data point according to the specified projected coordinates.
void	setRenderingHint(IlvDataSet dataSet, IlvDataRenderingHint hint) Specifies a rendering hint for all the data points of a data set.
void	setRenderingHint(IlvDataSet dataSet, int idx, IlvDataRenderingHint hint) Specifies a rendering hint for a data point.
void	setStyles(IlvStyle[] styles) Sets the styles used by the child renderers.
protected void	updateChildren() Called when children have been added or removed from this renderer.

Methods inherited from class ilog.views.chart.IlvChartRenderer

applyStyles, applyStyles, applyStyles, chartConnected, computeDataLabel, computeDataLabelLocation, create, createRenderer, dataSetsAdded, dataSetsChangesBatchEnding, dataSetsChangesBatchStarting, dataSetsRemoved, dispose, drawSelectionHandles, drawSelectionHandles, drawSelectionHandles, endRendererChanges, findAppropriateColor, fireTreemapFocusEvent, getAnnotation, getBounds, getChart, getClipRect, getCoordinateSystem, getDataLabeling, getDataLabelLayout, getDataLabelling, getDataSetIndex, getDataSetMainIndex, getDataSetMainRenderer, getDataSource, getDefaultColors, getDefaultLegendTitle, getDepths, getDisplayItem, getDisplayItems, getLegendStyle, getMinDataSetCount, getName, getNearestItem, getNearestPoint, getParent, getPlotRect, getPreferredMargins, getRenderingHint, getStyle, getVirtualDataSet, getXShift, getYAxisIdx, has3DSupport, isDisplayingDataSet, isVisible, isVisibleInLegend, register, set3D, setAnnotation, setDataLabeling, setDataLabelLayout, setDataLabelling, setDataSource, setName, setParent, setRenderingHint, setStyle, setVisible, setVisibleInLegend, setXShift, setYAxisIdx, startRendererChanges, toData, toDisplay, toDisplay, triggerChange

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvCompositeChartRenderer

protected IlvCompositeChartRenderer()

Creates a new IlvCompositeChartRenderer.

Method Detail

isViewable

public boolean isViewable()

Indicates whether this renderer can be displayed. The method returns true if the visible property is set to true and if at least one of the child renderer can be viewed.

Specified by:

isViewable in interface IlvChartAreaAccessible

Overrides:

isViewable in class IlvChartRenderer

See Also:

IlvChartRenderer.isVisible()

setStyles

public void setStyles(IlvStyle[] styles)

Sets the styles used by the child renderers. Each child renderer is associated with a style from the specified array.

Specified by:

setStyles in class IlvChartRenderer

getStyles

public IlvStyle[] getStyles()

Returns all the styles used by the child renderers.

Specified by:

getStyles in class IlvChartRenderer

getStyle

public IlvStyle getStyle(IlvDataSet dataSet,
                         int index)

Returns the style used to display the specified data point.

Specified by:

getStyle in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

index - The index of the considered data point.

Returns:

The style used to display the point, or null if this data point is not displayed by the renderer.

Since:

JViews 5.5

getChildCount

public int getChildCount()

Returns the number of child renderers.

Overrides:

getChildCount in class IlvChartRenderer

getChild

public IlvChartRenderer getChild(int idx)

Returns the child renderer at the specified index.

Overrides:

getChild in class IlvChartRenderer

getChildren

public List<IlvChartRenderer> getChildren()

Returns the children of this renderer.

Overrides:

getChildren in class IlvChartRenderer

Returns:

a list of IlvChartRenderer

getChildIterator

public Iterator<IlvChartRenderer> getChildIterator()

Returns an iterator over the children of this renderer. The type of the elements traversed by this iterator is IlvChartRenderer. The returned iterator does not allow the element removal (an UnsupportedOperationException is thrown when calling the remove method).

Overrides:

getChildIterator in class IlvChartRenderer

Returns:

an iterator over IlvChartRenderer elements

getChild

public IlvChartRenderer getChild(IlvDataSet dataSet)

Returns the child renderer that is used to display the specified data set. The default implementation returns the first child renderer that displays the specified data set.

getChild

public final IlvChartRenderer getChild(String dataSetName)

Returns the child renderer that is used to display the data set with the specified name. The default implementation returns the first child renderer that displays the corresponding data set.

Since:

JViews 5.5

See Also:

getChild(IlvDataSet)

createChild

protected abstract IlvChartRenderer createChild(IlvDataSet dataSet)

Creates a new child renderer to display the specified data set. This method is called whenever a new data set is connected to this renderer.

Returns:

A freshly created renderer that is connected to an empty data source. It will be connected to dataSet by the caller.

updateChildren

protected void updateChildren()

Called when children have been added or removed from this renderer. This method lets you carry out a specific operation on the children whenever their number changes.

setDisplayPoint

public void setDisplayPoint(IlvDataSet dataSet,
                            int dataIndex,
                            double xCoord,
                            double yCoord)

Changes the value of a data point according to the specified projected coordinates.

Specified by:

setDisplayPoint in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

dataIndex - The index of the considered data point within the data set.

xCoord - The new x-coordinate of the projected point, as displayed by this renderer.

yCoord - The new y-coordinate of the projected point, as displayed by this renderer.

See Also:

IlvDisplayPoint.setCoords(int, int)

setDataPoint

public void setDataPoint(IlvDataSet dataSet,
                         int dataIndex,
                         double xData,
                         double yData)

Changes the value of a data point.

Overrides:

setDataPoint in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

dataIndex - The index of the considered data point within the data set.

xData - The new x-value.

yData - The new y-value.

draw

public void draw(Graphics dst)

Draws the renderer using the specified Graphics. The method delegates the drawing operation to each child renderer.

Specified by:

draw in class IlvChartRenderer

Parameters:

dst - The destination Graphics. May be null if the renderer is drawn in a 3D scene.

drawAnnotations

public void drawAnnotations(Graphics dst)

Draws the annotations of the renderer using the specified Graphics. The method delegates the drawing operation to each child renderer.

Specified by:

drawAnnotations in class IlvChartRenderer

draw

@Deprecated
public void draw(Graphics dst,
                             IlvDataSet dataSet,
                             int iMin,
                             int iMax)

Deprecated. This method is not used by JViews.

Draws the contents using the specified graphics and the specified data points. The method delegates the drawing operation to each child renderer.

Specified by:

draw in class IlvChartRenderer

Deprecated Since:

JViews 8.1

getBounds

public Rectangle2D getBounds(Rectangle2D bounds,
                             boolean includeAnnotations)

Returns the bounds of the graphical representation for the visible data. If nothing is rendered by this renderer, an empty rectangle is returned. This method stores the result into bounds and returns bounds. If bounds is null, a new Rectangle2D is allocated.

Note that the bounds may be larger than necessary. There is no guarantee that the bounds returned are tight.

Note about multi-threading: This method must not take the Swing tree lock, and must not access IlvChart API that is not multithread-safe.

Specified by:

getBounds in class IlvChartRenderer

Parameters:

bounds - An optional rectangle used to store the result.

includeAnnotations - Indicates whether annotation bounds should be included.

Since:

JViews 8.7

getBounds

public Rectangle2D getBounds(IlvDataSet dataSet,
                             int iMin,
                             int iMax,
                             Rectangle2D bounds,
                             boolean includeAnnotations)

Returns the bounds of the graphical representation for the specified data. If dataSet is not rendered by this renderer, an empty rectangle is returned. This method stores the result into bounds and returns bounds. If bounds is null, a new Rectangle2D is allocated.

Note that the bounds may be larger than necessary. There is no guarantee that the bounds returned are tight.

Note about multi-threading: This method must not take the Swing tree lock, and must not access IlvChart API that is not multithread-safe.

Specified by:

getBounds in class IlvChartRenderer

Parameters:

dataSet - The data set containing the data points.

iMin - The minimum data point index.

iMax - The maximum data point index.

bounds - An optional rectangle used to store the result.

includeAnnotations - Indicates whether annotation bounds should be included.

drawSelectionHandles

public void drawSelectionHandles(Graphics g,
                                 IlvHandlesSelectionStyle style)

Draws this renderer with selection handles.

Specified by:

drawSelectionHandles in interface IlvChartAreaAccessible

Specified by:

drawSelectionHandles in class IlvChartRenderer

Parameters:

g - A graphics context.

style - The graphic style parameters.

Since:

JViews 8.8

getNearestPoint

public IlvDisplayPoint getNearestPoint(IlvChartDataPicker picker)

Returns the display point closest to the picking point defined by the specified data picker. This method considers only the projected points, not the geometry of the renderer drawing.

Specified by:

getNearestPoint in class IlvChartRenderer

Parameters:

picker - The object holding the picking information.

Returns:

The nearest display point, or null if none is found.

See Also:

IlvChartRenderer.getNearestItem(IlvChartDataPicker, double[])

getNearestItem

public IlvDisplayPoint getNearestItem(IlvChartDataPicker picker,
                                      double[] distanceResult)

Returns the display item closest to the picking point defined by the specified data picker. Unlike the getNearestPoint(ilog.views.chart.IlvChartDataPicker) method, this method considers the geometry of the renderer drawing to compute the result. It also optionally returns the distance to the renderer drawing.

Specified by:

getNearestItem in class IlvChartRenderer

Parameters:

picker - The object holding the picking information.

distanceResult - If not null, this will be used to return the distance to the rendering of the item. You can pass null if you don't need this information.

Returns:

The nearest display point, or null if none was found.

Since:

JViews 8.5

See Also:

IlvChartRenderer.getNearestPoint(IlvChartDataPicker), IlvChartRenderer.getDisplayItem(IlvChartDataPicker)

getDisplayItem

public IlvDisplayPoint getDisplayItem(IlvChartDataPicker picker)

Returns the display item containing the specified picking point. Unlike the getNearestPoint(ilog.views.chart.IlvChartDataPicker) method, this method takes into account the geometry of the renderer drawing to compute the result. Unlike the getNearestItem(ilog.views.chart.IlvChartDataPicker, double[]) method, this method does not consider the picker's pick distance.

Specified by:

getDisplayItem in class IlvChartRenderer

Parameters:

picker - The object holding the picking information.

Returns:

The display point, or null if none is found.

See Also:

IlvChartRenderer.getNearestItem(IlvChartDataPicker, double[])

collectDisplayItems

public void collectDisplayItems(IlvChartDataPicker picker,
                                ArrayList<IlvDisplayPoint> accumulator)

Collects the display items containing the specified picking point. This is like getDisplayItem(IlvChartDataPicker), except that it returns all items, if several renderers happen to show an item at or near the same point. The first collected point is the same as the one returned by getDisplayItem(IlvChartDataPicker).

Overrides:

collectDisplayItems in class IlvChartRenderer

Parameters:

picker - The object holding the picking information.

accumulator - A list to which the found display items will be added.

Since:

JViews 8.8

getDisplayPoint

public IlvDisplayPoint getDisplayPoint(IlvDataSet dataSet,
                                       int dataIdx)

Returns the display point corresponding to the specified data point.

Specified by:

getDisplayPoint in class IlvChartRenderer

getXRange

public IlvDataInterval getXRange(IlvDataInterval retRange)

Returns the range of the x-values displayed by this renderer.

Specified by:

getXRange in class IlvChartRenderer

Parameters:

retRange - An interval used to store the result. If this parameter is null, a new IlvDataInterval is allocated.

Returns:

The computed range.

getYRange

public IlvDataInterval getYRange(IlvDataInterval retRange)

Returns the range of the y-values displayed by this renderer.

Specified by:

getYRange in class IlvChartRenderer

Parameters:

retRange - An interval used to store the result. If this parameter is null, a new IlvDataInterval is allocated.

Returns:

The computed range.

getYRange

public IlvDataInterval getYRange(IlvDataInterval xRange,
                                 IlvDataInterval retRange)

Returns the range of the y-values displayed by this renderer within the specified X interval.

Specified by:

getYRange in class IlvChartRenderer

Parameters:

xRange - The X interval used to select the points.

retRange - An interval used to store the result. If this parameter is null, a new IlvDataInterval is allocated.

Returns:

The computed range.

drawLegendSymbol

public void drawLegendSymbol(IlvLegendItem item,
                             Graphics g,
                             int x,
                             int y,
                             int w,
                             int h)

Draws the symbol of the given legend item. This method is called by IlvRendererLegendItem instances to draw the item symbol.

Specified by:

drawLegendSymbol in class IlvChartRenderer

Parameters:

item - The legend item to draw.

g - The graphics context.

x - The symbol x-coordinate.

y - The symbol y-coordinate.

w - The symbol width.

h - The symbol height.

See Also:

IlvRendererLegendItem

createLegendItems

public IlvLegendItem[] createLegendItems()

Creates the legend item instances associated to this renderer. This method is automatically called by the legend to populate itself. The default implementation returns an array containing all the legend items created by its children, calling their own createLegendItems method.

Specified by:

createLegendItems in class IlvChartRenderer

Returns:

An array containing all the legend items associated to its child renderers, or null.

See Also:

IlvLegend, IlvLegendItem

getLegendText

public String getLegendText(IlvLegendItem item)

Returns the label of the specified legend item. The default implementation returns an empty string.

Overrides:

getLegendText in class IlvChartRenderer

addImageMapAreas

public void addImageMapAreas(IlvIMapDefinition mapDef,
                             List<? super IlvIMapArea> areaList)

Generates image map areas.

Overrides:

addImageMapAreas in class IlvChartRenderer

Parameters:

mapDef - The map definition.

areaList - The list of map areas. The method must add instances of IlvIMapArea to this list.

drawIntoHitmap

public void drawIntoHitmap(IlvChartHitmapDefinition definition,
                           IlvChartHitmapAccumulator accumulator)

Draws the rendering into a hitmap.

Overrides:

drawIntoHitmap in class IlvChartRenderer

Parameters:

definition - The specification how to construct the hitmap.

accumulator - The object that accumulates objects in the hitmap.

Since:

JViews 8.7

See Also:

IlvChartHitmapDefinition.drawIntoHitmap(IlvChart, IlvChartRenderer, IlvChartHitmapAccumulator)

setAnnotation

public void setAnnotation(IlvDataSet dataSet,
                          int idx,
                          IlvDataAnnotation annotation)

Specifies an annotation for a data point.

Specified by:

setAnnotation in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

idx - The index of the considered point in the data set.

annotation - The new annotation, or null if the annotation associated with the specified point must be removed. If an annotation has already been specified globally with the IlvChartRenderer.setAnnotation(IlvDataSet, IlvDataAnnotation) method, it is overridden by this new annotation. In that case, a null value has no effect.

setAnnotation

public void setAnnotation(IlvDataSet dataSet,
                          IlvDataAnnotation annotation)

Specifies an annotation for all the data points of a data set.

Specified by:

setAnnotation in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

annotation - The new annotation, or null if the global annotation must be removed.

See Also:

IlvChartRenderer.setAnnotation(IlvDataAnnotation)

getAnnotation

public IlvDataAnnotation getAnnotation(IlvDataSet dataSet,
                                       int idx)

Returns the annotation of the specified data point.

Specified by:

getAnnotation in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

idx - The index of the point within the data set.

Returns:

The annotation associated with the data point.

holdsAnnotations

public boolean holdsAnnotations()

Returns true if some annotations are defined for some data sets, data points, or data objects, in this renderer.

Specified by:

holdsAnnotations in class IlvChartRenderer

setRenderingHint

public void setRenderingHint(IlvDataSet dataSet,
                             int idx,
                             IlvDataRenderingHint hint)

Specifies a rendering hint for a data point.

Specified by:

setRenderingHint in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

idx - The index of the considered point in the data set.

hint - The new rendering hint, or null if the hint associated with the specified point must be removed. If an hint has already been specified globally with the IlvChartRenderer.setRenderingHint(IlvDataSet, IlvDataRenderingHint)} method, it is overridden by this new hint. In that case, a null value has no effect.

setRenderingHint

public void setRenderingHint(IlvDataSet dataSet,
                             IlvDataRenderingHint hint)

Specifies a rendering hint for all the data points of a data set.

Specified by:

setRenderingHint in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

hint - The new rendering hint, or null if the global hint must be removed.

getRenderingHint

public IlvDataRenderingHint getRenderingHint(IlvDataSet dataSet,
                                             int idx)

Returns the rendering hint of the specified data point.

Specified by:

getRenderingHint in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

idx - The index of the point within the data set.

Returns:

The rendering hint associated with the data point, or null for none.

getRenderingHint

public IlvDataRenderingHint getRenderingHint(IlvDataSet dataSet)

Returns the rendering hint that was specified globally for all the points of the given data set.

Specified by:

getRenderingHint in class IlvChartRenderer

Parameters:

dataSet - The considered data set.

Returns:

The rendering hint associated with the data set, or null for none.

Since:

JViews 8.8