Class WizardBase
java.lang.Object
org.eclipse.birt.core.ui.frameworks.taskwizard.WizardBase
- All Implemented Interfaces:
IRegistrationListener
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionWizardBase
(String sID) WizardBase
(String sID, int iInitialWidth, int iInitialHeight, String strTitle, org.eclipse.swt.graphics.Image imgTitle, String strHeader, org.eclipse.swt.graphics.Image imgHeader) Deprecated.WizardBase
(org.eclipse.swt.widgets.Shell parentShell, String sID, int iInitialWidth, int iInitialHeight, String strTitle, org.eclipse.swt.graphics.Image imgTitle, String strHeader, org.eclipse.swt.graphics.Image imgHeader) Creates an instance of the wizard. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCustomButton
(IButtonHandler buttonHandler) Adds a custom button after built-in buttons.void
addTabToolButton
(IButtonHandler buttonHandler) Adds tab tool button.void
protected boolean
The method makes user can do custom pack actions for current dialog.void
attachPopup
(String sPopupTitle, int iWidth, int iHeight) Attaches the popup window.void
Clears the cached task instances.protected WizardBaseDialog
createDialog
(org.eclipse.swt.widgets.Shell shell, int initialWidth, int initialHeight, String strTitle, org.eclipse.swt.graphics.Image imgTitle) org.eclipse.swt.widgets.Shell
void
void
displayError
(String[] sErrors, String[] sFixes, String[] sTaskIDs, IWizardContext currentContext, Object[] hints) Displays the errors in a common Error Display UI mechanism.static void
Displays the exception in a common Error Display UI mechanism.void
dispose()
void
firePageChanged
(org.eclipse.jface.dialogs.IDialogPage taskPage) protected List<IButtonHandler>
protected org.eclipse.jface.dialogs.TitleAreaDialog
static String
org.eclipse.swt.widgets.Shell
Returns all tab tool buttons.protected String
getTitle()
boolean
open
(String[] sTasks, String topTaskId, IWizardContext initialContext) Launches the wizard with the specified tasks in 'Available' state...and the specified task sets as the 'Active' task.open
(IWizardContext initialContext) Launches the wizard with the first tasks in 'Available' state.void
Packs the wizard to display enough sizestatic void
Remove the error message in the dialog.void
removeTask
(String sTaskID) void
setMinimumSize
(int iWidth, int iHeight) Sets the minimum size of the wizardprotected void
void
setWizardClosedWhenEnterPressed
(boolean bClosed) Sets if wizard should be closed when Enter key is pressed.static void
showException
(String errorMessage) Displays the exception in an Eclipse error mechanism.void
void
taskDeregistered
(String sTaskID) Notification method called by the org.eclipse.birt.frameworks.taskwizard.interfaces.TasksManager instance when an existing ITask instance is successfully deregistered.void
taskRegistered
(String sTaskID) Notification method called by the org.eclipse.birt.frameworks.taskwizard.interfaces.TasksManager instance when a new ITask instance is successfully registered.void
updateContext
(IWizardContext wizardcontext) protected String[]
validate()
Validates before pressing OK.
-
Field Details
-
context
-
-
Constructor Details
-
WizardBase
-
WizardBase
@Deprecated public WizardBase(String sID, int iInitialWidth, int iInitialHeight, String strTitle, org.eclipse.swt.graphics.Image imgTitle, String strHeader, org.eclipse.swt.graphics.Image imgHeader) Deprecated.Creates an instance of the wizard. Needs to invokeopen
method to create the wizard dialog.- Parameters:
sID
- wizard idiInitialWidth
- width minimumiInitialHeight
- height minimumstrTitle
- wizard titleimgTitle
- wizard imagestrHeader
- the header descriptionimgHeader
- image displayed in the task bar. If null, leave blank. *
-
WizardBase
public WizardBase(org.eclipse.swt.widgets.Shell parentShell, String sID, int iInitialWidth, int iInitialHeight, String strTitle, org.eclipse.swt.graphics.Image imgTitle, String strHeader, org.eclipse.swt.graphics.Image imgHeader) Creates an instance of the wizard. Needs to invokeopen
method to create the wizard dialog.- Parameters:
parentShell
- parent shellsID
- wizard idiInitialWidth
- width minimumiInitialHeight
- height minimumstrTitle
- wizard titleimgTitle
- wizard imagestrHeader
- the header descriptionimgHeader
- image displayed in the task bar. If null, leave blank.- Since:
- 2.1.1
-
WizardBase
public WizardBase()
-
-
Method Details
-
open
Launches the wizard with the specified tasks in 'Available' state...and the specified task sets as the 'Active' task.- Parameters:
sTasks
- Array of task IDs to add. Null indicates nothing added.topTaskId
- Task to open at first. Null indicates the first task will be the top.initialContext
- Initial Context for the wizard- Returns:
- Wizard Context
-
open
Launches the wizard with the first tasks in 'Available' state. Ensure the task is registered at first.- Parameters:
initialContext
- Initial Context for the wizard- Returns:
- Wizard Context
-
setMinimumSize
public void setMinimumSize(int iWidth, int iHeight) Sets the minimum size of the wizard- Parameters:
iWidth
- width minimumiHeight
- height minimum
-
firePageChanged
public void firePageChanged(org.eclipse.jface.dialogs.IDialogPage taskPage) -
setWizardClosedWhenEnterPressed
public void setWizardClosedWhenEnterPressed(boolean bClosed) Sets if wizard should be closed when Enter key is pressed. Default value is true.- Parameters:
bClosed
- true then close wizard when Enter key is pressed- Since:
- 2.3.1 and 2.5
-
addCustomButton
Adds a custom button after built-in buttons. This method must be invoked before invokingopen(String[], String, IWizardContext)
- Parameters:
buttonHandler
- Custom button handler
-
getCustomButtons
-
addTabToolButton
Adds tab tool button.- Parameters:
buttonHandler
-
-
getTabToolButtons
Returns all tab tool buttons.- Returns:
- all tab tool buttons.
-
addTask
-
removeTask
-
getCurrentTask
-
switchTo
-
createPopupContainer
public org.eclipse.swt.widgets.Shell createPopupContainer() -
getPopupContainer
public org.eclipse.swt.widgets.Shell getPopupContainer() -
attachPopup
Attaches the popup window.- Parameters:
sPopupTitle
- popup title
-
detachPopup
public void detachPopup() -
updateContext
-
createDialog
protected WizardBaseDialog createDialog(org.eclipse.swt.widgets.Shell shell, int initialWidth, int initialHeight, String strTitle, org.eclipse.swt.graphics.Image imgTitle) -
clearCache
public void clearCache()Clears the cached task instances. This can be used between invocations when a wizard instance is being reused in an application. Calling this will cause fresh instances of tasks to be fetched from the TasksManager when the wizard is invoked. -
displayException
Displays the exception in a common Error Display UI mechanism.- Parameters:
t
- exception to be displayed to the user
-
showException
Displays the exception in an Eclipse error mechanism.- Parameters:
t
- exception to be displayed to the user
-
removeException
public static void removeException()Remove the error message in the dialog. -
getErrors
-
displayError
public void displayError(String[] sErrors, String[] sFixes, String[] sTaskIDs, IWizardContext currentContext, Object[] hints) Displays the errors in a common Error Display UI mechanism. Also displayed are possible solutions to the problems. The user can also be given the option of switching to a different task where the fix needs to be made. (This is not implemented yet).- Parameters:
sErrors
- Array of error stringssFixes
- Array of strings listing possible solutions to above errorssTaskIDs
- Array of task IDs which the user can switch to. The appropriate task labels should be indicated in the solutions to allow users to make the connectioncurrentContext
- Updated IWizardContext instance...this instance will include the erroneous settingshints
- Object array that will be passed to the target task...which can be used to indicate specific problems or to customize behavior of the task UI
-
taskRegistered
Notification method called by the org.eclipse.birt.frameworks.taskwizard.interfaces.TasksManager instance when a new ITask instance is successfully registered. Default behavior is to do nothing.- Specified by:
taskRegistered
in interfaceIRegistrationListener
- Parameters:
sTaskID
- The ID for the newly registered task
-
taskDeregistered
Notification method called by the org.eclipse.birt.frameworks.taskwizard.interfaces.TasksManager instance when an existing ITask instance is successfully deregistered. Default behavior is to do nothing. This can be overridden by individual wizards to handle deregistration of tasks currently available in the wizard.- Specified by:
taskDeregistered
in interfaceIRegistrationListener
- Parameters:
sTaskID
- The ID for the deregistered task
-
validate
Validates before pressing OK.- Returns:
- validation results
-
dispose
public void dispose() -
isDisposed
public boolean isDisposed() -
getDialog
protected org.eclipse.jface.dialogs.TitleAreaDialog getDialog() -
setTitle
-
getTitle
-
packWizard
public void packWizard()Packs the wizard to display enough size -
applyCustomPack
protected boolean applyCustomPack()The method makes user can do custom pack actions for current dialog.- Returns:
true
means custom pack has been done.
-
WizardBase(Shell, String, int, int, String, Image, String, Image)