com.dukascopy.api.drawings
Interface IOhlcChartObject

All Superinterfaces:
IChartDependentChartObject, IChartObject, IFillableChartObject, IWidgetChartObject
public interface IOhlcChartObject
extends IWidgetChartObject

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 java.lang.String PROPERTY_OHLC_ALIGNMENT
          String constant to be used in PropertyChangeListener
static java.lang.String PROPERTY_OHLC_PARAM_VISIBILITY
          String constant to be used in PropertyChangeListener
static java.lang.String PROPERTY_OHLC_POSY
          String constant to be used in PropertyChangeListener
static java.lang.String PROPERTY_OHLC_POSX
          String constant to be used in PropertyChangeListener
static java.lang.String PROPERTY_OHLC_SHOW_INDICATOR_INFO
          String constant to be used in PropertyChangeListener
 
Fields inherited from interface com.dukascopy.api.drawings.IWidgetChartObject
PROPERTY_WIDGET_POSY, PROPERTY_WIDGET_POSX
 
Fields inherited from interface com.dukascopy.api.drawings.IFillableChartObject
PROPERTY_BACKGROUND_COLOR, PROPERTY_BACKGROUND_OPACITY
 
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(java.lang.String message, java.awt.Color color, int textAlignment, boolean bold)
          Adds user message.
 void addUserMessage(java.lang.String label, java.lang.String value, java.awt.Color color)
          Adds user message.
 void clearUserMessages()
          Clears all user's custom messages.
 IOhlcChartObject.OhlcAlignment getAlignment()
          Returns current alignment mode.
 java.lang.Enum<?>[] getAllInfoParamsByDataType(DataType dataType)
          Returns all InfoParams values for specified DataType
<E extends java.lang.Enum<E>>
boolean
getParamVisibility(java.lang.Enum<E> param)
          Returns whether parameter is displaying in current OHLC Informer or not.
 boolean getShowIndicatorInfo()
          Returns whether indicator values are displaying or not.
 void setAlignment(IOhlcChartObject.OhlcAlignment alignment)
          Sets OhlcAlignment mode for this OHLC Informer.
<E extends java.lang.Enum<E>>
void
setParamVisibility(java.lang.Enum<E> param, boolean visible)
          Setup visibility property for specified parameter.
 void setShowIndicatorInfo(boolean showIndicatorInfo)
          Sets property allowing to show indicator values.
 
Methods inherited from interface com.dukascopy.api.drawings.IWidgetChartObject
getFont, getPosY, getPosX, getSize, isHeaderVisible, setFont, setHeaderVisible, setPosY, setPosX, setPreferredSize
 
Methods inherited from interface com.dukascopy.api.drawings.IFillableChartObject
getFillColor, getFillOpacity, setFillColor, setFillOpacity
 
Methods inherited from interface com.dukascopy.api.drawings.IChartDependentChartObject
isStickToCandleTimeEnabled, move, setPrice, setStickToCandleTimeEnabled, setTime
 
Methods inherited from interface com.dukascopy.api.IChartObject
addPropertyChangeListener, getAttrBoolean, getAttrColor, getAttrDouble, getAttrInt, getAttrLong, getAttrText, getColor, getKey, getLineWidth, getOpacity, getPointsCount, getPrice, getPropertyChangeListeners, getStroke, getText, getTextTruncation, getTime, getType, isLabelEnabled, isLocked, isMenuEnabled, isSticky, isVisibleInWorkspaceTree, removePropertyChangeListener, setAttrBoolean, setAttrColor, setAttrDouble, setAttrInt, setAttrLong, setAttrText, setChartObjectListener, setColor, setLineStyle, setLineWidth, setLocked, setMenuEnabled, setOpacity, setSticky, setStroke, setText, setText, setText, setText, setTextTruncation, setTooltip, setVisibleInWorkspaceTree
 

Field Detail

PROPERTY_OHLC_ALIGNMENT

static final java.lang.String PROPERTY_OHLC_ALIGNMENT
String constant to be used in PropertyChangeListener

See Also:
Constant Field Values

PROPERTY_OHLC_PARAM_VISIBILITY

static final java.lang.String PROPERTY_OHLC_PARAM_VISIBILITY
String constant to be used in PropertyChangeListener

See Also:
Constant Field Values

PROPERTY_OHLC_POSX

static final java.lang.String PROPERTY_OHLC_POSX
String constant to be used in PropertyChangeListener

See Also:
Constant Field Values

PROPERTY_OHLC_POSY

static final java.lang.String PROPERTY_OHLC_POSY
String constant to be used in PropertyChangeListener

See Also:
Constant Field Values

PROPERTY_OHLC_SHOW_INDICATOR_INFO

static final java.lang.String PROPERTY_OHLC_SHOW_INDICATOR_INFO
String constant to be used in PropertyChangeListener

See Also:
Constant Field Values
Method Detail

getAllInfoParamsByDataType

java.lang.Enum<?>[] getAllInfoParamsByDataType(DataType dataType)
Returns all InfoParams values for specified DataType

Parameters:
dataType - one of DataType values
Returns:
Enum[]

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 java.lang.Enum<E>> boolean getParamVisibility(java.lang.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:
java.lang.NullPointerException - in case of unsupported parameter type.

setParamVisibility

<E extends java.lang.Enum<E>> void setParamVisibility(java.lang.Enum<E> param,
                                                      boolean visible)
Setup visibility property for specified parameter.

Parameters:
param - one of IOhlcChartObject.CandleInfoParams, IOhlcChartObject.TickInfoParams or IOhlcChartObject.PriceAgregatedInfoParams
Throws:
java.lang.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. Default value: true

Parameters:
showIndicatorInfo -

clearUserMessages

void clearUserMessages()
Clears all user's custom messages.

addUserMessage

void addUserMessage(java.lang.String label,
                    java.lang.String value,
                    java.awt.Color color)
Adds user message.

Parameters:
label - displaying at the left
value - displaying at the right
color - text color

addUserMessage

void addUserMessage(java.lang.String message,
                    java.awt.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 -