ilog.views.chart.renderer

Class IlvSingleHiLoRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvSingleChartRenderer

ilog.views.chart.renderer.IlvSingleHiLoRenderer

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, IlvVariableWidthRenderer, Serializable

public class IlvSingleHiLoRenderer
extends IlvSingleChartRenderer
implements IlvVariableWidthRenderer

Renders two data sets that contain corresponding points at the same indices.

For every point index, a point is taken from the first data set in the data source, and a point is taken from the second data set in the data source, to form a pair of points. The pairs of points are also called "high/low" items.

This renderer is used in three situations:

• By an IlvHiLoRenderer in CLUSTERED mode. In this case, the pair consists of a "first point" and of a "second point".
• By an IlvHiLoRenderer in CANDLE or OPENCLOSE mode, for the high-low values. In this case, the pair consists of a "low value" and of a "high value". The low value comes first.
• By an IlvHiLoRenderer in CANDLE or OPENCLOSE mode, for the open-close values. In this case, the pair consists of an "open" (or "start") value and of a "close" (or "end") value.

An IlvSingleHiLoRenderer can be of 4 types: BAR, ARROW, MARKED and STICK. The only difference among these modes is the way the renderer is drawn. The following figure shows the different types:

This renderer uses two rendering styles to draw the data points:

• The rise style is used to draw the point pairs for which the first value (from the data set at index 0 in the data source) is less than the second value (from the data set at index 1 in the data source).
• The fall style is used to draw the point pairs for which the first value (data set at index 0 in the data source) is greater than the second value (data set at index 1 in the data source).

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARROW Arrow renderer type.
static int	BAR Bar renderer type.
static int	MARKED Marked renderer type.
static int	STICK Stick renderer type.

Fields inherited from class ilog.views.chart.IlvChartRenderer

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

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

DEFAULT_WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvSingleHiLoRenderer() Creates a new HiLo renderer.
IlvSingleHiLoRenderer(IlvStyle riseStyle, IlvStyle fallStyle) Creates a new HiLo renderer, using the specified styles.
IlvSingleHiLoRenderer(IlvStyle riseStyle, IlvStyle fallStyle, int type, double widthPercent) Creates a new HiLo renderer, using the specified styles, type, and width.

Method Summary

Modifier and Type	Method and Description
void	applyStyles(boolean newStyles) Applies styling to the renderer.
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when the renderer is added to or removed from a chart.
protected void	dataSetsAdded(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets) Called when data sets are connected to this renderer.
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.
Rectangle2D	getBounds(IlvDataSet dataSet, int iMin, int iMax, Rectangle2D bounds) Returns the bounds of the graphical representation for the specified data.
Rectangle2D	getBounds(IlvDataSet dataSet, int iMin, int iMax, Rectangle2D bounds, boolean includeAnnotations) Returns the bounds of the graphical representation for the specified data.
IlvStyle	getFallStyle() Returns the fall style.
int	getMinDataSetCount() Returns the minimum number of required data sets.
IlvStyle	getRiseStyle() Returns the rise style.
static int	getStrokeThreshold() Returns the minimum width of an HiLo item, under which the stroke of a rendering style is not used.
IlvStyle[]	getStyles() Returns the styles used by this renderer.
int	getType() Returns the type of this 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	isFilled() Indicates whether the renderer uses a fill color.
boolean	isUseCategorySpacingAtBorders() Returns true if the category spacing is used also at the left and right borders.
void	setFallStyle(IlvStyle r) Sets the fall style.
void	setRiseStyle(IlvStyle r) Sets the rise style.
static void	setStrokeThreshold(int threshold) Specifies the minimum width of an HiLo item, under which the stroke of a rendering style is not used.
void	setStyles(IlvStyle[] styles) Sets the styles used by the child renderers.
void	setType(int type) Sets the type of this 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.IlvSingleChartRenderer

addImageMapAreas, applyDataSetStyle, createLegendItems, dataSetContentsChanged, dataSetPropertyChanged, draw, draw, drawAnnotations, drawIntoHitmap, drawSelectionHandles, drawSelectionHandles, getAnnotation, getBounds, getDefaultLegendText, getDisplayItem, getDisplayPoint, getDisplayStyle, getLegendText, getNearestItem, getNearestPoint, getPreferredMargins, getRenderingHint, getRenderingHint, getStyle, getStyle, getXRange, getYRange, getYRange, getZAnnotationText, holdsAnnotations, makeDefaultStyle, set3D, setAnnotation, setAnnotation, setDataPoint, setDisplayPoint, setRenderingHint, setRenderingHint, setStyle, toDisplay, toDisplay

Methods inherited from class ilog.views.chart.IlvChartRenderer

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

