ilog.views.chart.renderer

Class IlvHiLoChartRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvCompositeChartRenderer

ilog.views.chart.renderer.IlvHiLoChartRenderer

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, IlvVariableWidthRenderer, Serializable

public class IlvHiLoChartRenderer
extends IlvCompositeChartRenderer
implements IlvVariableWidthRenderer

A renderer displaying superimposed High/Low renderers. The IlvHiLoChartRenderer class defines 3 representation modes: CLUSTERED, CANDLE and OPENCLOSE.

In CLUSTERED mode, this class creates an instance of IlvSingleHiLoRenderer for every pair (maximum 2) of data sets, in the low/high order. The type of the child renderers is determined according to the type property (see setType(int)), and should match one of the IlvSingleHiLoRenderer types. Note that the type property only makes sense with the CLUSTERED mode.

In OPENCLOSE mode, the required number of data sets is 4: 2 data sets (the first ones) for the high/low representation plus 2 data sets for the start/end representation, each representation corresponding to an IlvSingleHiLoRenderer instance (of type STICK and MARKED, respectively).

The CANDLE mode only differs from OPENCLOSE mode by the graphic representation used: the high/low representation is of type STICK, the open/close being of type BAR.

The following pictures show the representation of each mode in the following order: CANDLE, OPENCLOSE and CLUSTERED/BAR with 2 children.

Since:

JViews 5.0

See Also:

IlvSingleHiLoRenderer, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANDLE The candle mode.
static int	CLUSTERED The clustered mode.
static int	OPENCLOSE The openclose mode.

Fields inherited from class ilog.views.chart.IlvChartRenderer

AREA, BAR, BUBBLE, 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

Fields inherited from interface ilog.views.chart.renderer.IlvVariableWidthRenderer

DEFAULT_WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvHiLoChartRenderer() Creates a new High-Low chart, in CLUSTERED BAR mode, with a default width.
IlvHiLoChartRenderer(int mode, int type, double widthPercent) Creates a new High-Low chart.

Method Summary

Modifier and Type	Method and Description
protected IlvChartRenderer	createChild(IlvDataSet dataSet) Creates an instance of IlvSingleHiLoRenderer to display the specified data set.
IlvLegendItem[]	createLegendItems() Creates the legend item instances associated to this renderer.
protected void	dataSetsAdded(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets) Called when data sets are connected to this renderer.
protected void	dataSetsChangesBatchEnding() Called when a series of data sets insertions or removals is terminating.
protected void	dataSetsChangesBatchStarting() Called when a series of data sets insertions or removals is starting.
protected void	dataSetsRemoved(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets) Called when data sets are disconnected from this renderer.
void	drawLegendSymbol(IlvLegendItem item, Graphics g, int x, int y, int w, int h) Draws the symbol of the given legend item.
IlvSingleHiLoRenderer	getHiLo(IlvDataSet dataSet) Returns the child HiLo renderer displaying the specified data set.
String	getLegendText(IlvLegendItem item) Returns the legend item text.
int	getMode() Returns the mode of this renderer.
String	getName() Returns the name of the first child renderer pair.
String	getName(int idx) Returns the name of the designated child renderer pair.
String[]	getNames() Returns the list of names of the child renderer pairs.
double	getOverlap() Returns the overlapping amount.
double	getSpecWidthPercent() Returns the specified width of the graphical representation of a data point along the x-axis.
int	getType() Returns the type of the renderer.
double	getWidth() Returns the width of the graphical representation of a data point along the x-axis.
double	getWidthPercent() Returns the width of the graphical representation of a data point along the x-axis.
boolean	isUseCategorySpacingAtBorders() Returns true if the category spacing is used also at the left and right borders.
void	setMode(int mode) Sets the mode of this renderer.
void	setName(int idx, String name) Sets the name of the designated child renderer pair.
void	setName(String name) Sets the name of the first child renderer pair.
void	setNames(String[] names) Sets the list of names of the child renderer pairs.
void	setOverlap(double overlap) Modifies the overlapping amount.
void	setStyles(IlvStyle[] styles) Sets the styles used by the child renderers.
void	setType(int type) Sets the type of the renderer.
void	setUseCategorySpacingAtBorders(boolean useCategorySpacingAtBorders) Determines whether the category spacing is used also at the left and right borders.
void	setWidthPercent(double percent) Sets the width of the graphical representation of a data point along the x-axis.

Methods inherited from class ilog.views.chart.renderer.IlvCompositeChartRenderer

