Class ServiceWizardSet
- java.lang.Object
-
- org.libreoffice.ide.eclipse.core.wizards.utils.WizardPageSet
-
- org.libreoffice.ide.eclipse.core.wizards.ServiceWizardSet
-
public class ServiceWizardSet extends WizardPageSet
This wizard page set manages a service page and an interface page.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringINTERFACE_PAGE_IDprotected IUnoidlProjectmProjectAn instance of the project in which the wizard set is run.static java.lang.StringSERVICE_PAGE_ID-
Fields inherited from class org.libreoffice.ide.eclipse.core.wizards.utils.WizardPageSet
mChangingPages, mPageListener, mWizard
-
-
Constructor Summary
Constructors Constructor Description ServiceWizardSet(org.eclipse.jface.wizard.IWizard pWizard)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddataChanged(UnoFactoryData pDelta)Change the service and/or interface page from a data delta.voiddoFinish(org.eclipse.core.runtime.IProgressMonitor pMonitor, org.eclipse.ui.IWorkbenchPage pActivePage)Performs the actions to run at the end of the wizard for the wizard set.voidinitialize(UnoFactoryData pData)Initializes the service and interface pages at their creation.-
Methods inherited from class org.libreoffice.ide.eclipse.core.wizards.utils.WizardPageSet
addPage, getNextPage, getPage, getPages, getPreviousPage, setHidden
-
-
-
-
Field Detail
-
SERVICE_PAGE_ID
public static final java.lang.String SERVICE_PAGE_ID
- See Also:
- Constant Field Values
-
INTERFACE_PAGE_ID
public static final java.lang.String INTERFACE_PAGE_ID
- See Also:
- Constant Field Values
-
mProject
protected IUnoidlProject mProject
An instance of the project in which the wizard set is run.This member should be used only to replace the pages project reference is needed. This is mostly used when the project isn't created when the wizard set is opened, i.e.: at project creation.
-
-
Method Detail
-
initialize
public void initialize(UnoFactoryData pData)
Initializes the service and interface pages at their creation.The factory data needed for the pages initialization should contain some fields about the project and two or less children (one for a service and/or one for an interface). The data structure should contain the following fields:
-
Project fields
- Project name
- OOo Instance
- Company prefix
-
Service fields (opt.)
- Name (opt. : the project name is used)
- Package name (opt. : the company prefix can be used)
- Inherited interface (opt.)
-
Interface fields (opt.)
- Name (opt.)
- Package name (opt.)
- Specified by:
initializein classWizardPageSet- Parameters:
pData- the service initialization data as described above.
-
-
dataChanged
public void dataChanged(UnoFactoryData pDelta)
Change the service and/or interface page from a data delta.The delta is a
UnoFactoryDatastructured in the same way than the data used ininitialize(UnoFactoryData). The main difference is that only the changed data should be set. The according fields will be modified in the pages.The service inheritance and interface name and package are changed if the service module or name has changed. This doesn't apply if the service inheritance has been manually changed by the user.
- Specified by:
dataChangedin classWizardPageSet- Parameters:
pDelta- the data delta to update the pages with- See Also:
for details on how the delta should be structured
-
doFinish
public void doFinish(org.eclipse.core.runtime.IProgressMonitor pMonitor, org.eclipse.ui.IWorkbenchPage pActivePage)Performs the actions to run at the end of the wizard for the wizard set.Performs the changes needed by the wizard set. This method has to be called in the
IWizard.performFinish()method. For cleaner actions the actions performed by the wizard set finish should concern only the data defined by the wizard set pages.The active page is often needed by the
UnoFactoryto open a newly created file in the workbench.This method should be overridden by the subclasses. The default method doesn't perform any action.
- Specified by:
doFinishin classWizardPageSet- Parameters:
pMonitor- the monitor used to follow the finish process.pActivePage- the page that was active before opening the wizard.- See Also:
for more informations on actions performed when finishing a wizard.
-
-