com.dukascopy.api

Interface IIndicatorPanel

All Superinterfaces:

IChartPanel

public interface IIndicatorPanel
extends IChartPanel

Author:

Aleksandrs.Leiferovs

Method Summary

Modifier and Type	Method and Description
void	add(IChartObject chartObject) Adds object of IChartObject type to current panel.
IChartPanel	add(IIndicator indicator) Adds indicator to the current panel.
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams) Adds indicator to the current panel by specifying initial optional parameters values If optParams equals to null - default ones will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, java.awt.Color[] outputColors, OutputParameterInfo.DrawingStyle[] outputDrawingStyles, int[] outputWidths) Adds indicator to the current panel by specifying initial optional parameters values, curves colors, drawing styles and line widths If optParams equals to null - default ones will be taken instead If output params are nulls - default ones will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Instrument instrument, Period period, OfferSide offerSide) Adds indicator to the current panel by specifying initial optional parameters values and indicator advanced settings If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Instrument instrument, Period period, OfferSide offerSide, OfferSide[] offerSides, IIndicators.AppliedPrice[] appliedPrices, java.awt.Color[] outputColors, OutputParameterInfo.DrawingStyle[] outputDrawingStyles, int[] outputWidths) Adds indicator to the current panel by specifying initial optional parameters values, indicator advanced settings, data sides/types for each input, output params If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead If offerSides or appliedPrices equals to null - default ones will be taken instead If output params are nulls - default ones will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Instrument instrument, Period period, OfferSide offerSide, Period basePeriod) Adds indicator to the current panel by specifying initial optional parameters values and indicator advanced settings If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead If basePeriod equals to null - no base period will be used
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Instrument instrument, Period period, OfferSide offerSide, Period basePeriod, OfferSide[] offerSides, IIndicators.AppliedPrice[] appliedPrices, java.awt.Color[] outputColors, OutputParameterInfo.DrawingStyle[] outputDrawingStyles, int[] outputWidths) Adds indicator to the current panel by specifying initial optional parameters values, indicator advanced settings, data sides/types for each input, output params If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead If basePeriod equals to null - no base period will be used If offerSides or appliedPrices equals to null - default ones will be taken instead If output params are nulls - default ones will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, OfferSide[] offerSides, IIndicators.AppliedPrice[] appliedPrices) Adds indicator to the current panel by specifying initial optional parameters values and data sides/types for each input If optParams equals to null - default ones will be taken instead If offerSides or appliedPrices equals to null - default ones will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Period basePeriod) Adds indicator to the current panel by specifying initial optional parameters values If optParams equals to null - default ones will be taken instead If basePeriod equals to null - no base period will be used
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Period basePeriod, java.awt.Color[] outputColors, OutputParameterInfo.DrawingStyle[] outputDrawingStyles, int[] outputWidths) Adds indicator to the current panel by specifying initial optional parameters values, curves colors, drawing styles and line widths If optParams equals to null - default ones will be taken instead If basePeriod equals to null - no base period will be used If output params are nulls - default ones will be taken instead
IChartPanel	add(IIndicator indicator, java.lang.Object[] optParams, Period basePeriod, OfferSide[] offerSides, IIndicators.AppliedPrice[] appliedPrices) Adds indicator to the current panel by specifying initial optional parameters values and data sides/types for each input If optParams equals to null - default ones will be taken instead If basePeriod equals to null - no base period will be used If offerSides or appliedPrices equals to null - default ones will be taken instead
void	addMouseListener(boolean asynchronous, IChartPanelMouseListener chartMouseListener) Adds the specified mouse listener to receive mouse events from this chart panel.
IChartObject	get(java.lang.String chartObjectKey) Returns IChartObject instance by key if any exist on this panel.
java.util.List<IChartObject>	getAll() Returns all graphical objects on this panel.
java.util.List<IIndicatorAppearanceInfo>	getIndicatorApperanceInfos() Returns indicator appearance information on the chart panel
java.util.List<IIndicator>	getIndicators() Returns all indicators on the chart panel.
double	getMaxPrice() Returns maximal value of base indicator placed on this panel
double	getMinPrice() Returns minimal value of base indicator placed on this panel
java.util.List<IChartPanelMouseListener>	getMouseListeners() Returns an array of all the mouse listeners registered on this component.
boolean	isActive() Indicates this panel visibility on chart.
void	remove(IChartObject chartObject) Deletes specified graphical object from this panel.
IChartObject	remove(java.lang.String chartObjectKey) Deletes graphical object from this panel by key.
void	removeAll() Removes all graphical objects from this panel.
void	removeIndicator(IIndicator indicator) Remove specified indicator from this panel.
void	removeMouseListener(IChartPanelMouseListener chartMouseListener) Removes the specified mouse listener so that it no longer receives mouse events from this component.

