com.dukascopy.api.indicators
Interface IIndicatorChartPanel


public interface IIndicatorChartPanel

A container for graphical objects created by the indicator.


Method Summary
 void add(IChartObject chartObject)
          Adds the object of type IChartObject to the current panel.
 IChartObject get(java.lang.String chartObjectKey)
          Returns the instance of IChartObject created by the indicator by key.
 java.util.List<IChartObject> getAll()
          Returns all graphical objects created by the indicator.
 IChartObjectFactory getChartObjectFactory()
          Returns the instance of IChartObjectFactory.
 double getMaxPrice()
          Returns the maximum value of the price scale.
 long getMaxTime()
          Returns the maximum time scale value.
 double getMinPrice()
          Returns the minimum value of the price scale.
 long getMinTime()
          Returns the minimum time scale value.
 void remove(IChartObject chartObject)
          Removes the specified graphical object from this panel.
 java.util.List<IChartObject> removeAll()
          Removes all graphical objects created by the indicator.
 

Method Detail

add

void add(IChartObject chartObject)
Adds the object of type IChartObject to the current panel. The object is locked by default. Note that only one object instance can be added per chart.

Parameters:
chartObject - - instance of IChartObject super type.
Throws:
java.lang.IllegalArgumentException - - if object is already present on chart.

remove

void remove(IChartObject chartObject)
Removes the specified graphical object from this panel.

Parameters:
chartObject - - graphical object to remove.

removeAll

java.util.List<IChartObject> removeAll()
Removes all graphical objects created by the indicator.

Returns:
the list of graphical objects to be removed.

getChartObjectFactory

IChartObjectFactory getChartObjectFactory()
Returns the instance of IChartObjectFactory.

Returns:
instance of IChartObjectFactory.

get

IChartObject get(java.lang.String chartObjectKey)
Returns the instance of IChartObject created by the indicator by key.

Parameters:
chartObjectKey - the unique chart object key.
Returns:
instance of IChartObject or null if the object with the specified key was not found or the object was not created by the indicator.

getAll

java.util.List<IChartObject> getAll()
Returns all graphical objects created by the indicator.

Returns:
list of all graphical objects created by the indicator.

getMinTime

long getMinTime()
Returns the minimum time scale value.

Returns:
minimum time scale value

getMaxTime

long getMaxTime()
Returns the maximum time scale value.

Returns:
maximum time scale value

getMinPrice

double getMinPrice()
Returns the minimum value of the price scale.

Returns:
minimum value of the price scale.

getMaxPrice

double getMaxPrice()
Returns the maximum value of the price scale.

Returns:
maximum value of the price scale.