org.eclipse.datatools.connectivity.ui.wizards
Class NewConnectionProfileWizard

java.lang.Object
  extended by org.eclipse.jface.wizard.Wizard
      extended by org.eclipse.datatools.connectivity.internal.ui.wizards.BaseWizard
          extended by org.eclipse.datatools.connectivity.ui.wizards.NewConnectionProfileWizard
All Implemented Interfaces:
org.eclipse.datatools.connectivity.internal.ui.wizards.IMediator, org.eclipse.datatools.connectivity.internal.ui.wizards.ISummaryDataSource, ICPWizard, org.eclipse.help.IContextProvider, org.eclipse.jface.wizard.IWizard, org.eclipse.ui.INewWizard, org.eclipse.ui.IWorkbenchWizard
Direct Known Subclasses:
ExtensibleNewConnectionProfileWizard, NewConnectionProfileWizard, org.eclipse.datatools.connectivity.oda.design.internal.ui.NewDataSourceWizardBase

public abstract class NewConnectionProfileWizard
extends org.eclipse.datatools.connectivity.internal.ui.wizards.BaseWizard
implements org.eclipse.ui.INewWizard, ICPWizard, org.eclipse.help.IContextProvider

Base connection profile wizard

Author:
shongxum

Nested Class Summary
static interface NewConnectionProfileWizard.IFinishTask
          Delegation of the wizard's performFinish task.
 
Field Summary
 
Fields inherited from class org.eclipse.jface.wizard.Wizard
DEFAULT_IMAGE
 
Fields inherited from interface org.eclipse.help.IContextProvider
NONE, SELECTION
 
Constructor Summary
NewConnectionProfileWizard()
           
 
Method Summary
abstract  void addCustomPages()
          Clients needs to add their customized pages here
 void addPages()
           
 void createPageControls(org.eclipse.swt.widgets.Composite pageContainer)
           
 void delegatesTask(NewConnectionProfileWizard.IFinishTask task)
           
 org.eclipse.help.IContext getContext(java.lang.Object target)
           
 int getContextChangeMask()
           
 java.lang.String getParentProfile()
          Clients may override this method to return the real parent profile
 java.lang.String getProfileDescription()
           
 boolean getProfileIsAutoConnect()
           
 java.lang.String getProfileName()
           
 NewConnectionProfileWizardPage getProfilePage()
           
abstract  java.util.Properties getProfileProperties()
          Clients need provide implementation to get extra profile properties
 java.lang.String getProfileProviderID()
           
 java.lang.String getSearchExpression(java.lang.Object target)
           
 java.util.List getSummaryData()
           
 void init(org.eclipse.ui.IWorkbench workbench, org.eclipse.jface.viewers.IStructuredSelection selection)
           
 void initProviderID(java.lang.String providerID)
           
 boolean isFinished()
           
 boolean isProfileNamePageSkippable()
           
 boolean performFinish()
          Clients need to make "return super.performFinish" as the last line of their code if they want to override this method
 void setParentProfile(IConnectionProfile profile)
           
 void setProfileDescription(java.lang.String desc)
           
 void setProfileName(java.lang.String name)
           
 void setProfileNameAndDescription()
           
 void setSkipProfileNamePage(boolean skippable)
           
 
Methods inherited from class org.eclipse.datatools.connectivity.internal.ui.wizards.BaseWizard
canFinish, getNextPage, getPreviousPage, getStartingPage, mediatePage
 
Methods inherited from class org.eclipse.jface.wizard.Wizard
addPage, dispose, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPages, getShell, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.wizard.IWizard
canFinish, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer
 

Constructor Detail

NewConnectionProfileWizard

public NewConnectionProfileWizard()
Method Detail

performFinish

public boolean performFinish()
Clients need to make "return super.performFinish" as the last line of their code if they want to override this method

Specified by:
performFinish in interface org.eclipse.jface.wizard.IWizard
Specified by:
performFinish in class org.eclipse.jface.wizard.Wizard
See Also:
Wizard.performFinish()

isFinished

public boolean isFinished()

init

public void init(org.eclipse.ui.IWorkbench workbench,
                 org.eclipse.jface.viewers.IStructuredSelection selection)
Specified by:
init in interface org.eclipse.ui.IWorkbenchWizard
See Also:
Wizard#init

initProviderID

public void initProviderID(java.lang.String providerID)
Specified by:
initProviderID in interface ICPWizard
See Also:
org.eclipse.datatools.connectivity.ui.wizards.ICPWizard#setProviderID(java.lang.String)

addCustomPages

public abstract void addCustomPages()
Clients needs to add their customized pages here


setProfileNameAndDescription

public void setProfileNameAndDescription()

getSummaryData

public java.util.List getSummaryData()
Specified by:
getSummaryData in interface org.eclipse.datatools.connectivity.internal.ui.wizards.ISummaryDataSource
Overrides:
getSummaryData in class org.eclipse.datatools.connectivity.internal.ui.wizards.BaseWizard

getProfileProviderID

public java.lang.String getProfileProviderID()

getProfileName

public java.lang.String getProfileName()

setProfileName

public void setProfileName(java.lang.String name)

setProfileDescription

public void setProfileDescription(java.lang.String desc)

getProfileDescription

public java.lang.String getProfileDescription()

getProfileIsAutoConnect

public boolean getProfileIsAutoConnect()

getProfileProperties

public abstract java.util.Properties getProfileProperties()
Clients need provide implementation to get extra profile properties

Returns:

getParentProfile

public java.lang.String getParentProfile()
Clients may override this method to return the real parent profile

Returns:

setParentProfile

public void setParentProfile(IConnectionProfile profile)
Specified by:
setParentProfile in interface ICPWizard

addPages

public void addPages()
Specified by:
addPages in interface org.eclipse.jface.wizard.IWizard
Overrides:
addPages in class org.eclipse.jface.wizard.Wizard

createPageControls

public void createPageControls(org.eclipse.swt.widgets.Composite pageContainer)
Specified by:
createPageControls in interface org.eclipse.jface.wizard.IWizard
Overrides:
createPageControls in class org.eclipse.jface.wizard.Wizard

getContext

public org.eclipse.help.IContext getContext(java.lang.Object target)
Specified by:
getContext in interface org.eclipse.help.IContextProvider

getContextChangeMask

public int getContextChangeMask()
Specified by:
getContextChangeMask in interface org.eclipse.help.IContextProvider

getSearchExpression

public java.lang.String getSearchExpression(java.lang.Object target)
Specified by:
getSearchExpression in interface org.eclipse.help.IContextProvider

setSkipProfileNamePage

public void setSkipProfileNamePage(boolean skippable)

isProfileNamePageSkippable

public boolean isProfileNamePageSkippable()

delegatesTask

public void delegatesTask(NewConnectionProfileWizard.IFinishTask task)

getProfilePage

public NewConnectionProfileWizardPage getProfilePage()