Class SimpleTask
java.lang.Object
org.eclipse.birt.core.ui.frameworks.taskwizard.SimpleTask
- All Implemented Interfaces:
ITask
,org.eclipse.jface.dialogs.IDialogPage
- Direct Known Subclasses:
CompoundTask
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected WizardBase
protected IWizardContext
protected org.eclipse.swt.widgets.Composite
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
void
createControl
(org.eclipse.swt.widgets.Composite parent) void
dispose()
Called just before the UI for the task is disposed, it will be used by the wizard.org.eclipse.swt.widgets.Control
String[]
Called by the container wizard if it follows the 'pull' mechanism for error discovery.org.eclipse.swt.graphics.Image
getImage()
getTitle()
void
Deprecated.For later useprotected void
removeError
(String errorInfo) void
setContext
(IWizardContext context) Called just before the UI for this Task is shown.void
setDescription
(String description) void
setErrorHints
(Object[] errorHints) Called just before the UI for this Task is shown...in case the task is being shown in response to a request to fix an error.void
setImageDescriptor
(org.eclipse.jface.resource.ImageDescriptor image) Deprecated.For later usevoid
void
setUIProvider
(WizardBase wizard) Called upon instantiation to allow a task to interact with the containing wizard.void
setVisible
(boolean visible)
-
Field Details
-
topControl
protected transient org.eclipse.swt.widgets.Composite topControl -
context
-
container
-
-
Constructor Details
-
SimpleTask
public SimpleTask() -
SimpleTask
-
-
Method Details
-
setContext
Description copied from interface:ITask
Called just before the UI for this Task is shown. Intended for the UI to prepare itself by processing the context passed in. The context will depend on the wizard.- Specified by:
setContext
in interfaceITask
- Parameters:
context
- The context in which the Subtask UI will be shown. Its content depend on individual wizards.
-
getContext
Description copied from interface:ITask
Called just before the UI for the task is disposed, it will be used by the wizard. The context returned should contain the complete updated context for the wizard. This context should be useable as is and should not require any additional processing before use.- Specified by:
getContext
in interfaceITask
- Returns:
- complete context for the wizard with all updates that result from operations performed as part of this task.
-
setUIProvider
Description copied from interface:ITask
Called upon instantiation to allow a task to interact with the containing wizard. This instance should be used to perform operations like enabling or disabling other tasks in the current invocation as well as to display or hide linked popup windows.- Specified by:
setUIProvider
in interfaceITask
- Parameters:
wizard
- instance of WizardBase containing this task instance.
-
getErrors
Description copied from interface:ITask
Called by the container wizard if it follows the 'pull' mechanism for error discovery. A task is expected to provide a collection of error messages indicating the error conditions currently existing in the wizard context. If a wizard does not follow the 'pull' mechanism, the task needs to explicitly 'push' the error list to the wizard using the 'displayError()' method. -
addError
-
removeError
-
setErrorHints
Description copied from interface:ITask
Called just before the UI for this Task is shown...in case the task is being shown in response to a request to fix an error. The argument is supposed to be an object array that provides additional information as to the specific error condition in the current context.- Specified by:
setErrorHints
in interfaceITask
- Parameters:
errorHints
- Object array providing additional (task-specific) information provided by the source of the task redirection. It is expected to contain information that the target task can use to better guide the user to fix any error conditions.
-
dispose
public void dispose()- Specified by:
dispose
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
createControl
public void createControl(org.eclipse.swt.widgets.Composite parent) - Specified by:
createControl
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getControl
public org.eclipse.swt.widgets.Control getControl()- Specified by:
getControl
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getDescription
- Specified by:
getDescription
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getErrorMessage
- Specified by:
getErrorMessage
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getImage
public org.eclipse.swt.graphics.Image getImage()- Specified by:
getImage
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getMessage
- Specified by:
getMessage
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getTitle
- Specified by:
getTitle
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
performHelp
Deprecated.For later use- Specified by:
performHelp
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setDescription
- Specified by:
setDescription
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setImageDescriptor
Deprecated.For later use- Specified by:
setImageDescriptor
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setTitle
- Specified by:
setTitle
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setVisible
public void setVisible(boolean visible) - Specified by:
setVisible
in interfaceorg.eclipse.jface.dialogs.IDialogPage
-