IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.rcp.wizard
Class WizardComposite

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Composite
                  extended by com.ibm.btt.rcp.wizard.DialogComposite
                      extended by com.ibm.btt.rcp.wizard.TitileAreaDialogComposite
                          extended by com.ibm.btt.rcp.wizard.WizardComposite
All Implemented Interfaces:
org.eclipse.jface.operation.IRunnableContext, org.eclipse.jface.wizard.IWizardContainer, org.eclipse.jface.wizard.IWizardContainer2, org.eclipse.swt.graphics.Drawable

public class WizardComposite
extends TitileAreaDialogComposite
implements org.eclipse.jface.wizard.IWizardContainer2


Nested Class Summary
protected  class WizardComposite.PageContainerFillLayout
          A layout for a container which includes several pages, like a notebook, wizard, or preference dialog.
 
Field Summary
static java.lang.String WIZ_IMG_ERROR
          Image registry key for error message image (value "dialog_title_error_image").
 
Fields inherited from class com.ibm.btt.rcp.wizard.TitileAreaDialogComposite
DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, titleAreaColor
 
Fields inherited from class com.ibm.btt.rcp.wizard.DialogComposite
buttonBar, dialogArea, INN_DLG_IMG_HELP, INN_DLG_IMG_MESSAGE_ERROR, INN_DLG_IMG_MESSAGE_INFO, INN_DLG_IMG_MESSAGE_WARNING
 
Fields inherited from class org.eclipse.swt.widgets.Control
handle
 
Constructor Summary
WizardComposite(org.eclipse.swt.widgets.Composite parent, int style, org.eclipse.jface.wizard.IWizard newWizard)
           
 
Method Summary
protected  void backPressed()
          The Back button has been pressed.
protected  void buttonPressed(int buttonId)
          Notifies that this dialog's button with the given id has been pressed.
protected  void cancelPressed()
           
protected  void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
          Creates the buttons for this dialog's button bar.
protected  org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)
          The WizardDialog implementation of this Window method calls call IWizard.addPages to allow the current wizard to add extra pages, then super.createContents to create the controls.
protected  org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
           
protected  org.eclipse.jface.wizard.ProgressMonitorPart createProgressMonitorPart(org.eclipse.swt.widgets.Composite composite, org.eclipse.swt.layout.GridLayout pmlayout)
          Create the progress monitor part in the receiver.
protected  void finishPressed()
          The Finish button has been pressed.
 org.eclipse.jface.wizard.IWizardPage getCurrentPage()
           
protected  org.eclipse.jface.wizard.IWizard getWizard()
           
protected  void nextPressed()
          The Next button has been pressed.
 void run(boolean fork, boolean cancelable, org.eclipse.jface.operation.IRunnableWithProgress runnable)
           
 void setCancelEnabled(boolean enabled)
           
protected  void setWizard(org.eclipse.jface.wizard.IWizard newWizard)
           
 void showPage(org.eclipse.jface.wizard.IWizardPage page)
           
 void updateButtons()
           
 void updateMessage()
           
 void updateSize()
           
 void updateTitleBar()
           
protected  void updateUI()
          Updates this dialog's controls to reflect the current page.
 void updateWindowTitle()
           
 
Methods inherited from class com.ibm.btt.rcp.wizard.TitileAreaDialogComposite
setErrorMessage, setMessage, setMessage, setTitle, setTitleImage
 
Methods inherited from class com.ibm.btt.rcp.wizard.DialogComposite
applyDialogFont, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, createButton, createButtonBar, dialogFontIsDefault, getButton, getButtonBar, getDialogArea, initializeDialogUnits, setButtonLayoutData
 
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.wizard.IWizardContainer
getShell
 

Field Detail

WIZ_IMG_ERROR

public static final java.lang.String WIZ_IMG_ERROR
Image registry key for error message image (value "dialog_title_error_image").

See Also:
Constant Field Values
Constructor Detail

