net.officefloor.eclipse.wizard.administratorsource
Class AdministratorSourceWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      net.officefloor.eclipse.wizard.administratorsource.AdministratorSourceWizard

All Implemented Interfaces:

AdministratorSourceInstanceContext, org.eclipse.jface.wizard.IWizard

public class AdministratorSourceWizard
extends org.eclipse.jface.wizard.Wizard
implements AdministratorSourceInstanceContext

IWizard to add and manage Administrator instances.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

AdministratorSourceWizard(org.eclipse.core.resources.IProject project)
Initiate to create a new AdministratorInstance.

AdministratorSourceWizard(org.eclipse.core.resources.IProject project, AdministratorInstance administratorInstance)
Initiate.

Method Summary

void	addPages()
boolean	canFinish()
static Map<String,AdministratorSourceInstance>	createAdministratorSourceInstanceMap(ClassLoader classLoader, org.eclipse.core.resources.IProject project, AdministratorSourceInstanceContext context) Creates the mapping of AdministratorSource class name to its AdministratorSourceInstance.
AdministratorInstance	getAdministratorInstance() Obtains the AdministratorInstance.
static AdministratorInstance	getAdministratorInstance(AbstractOfficeFloorEditPart<?,?,?> editPart, AdministratorInstance administratorInstance) Facade method to obtain the AdministratorInstance.
org.eclipse.jface.wizard.IWizardPage	getNextPage(org.eclipse.jface.wizard.IWizardPage page)
boolean	performFinish()
void	setAdministratorTypeLoaded(boolean isAdministratorTypeLoaded) Flags if AdministratorType is loaded.
void	setErrorMessage(String message) Specifies an error message.
void	setTitle(String title) Specifies the title.

Methods inherited from class org.eclipse.jface.wizard.Wizard

addPage, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdministratorSourceWizard

public AdministratorSourceWizard(org.eclipse.core.resources.IProject project)

Initiate to create a new AdministratorInstance.

Parameters:

project - IProject.

AdministratorSourceWizard

public AdministratorSourceWizard(org.eclipse.core.resources.IProject project,
                                 AdministratorInstance administratorInstance)

Initiate.

Parameters:

project - IProject.

administratorInstance - AdministratorInstance to be edited, or null to create a new AdministratorInstance.

Method Detail

getAdministratorInstance

public static AdministratorInstance getAdministratorInstance(AbstractOfficeFloorEditPart<?,?,?> editPart,
                                                             AdministratorInstance administratorInstance)

Facade method to obtain the AdministratorInstance.

Parameters:

editPart - AbstractOfficeFloorEditPart to obtain necessary objects to run the AdministratorSourceWizard.

administratorInstance - AdministratorInstance to based decisions. null if creating new AdministratorInstance.

Returns:

AdministratorInstance or null if cancelled.

createAdministratorSourceInstanceMap

public static Map<String,AdministratorSourceInstance> createAdministratorSourceInstanceMap(ClassLoader classLoader,
                                                                                           org.eclipse.core.resources.IProject project,
                                                                                           AdministratorSourceInstanceContext context)

Creates the mapping of AdministratorSource class name to its AdministratorSourceInstance.

Parameters:

classLoader - ClassLoader.

project - IProject.

context - AdministratorSourceInstanceContext.

Returns:

Mapping of AdministratorSource class name to its AdministratorSourceInstance.

getAdministratorInstance

public AdministratorInstance getAdministratorInstance()

Obtains the AdministratorInstance.

Returns:

AdministratorInstance.

addPages

public void addPages()

Specified by:

addPages in interface org.eclipse.jface.wizard.IWizard

Overrides:

addPages in class org.eclipse.jface.wizard.Wizard

getNextPage

public org.eclipse.jface.wizard.IWizardPage getNextPage(org.eclipse.jface.wizard.IWizardPage page)

Specified by:

getNextPage in interface org.eclipse.jface.wizard.IWizard

Overrides:

getNextPage in class org.eclipse.jface.wizard.Wizard

canFinish

public boolean canFinish()

Specified by:

canFinish in interface org.eclipse.jface.wizard.IWizard

Overrides:

canFinish in class org.eclipse.jface.wizard.Wizard

performFinish

public boolean performFinish()

Specified by:

performFinish in interface org.eclipse.jface.wizard.IWizard

Specified by:

performFinish in class org.eclipse.jface.wizard.Wizard

setTitle

public void setTitle(String title)

Description copied from interface: AdministratorSourceInstanceContext

Specifies the title.

Specified by:

setTitle in interface AdministratorSourceInstanceContext

Parameters:

title - Title.

setErrorMessage

public void setErrorMessage(String message)

Description copied from interface: AdministratorSourceInstanceContext

Specifies an error message.

Specified by:

setErrorMessage in interface AdministratorSourceInstanceContext

Parameters:

message - Error message or null to indicate no error.

setAdministratorTypeLoaded

public void setAdministratorTypeLoaded(boolean isAdministratorTypeLoaded)

Description copied from interface: AdministratorSourceInstanceContext

Flags if AdministratorType is loaded.

Specified by:

setAdministratorTypeLoaded in interface AdministratorSourceInstanceContext