com.dukascopy.api.drawings
Interface IOhlcChartObject

All Superinterfaces:

IChartObject

public interface IOhlcChartObject
extends IChartObject

Nested Class Summary

static class	IOhlcChartObject.CandleInfoParams
static class	IOhlcChartObject.OhlcAlignment
static class	IOhlcChartObject.PriceAgregatedInfoParams
static class	IOhlcChartObject.TickInfoParams

Nested classes/interfaces inherited from interface com.dukascopy.api.IChartObject

IChartObject.ATTR_BOOLEAN, IChartObject.ATTR_COLOR, IChartObject.ATTR_DOUBLE, IChartObject.ATTR_INT, IChartObject.ATTR_LONG, IChartObject.ATTR_TEXT

Field Summary

static String	PROPERTY_OHLC_ALIGNMENT String constant to be used in PropertyChangeListener
static String	PROPERTY_OHLC_PARAM_VISIBILITY String constant to be used in PropertyChangeListener
static String	PROPERTY_OHLC_POSY String constant to be used in PropertyChangeListener
static String	PROPERTY_OHLC_POSX String constant to be used in PropertyChangeListener
static String	PROPERTY_OHLC_SHOW_INDICATOR_INFO String constant to be used in PropertyChangeListener

Fields inherited from interface com.dukascopy.api.IChartObject

PROPERTY_FONT, PROPERTY_FOREGROUND_ALPHA, PROPERTY_FOREGROUND_COLOR, PROPERTY_POINT_PRICE, PROPERTY_POINT_TIME, PROPERTY_STICKY, PROPERTY_STROKE

Method Summary

void	addUserMessage(String message, Color color, int textAlignment, boolean bold) Adds user message.
void	addUserMessage(String label, String value, Color color) Adds user message.
void	clearUserMessages() Clears all user's custom messages.
IOhlcChartObject.OhlcAlignment	getAlignment() Returns current alignment mode.
<E extends Enum<E>> boolean	getParamVisibility(Enum<E> param) Returns whether parameter is displaying in current OHLC Informer or not.
float	getPosY() Returns current position of OHLC Informer upper border on chart.
float	getPosX() Returns current position of OHLC Informer left border on chart.
boolean	getShowIndicatorInfo() Returns whether indicator values are displaying or not.
Dimension	getSize() Returns current size of OHLC Informer chart object
void	setAlignment(IOhlcChartObject.OhlcAlignment alignment) Sets OhlcAlignment mode for this OHLC Informer.
<E extends Enum<E>> void	setParamVisibility(Enum<E> param, boolean visible) Setup visibility property for specified parameter.
void	setPosY(float value) Sets position of OHLC Informer upper border on chart.
void	setPosX(float value) Sets position of OHLC Informer left border on chart.
void	setPreferredSize(Dimension dimension) Sets preferred size for OHLC Informer chart object.
void	setShowIndicatorInfo(boolean showIndicatorInfo) Sets property allowing to show indicator values.

Methods inherited from interface com.dukascopy.api.IChartObject

addPropertyChangeListener, getAttrBoolean, getAttrColor, getAttrDouble, getAttrInt, getAttrLong, getAttrText, getColor, getKey, getOpacity, getPointsCount, getPrice, getPropertyChangeListeners, getStroke, getText, getTime, getType, isMenuEnabled, isSticky, move, removePropertyChangeListener, setAttrBoolean, setAttrColor, setAttrDouble, setAttrInt, setAttrLong, setAttrText, setChartObjectListener, setColor, setMenuEnabled, setOpacity, setSticky, setStroke, setText, setText, setText, setText

Field Detail

PROPERTY_OHLC_ALIGNMENT

static final String PROPERTY_OHLC_ALIGNMENT

String constant to be used in PropertyChangeListener

See Also:

Constant Field Values

PROPERTY_OHLC_PARAM_VISIBILITY

static final String PROPERTY_OHLC_PARAM_VISIBILITY

String constant to be used in PropertyChangeListener

See Also:

Constant Field Values

PROPERTY_OHLC_POSX

static final String PROPERTY_OHLC_POSX

String constant to be used in PropertyChangeListener

See Also:

Constant Field Values

PROPERTY_OHLC_POSY

static final String PROPERTY_OHLC_POSY

String constant to be used in PropertyChangeListener

See Also:

Constant Field Values

PROPERTY_OHLC_SHOW_INDICATOR_INFO

static final String PROPERTY_OHLC_SHOW_INDICATOR_INFO

String constant to be used in PropertyChangeListener

See Also:

Constant Field Values

Method Detail

getAlignment

IOhlcChartObject.OhlcAlignment getAlignment()

Returns current alignment mode.

Returns:

OhlcAlignment value.

setAlignment

void setAlignment(IOhlcChartObject.OhlcAlignment alignment)

Sets OhlcAlignment mode for this OHLC Informer. Use OhlcAlignment.AUTO to determine alignment automatically.

Parameters:

alignment - OhlcAlignment value.

getParamVisibility

<E extends Enum<E>> boolean getParamVisibility(Enum<E> param)

Returns whether parameter is displaying in current OHLC Informer or not.

Parameters:

param - one of IOhlcChartObject.CandleInfoParams, IOhlcChartObject.TickInfoParams or IOhlcChartObject.PriceAgregatedInfoParams

Returns:

Throws:

NullPointerException - in case of unsupported parameter type.

setParamVisibility

<E extends Enum<E>> void setParamVisibility(Enum<E> param,
                                            boolean visible)

Setup visibility property for specified parameter.

Parameters:

param - one of IOhlcChartObject.CandleInfoParams, IOhlcChartObject.TickInfoParams or IOhlcChartObject.PriceAgregatedInfoParams

Throws:

NullPointerException - in case of unsupported parameter type.

getShowIndicatorInfo

boolean getShowIndicatorInfo()

Returns whether indicator values are displaying or not.

Returns:

setShowIndicatorInfo

void setShowIndicatorInfo(boolean showIndicatorInfo)

Sets property allowing to show indicator values.

Parameters:

showIndicatorInfo -

getPosX

float getPosX()

Returns current position of OHLC Informer left border on chart.

Returns:

value 0.0f - 1.0f

setPosX

void setPosX(float value)

Sets position of OHLC Informer left border on chart.

Parameters:

value - range: 0.0f - 1.0f

getPosY

float getPosY()

Returns current position of OHLC Informer upper border on chart. In proportion from top to bottom.

Returns:

value 0.0f - 1.0f

setPosY

void setPosY(float value)

Sets position of OHLC Informer upper border on chart. In proportion from top to bottom.

Parameters:

value - range: 0.0f - 1.0f

getSize

Dimension getSize()

Returns current size of OHLC Informer chart object

setPreferredSize

void setPreferredSize(Dimension dimension)

Sets preferred size for OHLC Informer chart object. It could be adjusted automatically to display all values correctly.

Parameters:

dimension -

clearUserMessages

void clearUserMessages()

Clears all user's custom messages.

addUserMessage

void addUserMessage(String label,
                    String value,
                    Color color)

Adds user message.

Parameters:

label - displaying at the left

value - displaying at the right

color - text color

addUserMessage

void addUserMessage(String message,
                    Color color,
                    int textAlignment,
                    boolean bold)

Adds user message.

Parameters:

message -

color - text color

textAlignment - One of SwingConstants.CENTER, SwingConstants.LEFT or SwingConstants.RIGHT. Any other value will be replaced with SwingConstants.LEFT by default.

bold -