org.eclipse.birt.chart.ui.swt.interfaces
Interface IChartType

public interface IChartType

IChartType

Field Summary

static java.lang.String	THREE_DIMENSION_TYPE Type constant of 3D.
static java.lang.String	TWO_DIMENSION_TYPE Type constant of 2D.
static java.lang.String	TWO_DIMENSION_WITH_DEPTH_TYPE Type constant of 2D with depth.

Method Summary

boolean	canAdapt(Chart cModel, java.util.Hashtable htModelHints) Returns whether this type implementation can process the specified model.
ISelectDataComponent	getBaseUI(Chart chart, ISelectDataCustomizeUI selectDataUI, org.eclipse.birt.chart.ui.swt.wizard.ChartWizardContext context, java.lang.String sTitle) Returns base UI in data sheet
java.util.Collection	getChartSubtypes(java.lang.String Dimension, Orientation orientation) Returns the names of the chart sub-types available for this type.
java.lang.String	getDefaultDimension() Returns the default dimension of this chart type.
java.lang.String	getDisplayName() Returns the display name of the chart type.
IHelpContent	getHelp() Returns the help information.
Image	getImage() Returns the image icon of the chart type.
Chart	getModel(java.lang.String sType, Orientation Orientation, java.lang.String Dimension, Chart currentChart) Returns the Chart model for given parameters.
java.lang.String	getName() Returns the name of the chart type.
java.lang.String[]	getSupportedDimensions() Returns the dimension array this chart type supports.
boolean	isDimensionSupported(java.lang.String dimensionType, int nbOfAxes, int nbOfSeries) Checks whether the dimension is valid with specified number of axes or series.
boolean	supportsTransposition() Returns if this chart type supports transposition.
boolean	supportsTransposition(java.lang.String dimension) Returns if this chart type supports transposition for given dimension.

Field Detail

TWO_DIMENSION_TYPE

public static final java.lang.String TWO_DIMENSION_TYPE

Type constant of 2D.

TWO_DIMENSION_WITH_DEPTH_TYPE

public static final java.lang.String TWO_DIMENSION_WITH_DEPTH_TYPE

Type constant of 2D with depth.

THREE_DIMENSION_TYPE

public static final java.lang.String THREE_DIMENSION_TYPE

Type constant of 3D.

Method Detail

getName

public java.lang.String getName()

Returns the name of the chart type.

Returns:

Chart type name.

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the chart type. This is what appears in the selection list in the Chart Selector UI.

Returns:

Chart type display name.

Since:

Version 2.1

getImage

public Image getImage()

Returns the image icon of the chart type. This is what appears in the selection list in the Chart Selector UI.

Returns:

Chart image icon.

getChartSubtypes

public java.util.Collection getChartSubtypes(java.lang.String Dimension,
                                             Orientation orientation)

Returns the names of the chart sub-types available for this type. These names are used to build the sub-type selection panel in the Chart Selector UI.

Returns:

Array of sub-type names.

canAdapt

public boolean canAdapt(Chart cModel,
                        java.util.Hashtable htModelHints)

Returns whether this type implementation can process the specified model. The first instance that returns true will be considered as the correct chart type. If all types return false, the chart type and subtype from the model will be used.

Parameters:

cModel - chart model representing an existing chart

htModelHints - pre-computed 'hints' from the model to reduce computations needed to be performed by each implementation.

Returns:

true if this chart type can adapt the specified model to its own type. false if it cannot.

getModel

public Chart getModel(java.lang.String sType,
                      Orientation Orientation,
                      java.lang.String Dimension,
                      Chart currentChart)

Returns the Chart model for given parameters.

Parameters:

sType -

Orientation -

Dimension -

currentChart -

getSupportedDimensions

public java.lang.String[] getSupportedDimensions()

Returns the dimension array this chart type supports.

getDefaultDimension

public java.lang.String getDefaultDimension()

Returns the default dimension of this chart type.

supportsTransposition

public boolean supportsTransposition()

Returns if this chart type supports transposition.

supportsTransposition

public boolean supportsTransposition(java.lang.String dimension)

Returns if this chart type supports transposition for given dimension.

Since:

2.0

getHelp

public IHelpContent getHelp()

Returns the help information.

getBaseUI

public ISelectDataComponent getBaseUI(Chart chart,
                                      ISelectDataCustomizeUI selectDataUI,
                                      org.eclipse.birt.chart.ui.swt.wizard.ChartWizardContext context,
                                      java.lang.String sTitle)

Returns base UI in data sheet

Parameters:

chart -

selectDataUI -

context -

sTitle -

Returns:

UI componnet

Since:

2.0

isDimensionSupported

public boolean isDimensionSupported(java.lang.String dimensionType,
                                    int nbOfAxes,
                                    int nbOfSeries)

Checks whether the dimension is valid with specified number of axes or series.

Parameters:

dimensionType - dimension type

nbOfAxes - number of axes

nbOfSeries - number of series

Returns:

dimension is valid or invalid

Since:

2.1