org.eclipse.datatools.connectivity.oda.design.ui.wizards
Class DataSourceWizardPage
java.lang.Object
org.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.eclipse.datatools.connectivity.internal.ui.wizards.BaseWizardPage
org.eclipse.datatools.connectivity.ui.wizards.ConnectionProfileDetailsPage
org.eclipse.datatools.connectivity.oda.design.internal.ui.DataSourceWizardPageCore
org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSourceWizardPage
- All Implemented Interfaces:
- org.eclipse.datatools.connectivity.internal.ui.wizards.ISkippable, org.eclipse.datatools.connectivity.internal.ui.wizards.ISummaryDataSource, org.eclipse.datatools.connectivity.internal.ui.wizards.IWizardAction, org.eclipse.help.IContextProvider, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
- Direct Known Subclasses:
- FolderSelectionWizardPage
public abstract class DataSourceWizardPage
- extends org.eclipse.datatools.connectivity.oda.design.internal.ui.DataSourceWizardPageCore
The abstract base class for implementation of a customized
ODA data source wizard page.
An ODA data source UI extension must extend this to
provide customized wizard page with page control and related behavior.
This must be used as the base class of
the newWizard.class attribute defined in the
org.eclipse.datatools.connectivity.connectionProfile
extension point.
Fields inherited from interface org.eclipse.help.IContextProvider |
NONE, SELECTION |
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
ERROR, INFORMATION, NONE, WARNING |
Constructor Summary |
DataSourceWizardPage(java.lang.String pageName)
Constructor with single argument for wizard page name. |
DataSourceWizardPage(java.lang.String pageName,
java.lang.String title,
org.eclipse.jface.resource.ImageDescriptor titleImage)
|
Method Summary |
abstract java.util.Properties |
collectCustomProperties()
Returns custom properties updated with values
collected in custom wizard page(s). |
void |
createCustomControl(org.eclipse.swt.widgets.Composite parent)
|
abstract void |
createPageCustomControl(org.eclipse.swt.widgets.Composite parent)
Creates customized control for this wizard page under the
given parent composite. |
java.lang.String |
getOdaDataSourceId()
|
void |
refresh()
|
abstract void |
setInitialProperties(java.util.Properties dataSourceProps)
Sets the initial properties and values to initialize the
customized control of this wizard page. |
Methods inherited from class org.eclipse.datatools.connectivity.oda.design.internal.ui.DataSourceWizardPageCore |
createControl, dispose, finishDataSourceDesign, getNextPage, isPageComplete |
Methods inherited from class org.eclipse.datatools.connectivity.internal.ui.wizards.BaseWizardPage |
getSkippable, getSummaryData, onSetActive, onWizardNext, setNeedMediation, setSkippable |
Methods inherited from class org.eclipse.jface.wizard.WizardPage |
canFlipToNextPage, getImage, getName, getPreviousPage, getShell, getWizard, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString |
Methods inherited from class org.eclipse.jface.dialogs.DialogPage |
getControl, getDescription, getErrorMessage, getMessage, getMessageType, getTitle, performHelp, setMessage, setVisible |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible |
DataSourceWizardPage
public DataSourceWizardPage(java.lang.String pageName)
- Constructor with single argument for wizard page name.
This single-argument constructor is used by the
ODA data source wizard to create a custom wizard page.
Subclass may override to provide additional page attributes,
such as customized title, message, title image.
- Parameters:
pageName
- wizard page name
DataSourceWizardPage
public DataSourceWizardPage(java.lang.String pageName,
java.lang.String title,
org.eclipse.jface.resource.ImageDescriptor titleImage)
createPageCustomControl
public abstract void createPageCustomControl(org.eclipse.swt.widgets.Composite parent)
- Creates customized control for this wizard page under the
given parent composite.
- Parameters:
parent
- the parent composite
setInitialProperties
public abstract void setInitialProperties(java.util.Properties dataSourceProps)
- Sets the initial properties and values to initialize the
customized control of this wizard page.
This method may be called before #createPageCustomControl,
which should then initialize with these given properties.
- Parameters:
dataSourceProps
- custom properties of the extended
ODA data source
collectCustomProperties
public abstract java.util.Properties collectCustomProperties()
- Returns custom properties updated with values
collected in custom wizard page(s).
- Returns:
- a collection of custom properties; may be empty
refresh
public void refresh()
- Specified by:
refresh
in class org.eclipse.datatools.connectivity.oda.design.internal.ui.DataSourceWizardPageCore
createCustomControl
public void createCustomControl(org.eclipse.swt.widgets.Composite parent)
- Specified by:
createCustomControl
in class ConnectionProfileDetailsPage
getOdaDataSourceId
public java.lang.String getOdaDataSourceId()
- Overrides:
getOdaDataSourceId
in class org.eclipse.datatools.connectivity.oda.design.internal.ui.DataSourceWizardPageCore