Class WizardDataTransferPage
- java.lang.Object
-
- org.eclipse.jface.dialogs.DialogPage
-
- org.eclipse.jface.wizard.WizardPage
-
- org.eclipse.ui.dialogs.WizardDataTransferPage
-
- All Implemented Interfaces:
IDialogPage,IMessageProvider,IWizardPage,Listener,IOverwriteQuery
- Direct Known Subclasses:
WizardExportPage,WizardExportResourcesPage,WizardImportPage,WizardResourceImportPage
public abstract class WizardDataTransferPage extends WizardPage implements Listener, IOverwriteQuery
The common superclass for wizard import and export pages.This class is not intended to be subclassed outside of the workbench.
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Field Summary
Fields Modifier and Type Field Description protected static intCOMBO_HISTORY_LENGTHprotected static intSIZING_TEXT_FIELD_WIDTH-
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedWizardDataTransferPage(String pageName)Creates a new wizard page.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected String[]addToHistory(String[] history, String newEntry)Adds an entry to a history, while taking care of duplicate history items and excessively long histories.protected voidaddToHistory(List history, String newEntry)Adds an entry to a history, while taking care of duplicate history items and excessively long histories.protected abstract booleanallowNewContainerName()Return whether the user is allowed to enter a new container name or just choose from existing ones.protected LabelcreateBoldLabel(Composite parent, String text)Creates a new label with a bold font.protected voidcreateOptionsGroup(Composite parent)Create the options specification widgets.protected voidcreateOptionsGroupButtons(Group optionsGroup)Creates the import/export options group controls.protected LabelcreatePlainLabel(Composite parent, String text)Creates a new label with a bold font.protected voidcreateSpacer(Composite parent)Creates a horizontal spacer line that fills the width of its container.protected booleandeterminePageCompletion()Returns whether this page is complete.protected voiddisplayErrorDialog(String message)Display an error dialog with the specified message.protected voiddisplayErrorDialog(Throwable exception)Display an error dislog with the information from the supplied exception.protected StringgetErrorDialogTitle()Get the title for an error dialog.protected IPathgetPathFromText(Text textField)Get a path from the supplied text widget.protected IPathqueryForContainer(IContainer initialSelection, String msg)Queries the user to supply a container resource.protected IPathqueryForContainer(IContainer initialSelection, String msg, String title)Queries the user to supply a container resource.StringqueryOverwrite(String pathString)TheWizardDataTransferimplementation of thisIOverwriteQuerymethod asks the user whether the existing resource at the given path should be overwritten.protected booleanqueryYesNoQuestion(String message)Displays a Yes/No question to the user with the specified message and returns the user's response.protected voidrestoreWidgetValues()Restores control settings that were saved in the previous instance of this page.protected voidsaveWidgetValues()Saves control settings that are to be restored in the next instance of this page.protected voidupdatePageCompletion()Determine if the page is complete and update the page appropriately.protected voidupdateWidgetEnablements()Updates the enable state of this page's controls.protected booleanvalidateDestinationGroup()Returns whether this page's destination specification controls currently all contain valid values.protected booleanvalidateOptionsGroup()Returns whether this page's options group's controls currently all contain valid values.protected booleanvalidateSourceGroup()Returns whether this page's source specification controls currently all contain valid values.-
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
-
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible
-
Methods inherited from interface org.eclipse.swt.widgets.Listener
handleEvent
-
-
-
-
Field Detail
-
SIZING_TEXT_FIELD_WIDTH
protected static final int SIZING_TEXT_FIELD_WIDTH
- See Also:
- Constant Field Values
-
COMBO_HISTORY_LENGTH
protected static final int COMBO_HISTORY_LENGTH
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WizardDataTransferPage
protected WizardDataTransferPage(String pageName)
Creates a new wizard page.- Parameters:
pageName- the name of the page
-
-
Method Detail
-
addToHistory
protected String[] addToHistory(String[] history, String newEntry)
Adds an entry to a history, while taking care of duplicate history items and excessively long histories. The assumption is made that all histories should be of lengthWizardDataTransferPage.COMBO_HISTORY_LENGTH.- Parameters:
history- the current historynewEntry- the entry to add to the history
-
addToHistory
protected void addToHistory(List history, String newEntry)
Adds an entry to a history, while taking care of duplicate history items and excessively long histories. The assumption is made that all histories should be of lengthWizardDataTransferPage.COMBO_HISTORY_LENGTH.- Parameters:
history- the current historynewEntry- the entry to add to the history
-
allowNewContainerName
protected abstract boolean allowNewContainerName()
Return whether the user is allowed to enter a new container name or just choose from existing ones.Subclasses must implement this method.
- Returns:
trueif new ones are okay, andfalseif only existing ones are allowed
-
createBoldLabel
protected Label createBoldLabel(Composite parent, String text)
Creates a new label with a bold font.- Parameters:
parent- the parent controltext- the label text- Returns:
- the new label control
-
createOptionsGroupButtons
protected void createOptionsGroupButtons(Group optionsGroup)
Creates the import/export options group controls.The
WizardDataTransferPageimplementation of this method does nothing. Subclasses wishing to define such components should reimplement this hook method.- Parameters:
optionsGroup- the parent control
-
createPlainLabel
protected Label createPlainLabel(Composite parent, String text)
Creates a new label with a bold font.- Parameters:
parent- the parent controltext- the label text- Returns:
- the new label control
-
createSpacer
protected void createSpacer(Composite parent)
Creates a horizontal spacer line that fills the width of its container.- Parameters:
parent- the parent control
-
determinePageCompletion
protected boolean determinePageCompletion()
Returns whether this page is complete. This determination is made based upon the current contents of this page's controls. Subclasses wishing to include their controls in this determination should override the hook methodsvalidateSourceGroupand/orvalidateOptionsGroup.- Returns:
trueif this page is complete, andfalseif incomplete- See Also:
validateSourceGroup(),validateOptionsGroup()
-
getPathFromText
protected IPath getPathFromText(Text textField)
Get a path from the supplied text widget.- Returns:
- org.eclipse.core.runtime.IPath
-
queryForContainer
protected IPath queryForContainer(IContainer initialSelection, String msg)
Queries the user to supply a container resource.- Returns:
- the path to an existing or new container, or
nullif the user cancelled the dialog
-
queryForContainer
protected IPath queryForContainer(IContainer initialSelection, String msg, String title)
Queries the user to supply a container resource.- Returns:
- the path to an existing or new container, or
nullif the user cancelled the dialog
-
queryOverwrite
public String queryOverwrite(String pathString)
TheWizardDataTransferimplementation of thisIOverwriteQuerymethod asks the user whether the existing resource at the given path should be overwritten.- Specified by:
queryOverwritein interfaceIOverwriteQuery- Parameters:
pathString- desired path which might be overwritten- Returns:
- the user's reply: one of
"YES","NO","ALL", or"CANCEL"
-
queryYesNoQuestion
protected boolean queryYesNoQuestion(String message)
Displays a Yes/No question to the user with the specified message and returns the user's response.- Parameters:
message- the question to ask- Returns:
truefor Yes, andfalsefor No
-
restoreWidgetValues
protected void restoreWidgetValues()
Restores control settings that were saved in the previous instance of this page.The
WizardDataTransferPageimplementation of this method does nothing. Subclasses may override this hook method.
-
saveWidgetValues
protected void saveWidgetValues()
Saves control settings that are to be restored in the next instance of this page.The
WizardDataTransferPageimplementation of this method does nothing. Subclasses may override this hook method.
-
updatePageCompletion
protected void updatePageCompletion()
Determine if the page is complete and update the page appropriately.
-
updateWidgetEnablements
protected void updateWidgetEnablements()
Updates the enable state of this page's controls.The
WizardDataTransferPageimplementation of this method does nothing. Subclasses may extend this hook method.
-
validateDestinationGroup
protected boolean validateDestinationGroup()
Returns whether this page's destination specification controls currently all contain valid values.The
WizardDataTransferPageimplementation of this method returnstrue. Subclasses may reimplement this hook method.- Returns:
trueindicating validity of all controls in the destination specification group
-
validateOptionsGroup
protected boolean validateOptionsGroup()
Returns whether this page's options group's controls currently all contain valid values.The
WizardDataTransferPageimplementation of this method returnstrue. Subclasses may reimplement this hook method.- Returns:
trueindicating validity of all controls in the options group
-
validateSourceGroup
protected boolean validateSourceGroup()
Returns whether this page's source specification controls currently all contain valid values.The
WizardDataTransferPageimplementation of this method returnstrue. Subclasses may reimplement this hook method.- Returns:
trueindicating validity of all controls in the source specification group
-
createOptionsGroup
protected void createOptionsGroup(Composite parent)
Create the options specification widgets.- Parameters:
parent- org.eclipse.swt.widgets.Composite
-
displayErrorDialog
protected void displayErrorDialog(String message)
Display an error dialog with the specified message.- Parameters:
message- the error message
-
displayErrorDialog
protected void displayErrorDialog(Throwable exception)
Display an error dislog with the information from the supplied exception.- Parameters:
exception- Throwable
-
getErrorDialogTitle
protected String getErrorDialogTitle()
Get the title for an error dialog. Subclasses should override.
-
-