com.dukascopy.api

Interface IClientChartPresentationManager

public interface IClientChartPresentationManager

Manages Chart presentation modes (Period, DataType, etc.).
NOTE: Used only by Standalone JForex API.

Author:

aburenin

See Also:

IChart, IClientGUI

Method Summary

Methods

Modifier and Type	Method and Description
DataType.DataPresentationType	getDataPresentationType() Returns charts' current DataType.DataPresentationType.
IFeedDescriptor	getFeedDescriptor() Returns chart state described by bean IFeedDescriptor
Filter	getFilter()
IChartTheme	getPredefinedTheme(IChartTheme.Predefined predefinedTheme) Gets a copy of a predefined chart theme
IChartTheme	getTheme() Returns current chart theme.
boolean	isChartAutoShift() returns true if chart Auto Shift is activated
void	setChartAutoShift() Activates chart Auto Shift
void	setDataPresentationType(DataType.DataPresentationType dataPresentationType) Applies DataPresentationType to current chart.
void	setFeedDescriptor(IFeedDescriptor feedDescriptor) Changes bundle of chart's feed data properties at once. The Filter value of the IFeedDescriptor is set globally and propagated to all open charts.
void	setFilter(Filter filter) Sets the Filter globally which will be propagated to all open charts.
void	setInstrument(Instrument instrument) Changes current Instrument to specified one
void	setTheme(IChartTheme chartTheme) Sets chart theme
void	switchOfferSide(OfferSide offerSide) Switches OfferSide
void	zoomIn() Zooms in chart
void	zoomOut() Zooms out chart

Method Detail

setFeedDescriptor

void setFeedDescriptor(IFeedDescriptor feedDescriptor)

Changes bundle of chart's feed data properties at once.
The Filter value of the IFeedDescriptor is set globally and propagated to all open charts.

Parameters:

feedDescriptor - - see IFeedDescriptor

See Also:

setFilter(Filter), getFilter(), setInstrument(Instrument), switchOfferSide(OfferSide)

getFeedDescriptor

IFeedDescriptor getFeedDescriptor()

Returns chart state described by bean IFeedDescriptor

Returns:

chart state described by bean IFeedDescriptor

setChartAutoShift

void setChartAutoShift()

Activates chart Auto Shift

isChartAutoShift

boolean isChartAutoShift()

returns true if chart Auto Shift is activated

Returns:

true if chart Auto Shift is activated

zoomIn

void zoomIn()

Zooms in chart

zoomOut

void zoomOut()

Zooms out chart

setInstrument

void setInstrument(Instrument instrument)

Changes current Instrument to specified one

Parameters:

instrument - new active Instrument

setDataPresentationType

void setDataPresentationType(DataType.DataPresentationType dataPresentationType)

Applies DataPresentationType to current chart. Use IChart.getDataType().getSupportedPresentationTypes() to get all allowed values. Use IChart.getDataType().isPresentationTypeSupported(DataPresentationType presentationType) to check whether current DataType supports presentationType or not.

Parameters:

dataPresentationType - one of DataPresentationType constants, supported by current DataType

Throws:

IllegalArgumentException - if DataPresentationType is not supported by current DataType

See Also:

IChart.setDataPresentationType(com.dukascopy.api.DataType.DataPresentationType), IChart.getDataType()

getDataPresentationType

DataType.DataPresentationType getDataPresentationType()

Returns charts' current DataType.DataPresentationType. Depends on current DataType value

See Also:

IChart.getDataPresentationType(), IChart.getDataType()

switchOfferSide

void switchOfferSide(OfferSide offerSide)

Switches OfferSide

Parameters:

offerSide - new offer side

setFilter

void setFilter(Filter filter)

Sets the Filter globally which will be propagated to all open charts.

Parameters:

filter - Filter to filter flats data

getFilter

Filter getFilter()

Returns:

the Filter which is shared by all ICharts

getTheme

IChartTheme getTheme()

Returns current chart theme. If the theme is among IChartTheme.Predefined, then a copy of the theme gets returned

Returns:

the current chart theme

setTheme

void setTheme(IChartTheme chartTheme)

Sets chart theme

Parameters:

chartTheme - theme to set

getPredefinedTheme

IChartTheme getPredefinedTheme(IChartTheme.Predefined predefinedTheme)

Gets a copy of a predefined chart theme

Parameters:

predefinedTheme - theme enumeration

Returns:

a copy of a predefined chart theme