addImageMapAreas, collectDisplayItems, draw, draw, drawAnnotations, drawIntoHitmap, drawSelectionHandles, getAnnotation, getBounds, getBounds, getChild, getChild, getChild, getChildCount, getChildIterator, getChildren, getDisplayItem, getDisplayPoint, getNearestItem, getNearestPoint, getRenderingHint, getRenderingHint, getStyle, getStyles, getXRange, getYRange, getYRange, holdsAnnotations, isViewable, setAnnotation, setAnnotation, setDataPoint, setDisplayPoint, setRenderingHint, setRenderingHint, updateChildren

Methods inherited from class ilog.views.chart.IlvChartRenderer

applyStyles, applyStyles, applyStyles, chartConnected, computeDataLabel, computeDataLabelLocation, create, createRenderer, 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, getNearestItem, getNearestPoint, getParent, getPlotRect, getPreferredMargins, getRenderingHint, getStyle, getVirtualDataSet, getXShift, getYAxisIdx, has3DSupport, isDisplayingDataSet, isVisible, isVisibleInLegend, reDraw, register, set3D, setAnnotation, setDataLabeling, setDataLabelLayout, setDataLabelling, setDataSource, setParent, setRenderingHint, setRenderingHintWithNoDraw, 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

Field Detail

CLUSTERED

public static final int CLUSTERED

The clustered mode.

See Also:

Constant Field Values

CANDLE

public static final int CANDLE

The candle mode.

See Also:

Constant Field Values

OPENCLOSE

public static final int OPENCLOSE

The openclose mode.

See Also:

Constant Field Values

Constructor Detail

IlvHiLoChartRenderer

public IlvHiLoChartRenderer()

Creates a new High-Low chart, in CLUSTERED BAR mode, with a default width.

IlvHiLoChartRenderer

public IlvHiLoChartRenderer(int mode,
                            int type,
                            double widthPercent)

Creates a new High-Low chart.

Parameters:

mode - The mode of the renderer. One of the CLUSTERED, CANDLE or OPENCLOSE constant.

type - The type of the renderer. One of the IlvSingleHiLoRenderer type. Used only for CLUSTERED mode.

widthPercent - The width of the renderers.

See Also:

setMode(int), IlvSingleHiLoRenderer

Method Detail

getType

public final int getType()

Returns the type of the renderer. This method is meaningful only in CLUSTERED mode.

Since:

JViews 5.5

setType

public void setType(int type)

Sets the type of the renderer. This attribute is only taken into account in CLUSTERED mode.

getMode

public int getMode()

Returns the mode of this renderer.

See Also:

setMode(int)

setMode

public void setMode(int mode)

Sets the mode of this renderer.

See Also:

CLUSTERED, CANDLE, OPENCLOSE

getNames

public String[] getNames()

Returns the list of names of the child renderer pairs. Every name applies to a pair of child renderers, or equivalently, to a quadruple of data sets.

Returns:

An array of names, or null.

Since:

JViews 8.5

setNames

public void setNames(String[] names)

Sets the list of names of the child renderer pairs. Every name applies to a pair of child renderers, or equivalently, to a quadruple of data sets.

Note: The bean property names must not be specified together with the bean property name.

Parameters:

names - An array of names, or null.

Since:

JViews 8.5

getName

public String getName(int idx)

Returns the name of the designated child renderer pair.

Parameters:

idx - An index.

Since:

JViews 8.5

setName

public void setName(int idx,
                    String name)

Sets the name of the designated child renderer pair.

Parameters:

idx - An index.

name - A string, used as name for the idxth child renderer pair.

Since:

JViews 8.5

getName

public String getName()

Returns the name of the first child renderer pair.

Overrides:

getName in class IlvChartRenderer

setName

public void setName(String name)

Sets the name of the first child renderer pair.

Note: The bean property name must not be specified together with the bean property names.

Overrides:

setName in class IlvChartRenderer

getOverlap

public double getOverlap()

Returns the overlapping amount. This method is only meaningful when the mode of the renderer is set to CLUSTERED.

See Also:

setOverlap(double)

setOverlap

public void setOverlap(double overlap)

Modifies the overlapping amount. The overlap parameter can take values between 0 and 100. It specifies the amount by which bars overlap. This method is only meaningful when the mode of the renderer is set to CLUSTERED.

getSpecWidthPercent

public double getSpecWidthPercent()

Returns the specified width of the graphical representation of a data point along the x-axis.

Since:

JViews 8.0

See Also:

setWidthPercent(double)

setWidthPercent

public void setWidthPercent(double percent)