Methods inherited from class java.lang.Object

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

Field Detail

STICK

public static final int STICK

Stick renderer type. A vertical line is drawn between the first point and the second point of each pair.

See Also:

Constant Field Values

BAR

public static final int BAR

Bar renderer type. A vertical bar is drawn between the first point and the second point of each pair.

See Also:

Constant Field Values

ARROW

public static final int ARROW

Arrow renderer type. A vertical arrow is drawn from the first point to the second point of each pair.

See Also:

Constant Field Values

MARKED

public static final int MARKED

Marked renderer type. A small horizontal line is drawn on the left, for the first point, and a small horizontal line is drawn on the right, for the second point, of each pair.

See Also:

Constant Field Values

Constructor Detail

IlvSingleHiLoRenderer

public IlvSingleHiLoRenderer()

Creates a new HiLo renderer.

IlvSingleHiLoRenderer

public IlvSingleHiLoRenderer(IlvStyle riseStyle,
                             IlvStyle fallStyle)

Creates a new HiLo renderer, using the specified styles.

IlvSingleHiLoRenderer

public IlvSingleHiLoRenderer(IlvStyle riseStyle,
                             IlvStyle fallStyle,
                             int type,
                             double widthPercent)

Creates a new HiLo renderer, using the specified styles, type, and width.

Method Detail

getStrokeThreshold

public static int getStrokeThreshold()

Returns the minimum width of an HiLo item, under which the stroke of a rendering style is not used.

See Also:

setStrokeThreshold(int)

setStrokeThreshold

public static void setStrokeThreshold(int threshold)

Specifies the minimum width of an HiLo item, under which the stroke of a rendering style is not used.

The default value is 6.

Parameters:

threshold - The new threshold in pixel. Filled HiLo items with a width smaller than this threshold will not be rendered with a stroke.

See Also:

getStrokeThreshold()

getMinDataSetCount

public int getMinDataSetCount()

Returns the minimum number of required data sets. The default implementation returns 2.

Overrides:

getMinDataSetCount in class IlvChartRenderer

isFilled

public boolean isFilled()

Indicates whether the renderer uses a fill color.

Overrides:

isFilled in class IlvSingleChartRenderer

Returns:

true for the BAR and types, false otherwise.

Since:

JViews 5.5

See Also:

getType()

getRiseStyle

public IlvStyle getRiseStyle()

Returns the rise style.

setRiseStyle

public void setRiseStyle(IlvStyle r)

Sets the rise style.

Note: The Bean property riseStyle must not be specified together with the Bean property style.

getFallStyle

public IlvStyle getFallStyle()

Returns the fall style.

setFallStyle

public void setFallStyle(IlvStyle r)

Sets the fall style.

getStyles

public IlvStyle[] getStyles()

Returns the styles used by this renderer.

Overrides:

getStyles in class IlvSingleChartRenderer

See Also:

IlvSingleChartRenderer.getStyle()

setStyles

public void setStyles(IlvStyle[] styles)

Sets the styles used by the child renderers. The IlvSingleHiLoRenderer assumes that the given array contains the rise style at index 0 and the fall style at index 1. If this is not the case, the first array item is set as both the fall and rise style.

Overrides:

setStyles in class IlvSingleChartRenderer

See Also:

Note: The Bean property styles must not be specified together with the Bean property style.

applyStyles

public void applyStyles(boolean newStyles)
                 throws Exception

Applies styling to the renderer. Internal method.

Overrides:

applyStyles in class IlvSingleChartRenderer

Throws:

Exception

Since:

JViews 5.5

Internal: do not use!

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)

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.

Specified by:

setWidthPercent in interface IlvVariableWidthRenderer

Parameters:

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

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

getType

public final int getType()

Returns the type of this renderer.

See Also:

STICK, BAR, MARKED, ARROW

setType

public void setType(int type)

Sets the type of this renderer. This method triggers a ChartRendererEvent.STYLE_CHANGED event.

See Also:

STICK, BAR, MARKED, ARROW, IlvChartRenderer.triggerChange(int)

getBounds

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

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.

Overrides:

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.

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.

Overrides:

getBounds in class IlvSingleChartRenderer

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.

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

Called when the renderer is added to or removed from a chart.

Overrides:

chartConnected in class IlvSingleChartRenderer

Parameters:

oldChart - The chart with which this renderer was associated. This parameter is null if this renderer is added to a new chart.

newChart - The chart to which this renderer is added. This parameter is null if this renderer is removed from its current chart.

dataSetsRemoved

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

Called when data sets are disconnected from this renderer.

Overrides:

dataSetsRemoved in class IlvSingleChartRenderer

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 IlvSingleChartRenderer

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.

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 IlvSingleChartRenderer

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