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
public class SimpleTask extends java.lang.Object implements ITask
-
-
Field Summary
Fields Modifier and Type Field Description protected WizardBasecontainerprotected IWizardContextcontextprotected org.eclipse.swt.widgets.CompositetopControl
-
Constructor Summary
Constructors Constructor Description SimpleTask()SimpleTask(java.lang.String title)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidaddError(java.lang.String errorInfo)voidcreateControl(org.eclipse.swt.widgets.Composite parent)voiddispose()IWizardContextgetContext()Called just before the UI for the task is disposed, it will be used by the wizard.org.eclipse.swt.widgets.ControlgetControl()java.lang.StringgetDescription()java.lang.StringgetErrorMessage()java.lang.String[]getErrors()Called by the container wizard if it follows the 'pull' mechanism for error discovery.org.eclipse.swt.graphics.ImagegetImage()java.lang.StringgetMessage()java.lang.StringgetTitle()voidperformHelp()Deprecated.For later useprotected voidremoveError(java.lang.String errorInfo)voidsetContext(IWizardContext context)Called just before the UI for this Task is shown.voidsetDescription(java.lang.String description)voidsetErrorHints(java.lang.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.voidsetImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)Deprecated.For later usevoidsetTitle(java.lang.String title)voidsetUIProvider(WizardBase wizard)Called upon instantiation to allow a task to interact with the containing wizard.voidsetVisible(boolean visible)
-
-
-
Field Detail
-
topControl
protected transient org.eclipse.swt.widgets.Composite topControl
-
context
protected transient IWizardContext context
-
container
protected transient WizardBase container
-
-
Method Detail
-
setContext
public void setContext(IWizardContext context)
Description copied from interface:ITaskCalled 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:
setContextin interfaceITask- Parameters:
context- The context in which the Subtask UI will be shown. Its content depend on individual wizards.
-
getContext
public IWizardContext getContext()
Description copied from interface:ITaskCalled 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:
getContextin interfaceITask- Returns:
- complete context for the wizard with all updates that result from operations performed as part of this task.
-
setUIProvider
public void setUIProvider(WizardBase wizard)
Description copied from interface:ITaskCalled 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:
setUIProviderin interfaceITask- Parameters:
wizard- instance of WizardBase containing this task instance.
-
getErrors
public java.lang.String[] getErrors()
Description copied from interface:ITaskCalled 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
protected void addError(java.lang.String errorInfo)
-
removeError
protected void removeError(java.lang.String errorInfo)
-
setErrorHints
public void setErrorHints(java.lang.Object[] errorHints)
Description copied from interface:ITaskCalled 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:
setErrorHintsin 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:
disposein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
createControl
public void createControl(org.eclipse.swt.widgets.Composite parent)
- Specified by:
createControlin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getControl
public org.eclipse.swt.widgets.Control getControl()
- Specified by:
getControlin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescriptionin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getErrorMessage
public java.lang.String getErrorMessage()
- Specified by:
getErrorMessagein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getImage
public org.eclipse.swt.graphics.Image getImage()
- Specified by:
getImagein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getMessage
public java.lang.String getMessage()
- Specified by:
getMessagein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
getTitle
public java.lang.String getTitle()
- Specified by:
getTitlein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
performHelp
@Deprecated public void performHelp()
Deprecated.For later use- Specified by:
performHelpin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setDescription
public void setDescription(java.lang.String description)
- Specified by:
setDescriptionin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setImageDescriptor
@Deprecated public void setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)
Deprecated.For later use- Specified by:
setImageDescriptorin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setTitle
public void setTitle(java.lang.String title)
- Specified by:
setTitlein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setVisible
public void setVisible(boolean visible)
- Specified by:
setVisiblein interfaceorg.eclipse.jface.dialogs.IDialogPage
-
-