|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.core.ui.frameworks.taskwizard.WizardBase
public class WizardBase
Field Summary | |
---|---|
protected IWizardContext |
context
|
Constructor Summary | |
---|---|
WizardBase()
|
|
WizardBase(Shell parentShell,
java.lang.String sID,
int iInitialWidth,
int iInitialHeight,
java.lang.String strTitle,
Image imgTitle,
java.lang.String strHeader,
Image imgHeader)
Creates an instance of the wizard. |
|
WizardBase(java.lang.String sID)
|
|
WizardBase(java.lang.String sID,
int iInitialWidth,
int iInitialHeight,
java.lang.String strTitle,
Image imgTitle,
java.lang.String strHeader,
Image imgHeader)
Deprecated. To use WizardBase(Shell, String, int, int, String, Image, String, Image) |
Method Summary | |
---|---|
void |
addCustomButton(IButtonHandler buttonHandler)
Adds a custom button after built-in buttons. |
void |
addTask(java.lang.String sTaskID)
|
protected boolean |
applyCustomPack()
The method makes user can do custom pack actions for current dialog. |
void |
attachPopup(java.lang.String sPopupTitle,
int iWidth,
int iHeight)
Attaches the popup window. |
void |
clearCache()
Clears the cached task instances. |
protected WizardBaseDialog |
createDialog(Shell shell,
int initialWidth,
int initialHeight,
java.lang.String strTitle,
Image imgTitle)
|
Shell |
createPopupContainer()
|
void |
detachPopup()
|
void |
displayError(java.lang.String[] sErrors,
java.lang.String[] sFixes,
java.lang.String[] sTaskIDs,
IWizardContext currentContext,
java.lang.Object[] hints)
Displays the errors in a common Error Display UI mechanism. |
static void |
displayException(java.lang.Throwable t)
Displays the exception in a common Error Display UI mechanism. |
void |
dispose()
|
void |
firePageChanged(IDialogPage taskPage)
|
ITask |
getCurrentTask()
|
protected java.util.List<IButtonHandler> |
getCustomButtons()
|
protected BirtTitleAreaDialog |
getDialog()
|
static java.lang.String |
getErrors()
|
Shell |
getPopupContainer()
|
protected java.lang.String |
getTitle()
|
IWizardContext |
open(IWizardContext initialContext)
Launches the wizard with the first tasks in 'Available' state. |
IWizardContext |
open(java.lang.String[] sTasks,
java.lang.String topTaskId,
IWizardContext initialContext)
Launches the wizard with the specified tasks in 'Available' state...and the specified task sets as the 'Active' task. |
void |
packWizard()
Packs the wizard to display enough size |
static void |
removeException()
Remove the error message in the dialog. |
void |
removeTask(java.lang.String sTaskID)
|
void |
setMinimumSize(int iWidth,
int iHeight)
Sets the minimum size of the wizard |
protected void |
setTitle(java.lang.String wizardTitle)
|
void |
setWizardClosedWhenEnterPressed(boolean bClosed)
Sets if wizard should be closed when Enter key is pressed. |
static void |
showException(java.lang.String errorMessage)
Displays the exception in an Eclipse error mechanism. |
void |
switchTo(java.lang.String sTaskID)
|
void |
taskDeregistered(java.lang.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(java.lang.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 java.lang.String[] |
validate()
Validates before pressing OK. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected transient IWizardContext context
Constructor Detail |
---|
public WizardBase(java.lang.String sID)
public WizardBase(java.lang.String sID, int iInitialWidth, int iInitialHeight, java.lang.String strTitle, Image imgTitle, java.lang.String strHeader, Image imgHeader)
WizardBase(Shell, String, int, int, String, Image, String, Image)
open
method to create the wizard dialog.
sID
- wizard idiInitialWidth
- width minimumiInitialHeight
- height minimumstrTitle
- wizard titleimgTitle
- wizard imagestrHeader
- the header descriptionimgHeader
- image displayed in the task bar. If null, leave blank. *public WizardBase(Shell parentShell, java.lang.String sID, int iInitialWidth, int iInitialHeight, java.lang.String strTitle, Image imgTitle, java.lang.String strHeader, Image imgHeader)
open
method to create the wizard dialog.
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.public WizardBase()
Method Detail |
---|
public IWizardContext open(java.lang.String[] sTasks, java.lang.String topTaskId, IWizardContext initialContext)
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
public IWizardContext open(IWizardContext initialContext)
initialContext
- Initial Context for the wizard
public void setMinimumSize(int iWidth, int iHeight)
iWidth
- width minimumiHeight
- height minimumpublic void firePageChanged(IDialogPage taskPage)
public void setWizardClosedWhenEnterPressed(boolean bClosed)
bClosed
- true then close wizard when Enter key is pressedpublic void addCustomButton(IButtonHandler buttonHandler)
open(String[], String, IWizardContext)
buttonHandler
- Custom button handlerprotected java.util.List<IButtonHandler> getCustomButtons()
public void addTask(java.lang.String sTaskID)
public void removeTask(java.lang.String sTaskID)
public ITask getCurrentTask()
public void switchTo(java.lang.String sTaskID)
public Shell createPopupContainer()
public Shell getPopupContainer()
public void attachPopup(java.lang.String sPopupTitle, int iWidth, int iHeight)
sPopupTitle
- popup titlepublic void detachPopup()
public void updateContext(IWizardContext wizardcontext)
protected WizardBaseDialog createDialog(Shell shell, int initialWidth, int initialHeight, java.lang.String strTitle, Image imgTitle)
public void clearCache()
public static void displayException(java.lang.Throwable t)
t
- exception to be displayed to the userpublic static void showException(java.lang.String errorMessage)
t
- exception to be displayed to the userpublic static void removeException()
public static java.lang.String getErrors()
public void displayError(java.lang.String[] sErrors, java.lang.String[] sFixes, java.lang.String[] sTaskIDs, IWizardContext currentContext, java.lang.Object[] hints)
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 UIpublic void taskRegistered(java.lang.String sTaskID)
taskRegistered
in interface IRegistrationListener
sTaskID
- The ID for the newly registered taskpublic void taskDeregistered(java.lang.String sTaskID)
taskDeregistered
in interface IRegistrationListener
sTaskID
- The ID for the deregistered taskprotected java.lang.String[] validate()
public void dispose()
protected BirtTitleAreaDialog getDialog()
protected void setTitle(java.lang.String wizardTitle)
protected java.lang.String getTitle()
public void packWizard()
protected boolean applyCustomPack()
true
means custom pack has been done.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |