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

public interface IUIServiceProvider

IUIServiceProvider

Field Summary

static int	COMMAND_CHART_EXPRESSION Constant indicating an expression builder specifically for chart.
static int	COMMAND_EXPRESSION Constant indicating a common expression builder.
static int	COMMAND_HYPERLINK Constant indicating a hyper-link builder.
static int	CRITICAL_ERRORS Constant indicating a major (though not fatal) problem in the model
static int	FATAL_ERRORS Constant indicating a fatal error in the model
static int	MINOR_ERRORS Constant indicating a minor error in the model
static int	NO_ERRORS Constant indicating no detectable problems exist in the model
static int	POSSIBLE_ERRORS Constant indicating possible problems detected in the model

Method Summary

double	getConvertedValue(double dOriginalValue, java.lang.String sFromUnits, java.lang.String sToUnits) Gets the result of converting the given value between the specified absolute units of measurement.
java.util.List	getRegisteredKeys() Fetches the list of registered keys for externalizing chart content
java.lang.String	getValue(java.lang.String sKey) Fetches the value for the specified key from the properties file appropriate for the current locale
java.lang.String	invoke(int command, java.lang.String value, java.lang.Object context, java.lang.String sTitle) This method will be used by the Chart Builder UI to invoke numerous builder by a specified command.
java.lang.String	invoke(java.lang.String sExpression, java.lang.Object Context, java.lang.String sTitle) Deprecated. use invoke( int command, String value, Object context, String sTitle ) instead.
java.lang.String	invoke(java.lang.String sExpression, java.lang.Object Context, java.lang.String sTitle, boolean isChartProvider) Deprecated. use invoke( int command, String value, Object context, String sTitle ) instead.
boolean	isInvokingSupported() Returns whether all outside builder invokings are supported
java.lang.String[]	validate(Chart chartModel, java.lang.Object oContext) This method will be used by the Chart Builder UI to validate the model and show any error messages before the user leaves the dialog.

Field Detail

FATAL_ERRORS

public static final int FATAL_ERRORS

Constant indicating a fatal error in the model

See Also:

Constant Field Values

CRITICAL_ERRORS

public static final int CRITICAL_ERRORS

Constant indicating a major (though not fatal) problem in the model

See Also:

Constant Field Values

MINOR_ERRORS

public static final int MINOR_ERRORS

Constant indicating a minor error in the model

See Also:

Constant Field Values

NO_ERRORS

public static final int NO_ERRORS

Constant indicating no detectable problems exist in the model

See Also:

Constant Field Values

POSSIBLE_ERRORS

public static final int POSSIBLE_ERRORS

Constant indicating possible problems detected in the model

See Also:

Constant Field Values

COMMAND_EXPRESSION

public static final int COMMAND_EXPRESSION

Constant indicating a common expression builder.

See Also:

Constant Field Values

COMMAND_CHART_EXPRESSION

public static final int COMMAND_CHART_EXPRESSION

Constant indicating an expression builder specifically for chart.

See Also:

Constant Field Values

COMMAND_HYPERLINK

public static final int COMMAND_HYPERLINK

Constant indicating a hyper-link builder.

See Also:

Constant Field Values

Method Detail

invoke

public java.lang.String invoke(java.lang.String sExpression,
                               java.lang.Object Context,
                               java.lang.String sTitle)

Deprecated. use invoke( int command, String value, Object context, String sTitle ) instead.

This method will be used by the Chart Builder UI to invoke the expression builder with any previously defined expression. The parameter may be null if a new expression is to be built.

Parameters:

sExpression - the expression to be displayed in the builder (after re-entry)

sTitle - the title to be used for the Expression Builder Dialog

Returns:

The final expression string built by the user in the expression builder

invoke

public java.lang.String invoke(java.lang.String sExpression,
                               java.lang.Object Context,
                               java.lang.String sTitle,
                               boolean isChartProvider)

Deprecated. use invoke( int command, String value, Object context, String sTitle ) instead.

This method will be used by the Chart Builder UI to invoke the expression builder with any previously defined expression. The parameter may be null if a new expression is to be built.

Parameters:

sExpression - the expression to be displayed in the builder (after re-entry)

sTitle - the title to be used for the Expression Builder Dialog

isChartProvider - specified for chart expression provider.

Returns:

The final expression string built by the user in the expression builder

invoke

public java.lang.String invoke(int command,
                               java.lang.String value,
                               java.lang.Object context,
                               java.lang.String sTitle)
                        throws ChartException

This method will be used by the Chart Builder UI to invoke numerous builder by a specified command.

Parameters:

command - Indicate which command will be executed.

value - initial value.

context - command context.

sTitle - dialog title if applicable.

Throws:

ChartException

Since:

2.0

isInvokingSupported

public boolean isInvokingSupported()

Returns whether all outside builder invokings are supported

Since:

2.1

validate

public java.lang.String[] validate(Chart chartModel,
                                   java.lang.Object oContext)

This method will be used by the Chart Builder UI to validate the model and show any error messages before the user leaves the dialog.

Parameters:

chartModel - the model to be validated

oContext - the application-specific context associated with the extended chart item

Returns:

an array of user-friendly messages indicating problems with the model

getRegisteredKeys

public java.util.List getRegisteredKeys()

Fetches the list of registered keys for externalizing chart content

Returns:

List containing available keys for externalized content

getValue

public java.lang.String getValue(java.lang.String sKey)

Fetches the value for the specified key from the properties file appropriate for the current locale

Parameters:

sKey - the lookup key for the externalized string

Returns:

the value associated with the key for the current locale, null if resource key is blank

getConvertedValue

public double getConvertedValue(double dOriginalValue,
                                java.lang.String sFromUnits,
                                java.lang.String sToUnits)

Gets the result of converting the given value between the specified absolute units of measurement. Any implementation of this method needs to support conversion between at least the following units: Inches, Centimeters, Millimeters, Points and Pixels

Parameters:

dOriginalValue - the value to be converted

sFromUnits - the units of measurement from which the conversion is to be done

sToUnits - the units of measurement to which the conversion is to be done

Returns:

the converted value