Interface IUIServiceProvider
public interface IUIServiceProvider
IUIServiceProvider
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Deprecated.static final int
Constant indicating an expression builder to input tootips (one type of triggers ) for value series while using cube casestatic final int
Deprecated.static final int
Constant indicating an expression builder to input chart data point variables.static final int
Constant indicating an expression builder to input data bindings.static final int
Constant indicating an expression builder to input script (one type of triigers) for value series.static final int
Constant indicating an expression builder to input tooltips (one type of triggers) for value series.static final int
Constant indicating an expression builder to input triggers except for value series.static final int
Constant indicating a builder to input hyper-link except for data points.static final int
Constant indicating a builder to input hyper-link for data points.static final int
Constant indicating a builder to input hyper-link for data points but raw data expression not allowed.static final int
Constant indicating a builder to input hyper-link for legend.static final int
Constant indicating a builder to select resource filestatic final int
Constant indicating a major (though not fatal) problem in the modelstatic final int
Constant indicating a fatal error in the modelstatic final int
Constant indicating a minor error in the modelstatic final int
Constant indicating no detectable problems exist in the modelstatic final int
Constant indicating possible problems detected in the model -
Method Summary
Modifier and TypeMethodDescriptiondouble
getConvertedValue
(double dOriginalValue, String sFromUnits, String sToUnits) Gets the result of converting the given value between the specified absolute units of measurement.Creates a UI to process format specifier.Fetches the list of registered keys for externalizing chart contentFetches the value for the specified key from the properties file appropriate for the current localeThis method will be used by the Chart Builder UI to invoke numerous builder by a specified command.Deprecated.use invoke( int command, String value, Object context, String sTitle ) instead.Deprecated.use invoke( int command, String value, Object context, String sTitle ) instead.invoke
(IUIServiceProvider.Command command, Object... inData) This method will be used by the Chart Builder UI to invoke numerous builder by a specified command.boolean
Returns whether the application is running under Eclipse Modeboolean
Returns whether all outside builder invokings are supportedString[]
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 Details
-
FATAL_ERRORS
static final int FATAL_ERRORSConstant indicating a fatal error in the model- See Also:
-
CRITICAL_ERRORS
static final int CRITICAL_ERRORSConstant indicating a major (though not fatal) problem in the model- See Also:
-
MINOR_ERRORS
static final int MINOR_ERRORSConstant indicating a minor error in the model- See Also:
-
NO_ERRORS
static final int NO_ERRORSConstant indicating no detectable problems exist in the model- See Also:
-
POSSIBLE_ERRORS
static final int POSSIBLE_ERRORSConstant indicating possible problems detected in the model- See Also:
-
COMMAND_EXPRESSION_DATA_BINDINGS
static final int COMMAND_EXPRESSION_DATA_BINDINGSConstant indicating an expression builder to input data bindings.- See Also:
-
COMMAND_EXPRESSION_CHART_DATAPOINTS
static final int COMMAND_EXPRESSION_CHART_DATAPOINTSConstant indicating an expression builder to input chart data point variables.- See Also:
-
COMMAND_EXPRESSION_TRIGGERS_SIMPLE
static final int COMMAND_EXPRESSION_TRIGGERS_SIMPLEConstant indicating an expression builder to input triggers except for value series.- See Also:
-
COMMAND_EXPRESSION_SCRIPT_DATAPOINTS
static final int COMMAND_EXPRESSION_SCRIPT_DATAPOINTSConstant indicating an expression builder to input script (one type of triigers) for value series.- See Also:
-
COMMAND_EXPRESSION_TOOLTIPS_DATAPOINTS
static final int COMMAND_EXPRESSION_TOOLTIPS_DATAPOINTSConstant indicating an expression builder to input tooltips (one type of triggers) for value series.- See Also:
-
COMMAND_CUBE_EXPRESSION_TOOLTIPS_DATAPOINTS
static final int COMMAND_CUBE_EXPRESSION_TOOLTIPS_DATAPOINTSConstant indicating an expression builder to input tootips (one type of triggers ) for value series while using cube case- See Also:
-
COMMAND_EXPRESSION
Deprecated.Constant indicating a common expression builder.- See Also:
-
COMMAND_CHART_EXPRESSION
Deprecated.Constant indicating an expression builder specifically for chart.- See Also:
-
COMMAND_HYPERLINK
static final int COMMAND_HYPERLINKConstant indicating a builder to input hyper-link except for data points.- See Also:
-
COMMAND_HYPERLINK_DATAPOINTS
static final int COMMAND_HYPERLINK_DATAPOINTSConstant indicating a builder to input hyper-link for data points.- See Also:
-
COMMAND_HYPERLINK_LEGEND
static final int COMMAND_HYPERLINK_LEGENDConstant indicating a builder to input hyper-link for legend.- See Also:
-
COMMAND_HYPERLINK_DATAPOINTS_SIMPLE
static final int COMMAND_HYPERLINK_DATAPOINTS_SIMPLEConstant indicating a builder to input hyper-link for data points but raw data expression not allowed.- See Also:
-
COMMAND_RESOURCE_SELECTION_DIALOG
static final int COMMAND_RESOURCE_SELECTION_DIALOGConstant indicating a builder to select resource file- See Also:
-
-
Method Details
-
invoke
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)oContext
- the application-specific context used by the Expression Builder for each invocationsTitle
- the title to be used for the Expression Builder Dialog- Returns:
- The final expression string built by the user in the expression builder
-
invoke
@Deprecated String invoke(String sExpression, Object Context, 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)oContext
- the application-specific context used by the Expression Builder for each invocationsTitle
- the title to be used for the Expression Builder DialogisChartProvider
- specified for chart expression provider.- Returns:
- The final expression string built by the user in the expression builder
-
invoke
String invoke(int command, String value, Object context, String sTitle) throws org.eclipse.birt.chart.exception.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:
org.eclipse.birt.chart.exception.ChartException
- Since:
- 2.0
-
invoke
Object invoke(IUIServiceProvider.Command command, Object... inData) throws org.eclipse.birt.chart.exception.ChartException This method will be used by the Chart Builder UI to invoke numerous builder by a specified command.- Parameters:
command
-inData
-- Returns:
- any objects that caller needs
- Throws:
org.eclipse.birt.chart.exception.ChartException
-
isInvokingSupported
boolean isInvokingSupported()Returns whether all outside builder invokings are supported- Since:
- 2.1
-
validate
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 validatedoContext
- the application-specific context associated with the extended chart item- Returns:
- an array of user-friendly messages indicating problems with the model
-
getRegisteredKeys
Fetches the list of registered keys for externalizing chart content- Returns:
- List containing available keys for externalized content
-
getValue
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
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 convertedsFromUnits
- the units of measurement from which the conversion is to be donesToUnits
- the units of measurement to which the conversion is to be done- Returns:
- the converted value
-
isEclipseModeSupported
boolean isEclipseModeSupported()Returns whether the application is running under Eclipse Mode- Since:
- 2.2
-
getFormatSpecifierHandler
IFormatSpecifierHandler getFormatSpecifierHandler()Creates a UI to process format specifier.- Returns:
-