com.dukascopy.api.drawings

Interface ILeveledChartObject

All Superinterfaces:

IChartDependentChartObject, IChartObject

All Known Subinterfaces:

IAndrewsPitchforkChartObject, IFiboExpansionChartObject, IFiboFanChartObject, IFiboRetracementChartObject, IFiboTimeZonesChartObject, IPercentChartObject

public interface ILeveledChartObject
extends IChartDependentChartObject

Nested Class Summary

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

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

Methods

Modifier and Type	Method and Description
void	addLevel(String label, Double value, Color color) Adds new level to object levels.
Color	getLevelColor(int index) Returns level color by specified index.
String	getLevelLabel(int index) Returns level label text by specified index.
int	getLevelsCount() Returns number of levels
Double	getLevelValue(int index) Returns level value by specified index.
void	removeLevel(int index) Removes level by specified index.
void	setLevelColor(int index, Color color) Sets color to level, specified by index.
void	setLevelLabel(int index, String label) Sets label text to level, specified by index.
void	setLevelValue(int index, Double value) Sets value to level, specified by index.

Methods inherited from interface com.dukascopy.api.drawings.IChartDependentChartObject

isStickToCandleTimeEnabled, move, setPrice, setStickToCandleTimeEnabled, setTime

Methods inherited from interface com.dukascopy.api.IChartObject

addPropertyChangeListener, clone, getAttrBoolean, getAttrColor, getAttrDouble, getAttrInt, getAttrLong, getAttrText, getColor, getInstrument, getKey, getLineStyle, getLineWidth, getOpacity, getPointsCount, getPrice, getPropertyChangeListeners, getStroke, getText, getTextTruncation, getTime, getType, isLabelEnabled, isLocked, isMenuEnabled, isSticky, isVisibleInWorkspaceTree, removePropertyChangeListener, setAttrBoolean, setAttrColor, setAttrDouble, setAttrInt, setAttrLong, setAttrText, setChartObjectListener, setColor, setInstrument, setLineStyle, setLineWidth, setLocked, setMenuEnabled, setOpacity, setSticky, setStroke, setText, setText, setText, setText, setTextTruncation, setTooltip, setVisibleInWorkspaceTree

Method Detail

getLevelLabel

String getLevelLabel(int index)

Returns level label text by specified index.

Parameters:

index - - level index.

Returns:

level label text.

Throws:

IllegalArgumentException - - if level index is out of bounds.

setLevelLabel

void setLevelLabel(int index,
                 String label)

Sets label text to level, specified by index.

Parameters:

index - - level index.

label - - text to set.

Throws:

IllegalArgumentException - - if level index is out of bounds.

getLevelValue

Double getLevelValue(int index)

Returns level value by specified index.

Parameters:

index - - level index.

Returns:

level value coefficient. Coefficient 1.0 corresponds to the 100% level.

Throws:

IllegalArgumentException - - if level index is out of bounds.

setLevelValue

void setLevelValue(int index,
                 Double value)

Sets value to level, specified by index.

Parameters:

index - - level index.

value - - level value coefficient. Coefficient 1.0 corresponds to the 100% level.

Throws:

IllegalArgumentException - - if level index is out of bounds.

getLevelColor

Color getLevelColor(int index)

Returns level color by specified index.

Parameters:

index - - level index.

Returns:

level color.

Throws:

IllegalArgumentException - - if level index is out of bounds.

setLevelColor

void setLevelColor(int index,
                 Color color)

Sets color to level, specified by index.

Parameters:

index - - level index.

color - - color to set.

Throws:

IllegalArgumentException - - if level index is out of bounds.

addLevel

void addLevel(String label,
            Double value,
            Color color)

Adds new level to object levels.

Parameters:

label - - level label text.

color - - level color.

value - - level value coefficient. Coefficient 1.0 corresponds to the 100% level.

removeLevel

void removeLevel(int index)

Removes level by specified index.

Parameters:

index - - index of level to remove.

Throws:

IllegalArgumentException - - if index is out of bounds.

getLevelsCount

int getLevelsCount()

Returns number of levels

Returns:

number of levels