com.dukascopy.api.drawings

Interface ILeveledChartObject

All Superinterfaces:

IChartDependentChartObject, IChartObject, IFillableChartObject

All Known Subinterfaces:

IAndrewsPitchforkChartObject, IChannelChartObject, IFiboArcChartObject, IFiboChannelChartObject, IFiboCirclesChartObject, IFiboExpansionChartObject, IFiboFanChartObject, IFiboRetracementChartObject, IFiboTimeZonesChartObject, IFiboTimeZonesPercentsChartObject, IModifiedSchiffPitchforkChartObject, IPercentChartObject, ISchiffPitchforkChartObject

public interface ILeveledChartObject
extends IFillableChartObject

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILeveledChartObject.LevelsDisplayOption

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.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

Modifier and Type	Method and Description
void	addLevel(java.lang.String label, java.lang.Double value, java.awt.Color color) Adds new level to object levels.
void	addLevel(java.lang.String label, java.lang.Double value, java.awt.Color color, java.awt.Color fillColor) Adds new level to object levels.
boolean	areLevelsShown() Returns show levels option.
java.awt.Color	getLevelColor(int index) Returns level color by specified index.
java.awt.Color	getLevelFillColor(int index) Returns level fill color by specified index.
java.lang.String	getLevelLabel(int index) Returns level label text by specified index.
int	getLevelsCount() Returns number of levels.
boolean	getLevelsDisplayOption(ILeveledChartObject.LevelsDisplayOption option) Returns levels display option.
java.lang.Double	getLevelValue(int index) Returns level value by specified index.
boolean	isLevelsDisplayOptionSupported(ILeveledChartObject.LevelsDisplayOption option) Returns levels display option support status.
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	setLevelFillColor(int index, java.awt.Color fillColor) Sets fill color to level, specified by index.
void	setLevelLabel(int index, java.lang.String label) Sets label text to level, specified by index.
void	setLevelsDisplayOption(ILeveledChartObject.LevelsDisplayOption option, boolean show) Sets levels display option.
void	setLevelValue(int index, java.lang.Double value) Sets value to level, specified by index.
void	setShowLevels(boolean showLevels) Sets show levels option.

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

getFillColor, getFillOpacity, setFillColor, setFillOpacity

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

isStickToCandlePriceEnabled, isStickToCandleTimeEnabled, move, setPrice, setStickToCandlePriceEnabled, setStickToCandleTimeEnabled, setTime

Methods inherited from interface com.dukascopy.api.IChartObject

addPropertyChangeListener, clone, getAttrBoolean, getAttrColor, getAttrDouble, getAttrInt, getAttrLong, getAttrText, getColor, getFinancialInstrument, getInstrument, getKey, getLineStyle, getLineWidth, getOpacity, getPointsCount, getPrice, getPropertyChangeListeners, getStroke, getText, getTextTruncation, getTime, getType, isLabelEnabled, isLabelShown, isLocked, isMenuEnabled, isSticky, isVisibleInWorkspaceTree, removePropertyChangeListener, setAttrBoolean, setAttrColor, setAttrDouble, setAttrInt, setAttrLong, setAttrText, setChartObjectListener, setColor, setFinancialInstrument, setInstrument, setLineStyle, setLineWidth, setLocked, setMenuEnabled, setOpacity, setShowLabel, 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

getLevelFillColor

java.awt.Color getLevelFillColor(int index)

Returns level fill color by specified index.

Parameters:

index - level index

Returns:

level fill color

Throws:

java.lang.IllegalArgumentException - if level index is out of bounds

setLevelFillColor

void setLevelFillColor(int index,
                       java.awt.Color fillColor)

Sets fill color to level, specified by index.

Parameters:

index - level index

fillColor - fill 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

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

color - level color

addLevel

void addLevel(java.lang.String label,
              java.lang.Double value,
              java.awt.Color color,
              java.awt.Color fillColor)

Adds new level to object levels.

Parameters:

label - level label text

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

color - level color

fillColor - level fill color

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

setShowLevels

void setShowLevels(boolean showLevels)

Sets show levels option. System default value: true

Parameters:

showLevels - show levels option

areLevelsShown

boolean areLevelsShown()

Returns show levels option. System default value: true

Returns:

show levels option

setLevelsDisplayOption

void setLevelsDisplayOption(ILeveledChartObject.LevelsDisplayOption option,
                            boolean show)

Sets levels display option. System default value: true

Parameters:

option - levels display option

show - option value

getLevelsDisplayOption

boolean getLevelsDisplayOption(ILeveledChartObject.LevelsDisplayOption option)

Returns levels display option. System default value: true

Parameters:

option - levels display option

Returns:

option value

isLevelsDisplayOptionSupported

boolean isLevelsDisplayOptionSupported(ILeveledChartObject.LevelsDisplayOption option)

Returns levels display option support status.

Parameters:

option - levels display option

Returns:

option support status