com.klg.jclass.chart
Class JCCandleChartFormat

java.lang.Object
  |
  +--com.klg.jclass.chart.JCCandleChartFormat

All Implemented Interfaces:

JCChartTypeFormat, Serializable

public class JCCandleChartFormat

extends Object

implements JCChartTypeFormat, Serializable

Class that manages properties and convenience methods specific to candle charts.

Candle charts take the y values of 4 data series to construct each "logical" candle series. The number of data points defines the number of candles in each row.

Note: The methods in this class use the logical candle series index instead of the actual series index, in order to make programming candle styles more convenient.

See Also:

Serialized Form

Field Summary

protected static int	CANDLE_OUTLINE_INDEX
protected boolean	complex
protected static int	FALLING_CANDLE_INDEX
protected com.klg.jclass.chart.ChartDataView	parent
protected static int	RISING_CANDLE_INDEX

Constructor Summary

JCCandleChartFormat()

JCCandleChartFormat(com.klg.jclass.chart.ChartDataView p)

Method Summary

com.klg.jclass.chart.JCChartStyle	getCandleOutlineStyle(int index) Gets the JCChartStyle that controls the candle outline style of the complex candle chart.
com.klg.jclass.chart.JCChartStyle	getFallingCandleStyle(int index) Gets the JCChartStyle that controls the falling candle style of the complex candle chart.
com.klg.jclass.chart.JCChartStyle	getHiloStyle(int index) Gets the JCChartStyle that controls the candle style of the simple candle or the HiLo line of the complex candle chart.
com.klg.jclass.chart.ChartDataView	getParent()
com.klg.jclass.chart.JCChartStyle	getRisingCandleStyle(int index) Gets the JCChartStyle that controls the rising candle style of the complex candle chart.
boolean	isComplex() Gets the Complex property of the candle chart; this property determines whether the candle is a simple or complex candle.
void	setCandleOutlineStyle(int index, com.klg.jclass.chart.JCChartStyle value) Sets the candle style of the candle outline style of the complex candle chart.
void	setComplex(boolean b) Sets the Complex property of the candle chart; this property determines whether the candle is a simple or complex candle.
void	setFallingCandleStyle(int index, com.klg.jclass.chart.JCChartStyle value) Sets the candle style of the falling candle style of the complex candle chart.
void	setHiloStyle(int index, com.klg.jclass.chart.JCChartStyle value) Sets the candle style of the simple candle or the HiLo line of the complex candle chart.
void	setParent(com.klg.jclass.chart.ChartDataView cdv)
void	setRisingCandleStyle(int index, com.klg.jclass.chart.JCChartStyle value) Sets the candle style of the rising candle style of the complex candle chart.

Methods inherited from class java.lang.Object

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

Field Detail

RISING_CANDLE_INDEX

protected static final int RISING_CANDLE_INDEX

See Also:

Constant Field Values

FALLING_CANDLE_INDEX

protected static final int FALLING_CANDLE_INDEX

See Also:

Constant Field Values

CANDLE_OUTLINE_INDEX

protected static final int CANDLE_OUTLINE_INDEX

See Also:

Constant Field Values

complex

protected boolean complex

parent

protected com.klg.jclass.chart.ChartDataView parent

Constructor Detail

JCCandleChartFormat

public JCCandleChartFormat()

JCCandleChartFormat

public JCCandleChartFormat(com.klg.jclass.chart.ChartDataView p)

Method Detail

setParent

public void setParent(com.klg.jclass.chart.ChartDataView cdv)

Specified by:

setParent in interface JCChartTypeFormat

isComplex

public boolean isComplex()

Gets the Complex property of the candle chart; this property determines whether the candle is a simple or complex candle.

Returns:

true if complex.

setComplex

public void setComplex(boolean b)

Sets the Complex property of the candle chart; this property determines whether the candle is a simple or complex candle.

Parameters:

b - if true, the chart is a complex candle; otherwise, the chart is a simple candle.

getHiloStyle

public com.klg.jclass.chart.JCChartStyle getHiloStyle(int index)

Gets the JCChartStyle that controls the candle style of the simple candle or the HiLo line of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

Returns:

JCChartStyle object.

setHiloStyle

public void setHiloStyle(int index,
                         com.klg.jclass.chart.JCChartStyle value)

Sets the candle style of the simple candle or the HiLo line of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

value - JCChartStyle object containing the desired style

getRisingCandleStyle

public com.klg.jclass.chart.JCChartStyle getRisingCandleStyle(int index)

Gets the JCChartStyle that controls the rising candle style of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

Returns:

JCChartStyle object.

setRisingCandleStyle

public void setRisingCandleStyle(int index,
                                 com.klg.jclass.chart.JCChartStyle value)

Sets the candle style of the rising candle style of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

value - JCChartStyle object containing the desired style

getFallingCandleStyle

public com.klg.jclass.chart.JCChartStyle getFallingCandleStyle(int index)

Gets the JCChartStyle that controls the falling candle style of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

Returns:

JCChartStyle object.

setFallingCandleStyle

public void setFallingCandleStyle(int index,
                                  com.klg.jclass.chart.JCChartStyle value)

Sets the candle style of the falling candle style of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

value - JCChartStyle object containing the desired style

getCandleOutlineStyle

public com.klg.jclass.chart.JCChartStyle getCandleOutlineStyle(int index)

Gets the JCChartStyle that controls the candle outline style of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

Returns:

JCChartStyle object.

setCandleOutlineStyle

public void setCandleOutlineStyle(int index,
                                  com.klg.jclass.chart.JCChartStyle value)

Sets the candle style of the candle outline style of the complex candle chart.

Parameters:

index - logical candle series (not the actual data series)

value - JCChartStyle object containing the desired style

getParent

public com.klg.jclass.chart.ChartDataView getParent()