Methods inherited from interface com.dukascopy.api.IChartPanel

add, add

Method Detail

add

void add(IChartObject chartObject)

Adds object of IChartObject type to current panel. Please note that only one instance of object can be added per chart.
Note: global chart objects (e.g. Time Marker) are not allowed on IIndicatorPanel and will cause IllegalArgumentException

Specified by:

add in interface IChartPanel

Parameters:

chartObject - - instance of IChartObject super type.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

remove

void remove(IChartObject chartObject)

Deletes specified graphical object from this panel.

Specified by:

remove in interface IChartPanel

Parameters:

chartObject - object to remove

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

remove

IChartObject remove(java.lang.String chartObjectKey)

Deletes graphical object from this panel by key.

Specified by:

remove in interface IChartPanel

Parameters:

chartObjectKey - key of object to remove

Returns:

deleted chart object or null if specified key was not found

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

removeAll

void removeAll()

Removes all graphical objects from this panel.

Specified by:

removeAll in interface IChartPanel

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

get

IChartObject get(java.lang.String chartObjectKey)

Returns IChartObject instance by key if any exist on this panel.

Specified by:

get in interface IChartPanel

Parameters:

chartObjectKey - unique id

Returns:

IChartObject or null if no object was found by specified key

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

getAll

java.util.List<IChartObject> getAll()

Returns all graphical objects on this panel.

Specified by:

getAll in interface IChartPanel

Returns:

list of all graphical objects on the chart

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator)

Adds indicator to the current panel.

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams)

Adds indicator to the current panel by specifying initial optional parameters values If optParams equals to null - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Period basePeriod)

Adds indicator to the current panel by specifying initial optional parameters values If optParams equals to null - default ones will be taken instead If basePeriod equals to null - no base period will be used

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

basePeriod - base period for unstable period indicators

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Instrument instrument,
                Period period,
                OfferSide offerSide)

Adds indicator to the current panel by specifying initial optional parameters values and indicator advanced settings If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

instrument - as Instrument

period - as Period

offerSide - as OfferSide

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Instrument instrument,
                Period period,
                OfferSide offerSide,
                Period basePeriod)

Adds indicator to the current panel by specifying initial optional parameters values and indicator advanced settings If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead If basePeriod equals to null - no base period will be used

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

instrument - as Instrument

period - as Period

offerSide - as OfferSide

basePeriod - base period for unstable period indicators

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                OfferSide[] offerSides,
                IIndicators.AppliedPrice[] appliedPrices)

Adds indicator to the current panel by specifying initial optional parameters values and data sides/types for each input If optParams equals to null - default ones will be taken instead If offerSides or appliedPrices equals to null - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

offerSides - as OfferSide[]

appliedPrices - as AppliedPrice[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Period basePeriod,
                OfferSide[] offerSides,
                IIndicators.AppliedPrice[] appliedPrices)

Adds indicator to the current panel by specifying initial optional parameters values and data sides/types for each input If optParams equals to null - default ones will be taken instead If basePeriod equals to null - no base period will be used If offerSides or appliedPrices equals to null - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

basePeriod - base period for unstable period indicators

offerSides - as OfferSide[]

appliedPrices - as AppliedPrice[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                java.awt.Color[] outputColors,
                OutputParameterInfo.DrawingStyle[] outputDrawingStyles,
                int[] outputWidths)

Adds indicator to the current panel by specifying initial optional parameters values, curves colors, drawing styles and line widths If optParams equals to null - default ones will be taken instead If output params are nulls - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

outputColors - as Color[]

outputDrawingStyles - as DrawingStyle[]

outputWidths - as int[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Period basePeriod,
                java.awt.Color[] outputColors,
                OutputParameterInfo.DrawingStyle[] outputDrawingStyles,
                int[] outputWidths)

Adds indicator to the current panel by specifying initial optional parameters values, curves colors, drawing styles and line widths If optParams equals to null - default ones will be taken instead If basePeriod equals to null - no base period will be used If output params are nulls - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

basePeriod - base period for unstable period indicators

outputColors - as Color[]

outputDrawingStyles - as DrawingStyle[]

outputWidths - as int[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Instrument instrument,
                Period period,
                OfferSide offerSide,
                OfferSide[] offerSides,
                IIndicators.AppliedPrice[] appliedPrices,
                java.awt.Color[] outputColors,
                OutputParameterInfo.DrawingStyle[] outputDrawingStyles,
                int[] outputWidths)

Adds indicator to the current panel by specifying initial optional parameters values, indicator advanced settings, data sides/types for each input, output params If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead If offerSides or appliedPrices equals to null - default ones will be taken instead If output params are nulls - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

