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


public interface ISeriesUIProvider

Author:
Actuate Corporation

Method Summary
 AxisType[] getCompatibleAxisType(Series series)
          Get the compatible axis type according to series type.
 org.eclipse.swt.widgets.Composite getSeriesAttributeSheet(org.eclipse.swt.widgets.Composite parent, Series series)
          Deprecated. use getSeriesAttributeSheet( Composite parent, Series series, IUIServiceProvider builder, Object oContext )
 org.eclipse.swt.widgets.Composite getSeriesAttributeSheet(org.eclipse.swt.widgets.Composite parent, Series series, org.eclipse.birt.chart.ui.swt.wizard.ChartWizardContext context)
          Fetches the composite used to set attribute properties for a series.
 java.lang.String getSeriesClass()
          Fetches the class of the series for which this class provides services
 ISelectDataComponent getSeriesDataComponent(int seriesType, SeriesDefinition seriesDefn, org.eclipse.birt.chart.ui.swt.wizard.ChartWizardContext context, java.lang.String sTitle)
           
 org.eclipse.swt.widgets.Composite getSeriesDataSheet(org.eclipse.swt.widgets.Composite parent, SeriesDefinition seriesdefinition, IUIServiceProvider builder, java.lang.Object oContext)
          Deprecated.  
 void validateSeriesBindingType(Series series, IDataServiceProvider idsp)
          Validate whether the series can contain the data type.
 int[] validationIndex(Series series)
           
 

Method Detail

getSeriesAttributeSheet

org.eclipse.swt.widgets.Composite getSeriesAttributeSheet(org.eclipse.swt.widgets.Composite parent,
                                                          Series series)
Deprecated. use getSeriesAttributeSheet( Composite parent, Series series, IUIServiceProvider builder, Object oContext )

Fetches the composite used to set attribute properties for a series.

Parameters:
parent - container for the series attribute composite series the series for which this attribute composite is being provided
Returns:
the series attribute composite

getSeriesAttributeSheet

org.eclipse.swt.widgets.Composite getSeriesAttributeSheet(org.eclipse.swt.widgets.Composite parent,
                                                          Series series,
                                                          org.eclipse.birt.chart.ui.swt.wizard.ChartWizardContext context)
Fetches the composite used to set attribute properties for a series.

Parameters:
parent - container for the series attribute composite series the series for which this attribute composite is being provided
Returns:
the series attribute composite
Since:
2.1

getSeriesDataSheet

org.eclipse.swt.widgets.Composite getSeriesDataSheet(org.eclipse.swt.widgets.Composite parent,
                                                     SeriesDefinition seriesdefinition,
                                                     IUIServiceProvider builder,
                                                     java.lang.Object oContext)
Deprecated. 

Fetches the composite used to set data properties for a series.

Parameters:
parent - container for the series data composite series the series for which this data composite is being provided
Returns:
the series data composite
See Also:
getSeriesDataComponent(int, SeriesDefinition, ChartWizardContext, String)

getSeriesClass

java.lang.String getSeriesClass()
Fetches the class of the series for which this class provides services

Returns:
the fully qualified class name of the series class in the model. (This class has to extend the org.eclipse.birt.chart.model.component.Series interface.)

getSeriesDataComponent

ISelectDataComponent getSeriesDataComponent(int seriesType,
                                            SeriesDefinition seriesDefn,
                                            org.eclipse.birt.chart.ui.swt.wizard.ChartWizardContext context,
                                            java.lang.String sTitle)

validateSeriesBindingType

void validateSeriesBindingType(Series series,
                               IDataServiceProvider idsp)
                               throws ChartException
Validate whether the series can contain the data type.

Parameters:
series -
idsp -
Throws:
ChartException
Since:
2.2

getCompatibleAxisType

AxisType[] getCompatibleAxisType(Series series)
Get the compatible axis type according to series type.

Parameters:
series -
Returns:
An array containing all possible axis types for the designated series.
Since:
2.2

validationIndex

int[] validationIndex(Series series)
Parameters:
series -
Returns:
An array containing the index of all data definitions not allowed to be null.
Since:
2.2


Copyright © 2005-2008 Actuate Corp. All rights reserved.