WizardComposite

public WizardComposite(org.eclipse.swt.widgets.Composite parent,
                       int style,
                       org.eclipse.jface.wizard.IWizard newWizard)
Method Detail

setWizard

protected void setWizard(org.eclipse.jface.wizard.IWizard newWizard)

setCancelEnabled

public void setCancelEnabled(boolean enabled)

createButtonsForButtonBar

protected void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
Creates the buttons for this dialog's button bar.

The WizardDialog implementation of this framework method prevents the parent composite's columns from being made equal width in order to remove the margin between the Back and Next buttons.

Overrides:
createButtonsForButtonBar in class DialogComposite
Parameters:
parent - the parent composite to contain the buttons

cancelPressed

protected void cancelPressed()

createContents

protected org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)
The WizardDialog implementation of this Window method calls call IWizard.addPages to allow the current wizard to add extra pages, then super.createContents to create the controls. It then calls IWizard.createPageControls to allow the wizard to pre-create their page controls prior to opening, so that the wizard opens to the correct size. And finally it shows the first page.

Overrides:
createContents in class TitileAreaDialogComposite

updateUI

protected void updateUI()
Updates this dialog's controls to reflect the current page.


createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)
Overrides:
createDialogArea in class DialogComposite

buttonPressed

protected void buttonPressed(int buttonId)
Description copied from class: DialogComposite
Notifies that this dialog's button with the given id has been pressed.

The Dialog implementation of this framework method calls okPressed if the ok button is the pressed, and cancelPressed if the cancel button is the pressed. All other button presses are ignored. Subclasses may override to handle other buttons, but should call super.buttonPressed if the default handling of the ok and cancel buttons is desired.

Overrides:
buttonPressed in class DialogComposite
Parameters:
buttonId - the id of the button that was pressed (see IDialogConstants.*_ID constants)

nextPressed

protected void nextPressed()
The Next button has been pressed.


finishPressed

protected void finishPressed()
The Finish button has been pressed.


getWizard

protected org.eclipse.jface.wizard.IWizard getWizard()

backPressed

protected void backPressed()
The Back button has been pressed.


createProgressMonitorPart

protected org.eclipse.jface.wizard.ProgressMonitorPart createProgressMonitorPart(org.eclipse.swt.widgets.Composite composite,
                                                                                 org.eclipse.swt.layout.GridLayout pmlayout)
Create the progress monitor part in the receiver.

Parameters:
composite -
pmlayout -
Returns:
ProgressMonitorPart

updateSize

public void updateSize()
Specified by:
updateSize in interface org.eclipse.jface.wizard.IWizardContainer2

getCurrentPage

public org.eclipse.jface.wizard.IWizardPage getCurrentPage()
Specified by:
getCurrentPage in interface org.eclipse.jface.wizard.IWizardContainer

showPage

public void showPage(org.eclipse.jface.wizard.IWizardPage page)
Specified by:
showPage in interface org.eclipse.jface.wizard.IWizardContainer

updateButtons

public void updateButtons()
Specified by:
updateButtons in interface org.eclipse.jface.wizard.IWizardContainer

updateMessage

public void updateMessage()
Specified by:
updateMessage in interface org.eclipse.jface.wizard.IWizardContainer

updateTitleBar

public void updateTitleBar()
Specified by:
updateTitleBar in interface org.eclipse.jface.wizard.IWizardContainer

updateWindowTitle

public void updateWindowTitle()
Specified by:
updateWindowTitle in interface org.eclipse.jface.wizard.IWizardContainer

run

public void run(boolean fork,
                boolean cancelable,
                org.eclipse.jface.operation.IRunnableWithProgress runnable)
         throws java.lang.reflect.InvocationTargetException,
                java.lang.InterruptedException
Specified by:
run in interface org.eclipse.jface.operation.IRunnableContext
Throws:
java.lang.reflect.InvocationTargetException
java.lang.InterruptedException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009