instrument - as Instrument

period - as Period

offerSide - as OfferSide

offerSides - as OfferSide[]

appliedPrices - as AppliedPrice[]

outputColors - as Color[]

outputDrawingStyles - as DrawingStyle[]

outputWidths - as int[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

add

IChartPanel add(IIndicator indicator,
                java.lang.Object[] optParams,
                Instrument instrument,
                Period period,
                OfferSide offerSide,
                Period basePeriod,
                OfferSide[] offerSides,
                IIndicators.AppliedPrice[] appliedPrices,
                java.awt.Color[] outputColors,
                OutputParameterInfo.DrawingStyle[] outputDrawingStyles,
                int[] outputWidths)

Adds indicator to the current panel by specifying initial optional parameters values, indicator advanced settings, data sides/types for each input, output params If optParams equals to null - default ones will be taken instead If instrument, period or offerSide equals to null - values from chart will be taken instead If basePeriod equals to null - no base period will be used If offerSides or appliedPrices equals to null - default ones will be taken instead If output params are nulls - default ones will be taken instead

Specified by:

add in interface IChartPanel

Parameters:

indicator - as IIndicator

optParams - as Object[]

instrument - as Instrument

period - as Period

offerSide - as OfferSide

basePeriod - base period for unstable period indicators

offerSides - as OfferSide[]

appliedPrices - as AppliedPrice[]

outputColors - as Color[]

outputDrawingStyles - as DrawingStyle[]

outputWidths - as int[]

Returns:

IChartPanel instance where indicator is put on.

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

removeIndicator

void removeIndicator(IIndicator indicator)

Remove specified indicator from this panel.

Specified by:

removeIndicator in interface IChartPanel

Parameters:

indicator - instance of IIndicator interface

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

getIndicators

java.util.List<IIndicator> getIndicators()

Returns all indicators on the chart panel.
Returns only indicators applied to current panel.

Specified by:

getIndicators in interface IChartPanel

Returns:

list of indicators

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

getIndicatorApperanceInfos

java.util.List<IIndicatorAppearanceInfo> getIndicatorApperanceInfos()

Returns indicator appearance information on the chart panel
Returns only indicators applied to current panel.

Specified by:

getIndicatorApperanceInfos in interface IChartPanel

Returns:

indicator appearance information on the chart panel

getMinPrice

double getMinPrice()

Returns minimal value of base indicator placed on this panel

Specified by:

getMinPrice in interface IChartPanel

Returns:

minimal value of the vertical scale

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

getMaxPrice

double getMaxPrice()

Returns maximal value of base indicator placed on this panel

Specified by:

getMaxPrice in interface IChartPanel

Returns:

maximal value of the vertical scale

Throws:

java.lang.IllegalStateException - if this panel is not visible isActive()

addMouseListener

void addMouseListener(boolean asynchronous,
                      IChartPanelMouseListener chartMouseListener)

Adds the specified mouse listener to receive mouse events from this chart panel. If chartMouseListener is null, no exception is thrown and no action is performed.

Specified by:

addMouseListener in interface IChartPanel

Parameters:

asynchronous - if true listener will be triggered in AWT thread asynchronously with strategy thread, otherwise will be synchronized. Use false as default if not sure.

chartMouseListener - the mouse listener

See Also:

IChartPanel.removeMouseListener(com.dukascopy.api.chart.mouse.IChartPanelMouseListener), IChartPanel.getMouseListeners()

removeMouseListener

void removeMouseListener(IChartPanelMouseListener chartMouseListener)

Removes the specified mouse listener so that it no longer receives mouse events from this component. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this component. If chartMouseListener is null, no exception is thrown and no action is performed.

Specified by:

removeMouseListener in interface IChartPanel

Parameters:

chartMouseListener - the mouse listener

See Also:

IChartPanel.addMouseListener(boolean, com.dukascopy.api.chart.mouse.IChartPanelMouseListener), IChartPanel.getMouseListeners()

getMouseListeners

java.util.List<IChartPanelMouseListener> getMouseListeners()

Returns an array of all the mouse listeners registered on this component.

Specified by:

getMouseListeners in interface IChartPanel

Returns:

all of this component's MouseListeners or an empty array if no mouse listeners are currently registered

See Also:

IChartPanel.addMouseListener(boolean, com.dukascopy.api.chart.mouse.IChartPanelMouseListener), IChartPanel.removeMouseListener(com.dukascopy.api.chart.mouse.IChartPanelMouseListener)

isActive

boolean isActive()

Indicates this panel visibility on chart.

Note:
- working with removed/invisible panel is not allowed.
- panel could be automatically removed with last indicator on it.

Returns:

true if visible, false if not