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
 void addLevel(java.lang.String label, java.lang.Double value, java.awt.Color color)
          Adds new level to object levels.
 java.awt.Color getLevelColor(int index)
          Returns level color by specified index.
 java.lang.String getLevelLabel(int index)
          Returns level label text by specified index.
 int getLevelsCount()
          Returns number of levels
 java.lang.Double getLevelValue(int index)
          Returns level value by specified index.
 void removeLevel(int index)
          Removes level by specified index.
 void setLevelColor(int index, java.awt.Color color)
          Sets color to level, specified by index.
 void setLevelLabel(int index, java.lang.String label)
          Sets label text to level, specified by index.
 void setLevelValue(int index, java.lang.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, 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
 

Method Detail

getLevelLabel

java.lang.String getLevelLabel(int index)
Returns level label text by specified index.

Parameters:
index - - level index.
Returns:
level label text.
Throws:
java.lang.IllegalArgumentException - - if level index is out of bounds.

setLevelLabel

void setLevelLabel(int index,
                   java.lang.String label)
Sets label text to level, specified by index.

Parameters:
index - - level index.
label - - text to set.
Throws:
java.lang.IllegalArgumentException - - if level index is out of bounds.

getLevelValue

java.lang.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:
java.lang.IllegalArgumentException - - if level index is out of bounds.

setLevelValue

void setLevelValue(int index,
                   java.lang.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:
java.lang.IllegalArgumentException - - if level index is out of bounds.

getLevelColor

java.awt.Color getLevelColor(int index)
Returns level color by specified index.

Parameters:
index - - level index.
Returns:
level color.
Throws:
java.lang.IllegalArgumentException - - if level index is out of bounds.

setLevelColor

void setLevelColor(int index,
                   java.awt.Color color)
Sets color to level, specified by index.

Parameters:
index - - level index.
color - - color to set.
Throws:
java.lang.IllegalArgumentException - - if level index is out of bounds.

addLevel

void addLevel(java.lang.String label,
              java.lang.Double value,
              java.awt.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:
java.lang.IllegalArgumentException - - if index is out of bounds.

getLevelsCount

int getLevelsCount()
Returns number of levels

Returns:
number of levels