EGF Engine
Release 0.1.0

org.eclipse.egf.common.ui.wizard.page
Class AbstractWizardPage

java.lang.Object
  extended by WizardPage
      extended by org.eclipse.egf.common.ui.wizard.page.AbstractWizardPage
Direct Known Subclasses:
AbstractModelElementWizardPage, AbstractPatternWizardPage

public abstract class AbstractWizardPage
extends WizardPage

Base class to implement wizard pages.


Constructor Summary
AbstractWizardPage(String pageName_p)
          Constructor.
AbstractWizardPage(String pageName_p, String title_p, ImageDescriptor titleImage_p)
          Constructor.
 
Method Summary
 void createControl(Composite parent_p)
           
protected abstract  void createPageArea(Composite parent_p)
          Create the page content.
protected abstract  boolean getCompleteStatus()
          Check conditions to get the page completed
protected  int getContentNumColumn()
          Get the number of columns to be displayed in the content.
protected  String getHelpContextId()
          Return the Help context id if any.
protected abstract  String getPageDescription()
          Get the page description.
protected abstract  String getPageTitle()
          Get the page title.
protected  void handlePageLayout(Composite parent_p)
          Handle the layout of this page.
protected  void initialize()
          Initialize fields.
 boolean isPageComplete()
           
protected abstract  boolean isReadOnly()
          Handle page read only mode.
 void performHelp()
           
 void updateButtons()
          Update page buttons according data status.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractWizardPage

public AbstractWizardPage(String pageName_p)
Constructor.

Parameters:
pageName_p -

AbstractWizardPage

public AbstractWizardPage(String pageName_p,
                          String title_p,
                          ImageDescriptor titleImage_p)
Constructor.

Parameters:
pageName_p -
title_p -
titleImage_p -
Method Detail

initialize

protected void initialize()
Initialize fields.


createControl

public void createControl(Composite parent_p)
See Also:
org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite)

isReadOnly

protected abstract boolean isReadOnly()
Handle page read only mode.


updateButtons

public final void updateButtons()
Update page buttons according data status.


isPageComplete

public boolean isPageComplete()
See Also:
org.eclipse.jface.wizard.WizardPage#isPageComplete()

getCompleteStatus

protected abstract boolean getCompleteStatus()
Check conditions to get the page completed

Returns:
true the page is complete; false otherwise.

createPageArea

protected abstract void createPageArea(Composite parent_p)
Create the page content.

Parameters:
parent_p -

handlePageLayout

protected void handlePageLayout(Composite parent_p)
Handle the layout of this page.

Parameters:
parent_p -

getContentNumColumn

protected int getContentNumColumn()
Get the number of columns to be displayed in the content.

Returns:
Default implementation return 2 columns.

getPageTitle

protected abstract String getPageTitle()
Get the page title.

Returns:

getPageDescription

protected abstract String getPageDescription()
Get the page description.

Returns:

getHelpContextId

protected String getHelpContextId()
Return the Help context id if any.
Default implementation returns null.

Returns:
null or an help context id.

performHelp

public void performHelp()
See Also:
org.eclipse.jface.dialogs.DialogPage#performHelp()

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.