Sets the width of the graphical representation of a data point along the x-axis. The size is specified as a percentage of the difference between the x-values of two consecutive data points. It is assumed that all the data points are evenly spaced along the x-axis, and that the resulting size is the same for all the data points. The default implementation propagates the new value to its children.

Specified by:

setWidthPercent in interface IlvVariableWidthRenderer

Parameters:

percent - The new percentage. Valid values are between 0 and 100.

See Also:

getWidthPercent(), getSpecWidthPercent()

getWidthPercent

public double getWidthPercent()

Returns the width of the graphical representation of a data point along the x-axis. The returned size is expressed as a percentage of the difference between the x-values of two consecutive data points.

Specified by:

getWidthPercent in interface IlvVariableWidthRenderer

See Also:

setWidthPercent(double)

getWidth

public double getWidth()

Returns the width of the graphical representation of a data point along the x-axis. The returned size is expressed in data space.

Specified by:

getWidth in interface IlvVariableWidthRenderer

isUseCategorySpacingAtBorders

public boolean isUseCategorySpacingAtBorders()

Returns true if the category spacing is used also at the left and right borders.

Specified by:

isUseCategorySpacingAtBorders in interface IlvVariableWidthRenderer

Since:

JViews 8.8

setUseCategorySpacingAtBorders

public void setUseCategorySpacingAtBorders(boolean useCategorySpacingAtBorders)

Determines whether the category spacing is used also at the left and right borders. If set to true, category spacing is not only used between bars, but also beyond the leftmost and rightmost bars. If set to false (the default), this spacing is omitted. This setting matters only if getWidthPercent is less than 100.

Specified by:

setUseCategorySpacingAtBorders in interface IlvVariableWidthRenderer

Since:

JViews 8.8

getHiLo

public IlvSingleHiLoRenderer getHiLo(IlvDataSet dataSet)

Returns the child HiLo renderer displaying the specified data set.

dataSetsRemoved

protected void dataSetsRemoved(int firstIdx,
                               int lastIdx,
                               IlvDataSet[] oldDataSets)

Called when data sets are disconnected from this renderer.

Overrides:

dataSetsRemoved in class IlvChartRenderer

Parameters:

firstIdx - The index of the first data set.

lastIdx - The index of the last data set.

oldDataSets - The data sets previously connected to this renderer.

dataSetsAdded

protected void dataSetsAdded(int firstIdx,
                             int lastIdx,
                             IlvDataSet[] oldDataSets)

Called when data sets are connected to this renderer.

Overrides:

dataSetsAdded in class IlvChartRenderer

Parameters:

firstIdx - The index of the first data set.

lastIdx - The index of the last data set.

oldDataSets - The data sets previously connected to this renderer.

dataSetsChangesBatchStarting

protected void dataSetsChangesBatchStarting()

Called when a series of data sets insertions or removals is starting.

Overrides:

dataSetsChangesBatchStarting in class IlvChartRenderer

Since:

JViews 8.5

See Also:

IlvChartRenderer.dataSetsChangesBatchEnding()

dataSetsChangesBatchEnding

protected void dataSetsChangesBatchEnding()

Called when a series of data sets insertions or removals is terminating.

Overrides:

dataSetsChangesBatchEnding in class IlvChartRenderer

Since:

JViews 8.5

See Also:

IlvChartRenderer.dataSetsChangesBatchStarting()

createChild

protected IlvChartRenderer createChild(IlvDataSet dataSet)

Creates an instance of IlvSingleHiLoRenderer to display the specified data set.

Specified by:

createChild in class IlvCompositeChartRenderer

Returns:

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

setStyles

public void setStyles(IlvStyle[] styles)

Sets the styles used by the child renderers. This method assumes that the given array contains 2 styles per child.

Overrides:

setStyles in class IlvCompositeChartRenderer

Throws:

IllegalArgumentException - The array does not contain 2 styles (fall and rise) per child.

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 creates a IlvRendererLegendItem instance for each set of representation.

Overrides:

createLegendItems in class IlvCompositeChartRenderer

Returns:

An array containing all the legend items associated to this renderer, or null.

See Also:

IlvLegend, IlvLegendItem, getLegendText(ilog.views.chart.IlvLegendItem)

getLegendText

public String getLegendText(IlvLegendItem item)

Returns the legend item text.

Overrides:

getLegendText in class IlvCompositeChartRenderer

Returns:

The name of this renderer if it is defined, or the concatenation of the children legend text.

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.

Overrides:

drawLegendSymbol in class IlvCompositeChartRenderer

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