org.povclipse2.wizards

Class WizardArchivePovClipseProjectResourceExportPage

java.lang.Object

WizardExportResourcesPage

org.povclipse2.wizards.WizardArchivePovClipseProjectResourceExportPage

public class WizardArchivePovClipseProjectResourceExportPage
extends WizardExportResourcesPage

Field Summary

Fields

Modifier and Type	Field and Description
protected Button	compressContentsCheckbox
protected Button	createDirectoryStructureButton
protected Button	createSelectionOnlyButton
protected Button	overwriteExistingFilesCheckbox

Constructor Summary

Constructors

Modifier	Constructor and Description
	WizardArchivePovClipseProjectResourceExportPage(IStructuredSelection selection) Create an instance of this class.
protected	WizardArchivePovClipseProjectResourceExportPage(java.lang.String name, IStructuredSelection selection) Create an instance of this class

Method Summary

Modifier and Type	Method and Description
protected void	addDestinationItem(java.lang.String value) Add the passed value to self's destination widget's history
protected void	checkResource(IResource exportResource, int leadupDepth)
void	createControl(Composite parent) (non-Javadoc) Method declared on IDialogPage.
protected void	createDestinationGroup(Composite parent) Create the export destination specification widgets
protected void	createDirectoryStructureOptions(Composite optionsGroup, Font font) Create the buttons for the group that determine if the entire or selected directory structure should be created.
protected void	createFileFormatOptions(Composite optionsGroup, Font font) Create the buttons for the group that determine if the entire or selected directory structure should be created.
protected void	createOptionsGroupButtons(Group optionsGroup) Create the export options specification widgets.
protected boolean	ensureArchiveIsComplete() Checks if all neccessary project files and folders are selected to be exported by the user. If not the user is aksed to confirm the export despite the missing project files.
protected boolean	ensureDirectoryExists(java.io.File directory) Attempts to ensure that the specified directory exists on the local file system.
protected boolean	ensureTargetDirectoryIsValid(java.lang.String fullPathname) Returns a boolean indicating whether the directory portion of the passed pathname is valid and available for use.
protected boolean	ensureTargetFileIsValid(java.io.File targetFile) Returns a boolean indicating whether the passed File handle is is valid and available for use.
protected boolean	ensureTargetIsValid() Ensures that the target output file and its containing directory are both valid and able to be used.
protected boolean	ensureTargetIsValid(java.io.File targetDirectory) If the target for export does not exist then attempt to create it.
protected boolean	executeExportOperation(ArchiveFileExportOperation op) Export the passed resource and recursively export all of its child resources (iff it's a container).
boolean	finish() The Finish button was pressed.
protected java.lang.String	getDestinationLabel() Answer the string to display in the receiver as the destination type
protected java.lang.String	getDestinationValue() Answer the contents of self's destination specification widget.
protected java.lang.String	getOutputSuffix() Answer the suffix that files exported from this wizard should have.
protected void	giveFocusToDestination() Set the current input focus to self's destination entry field
protected void	handleDestinationBrowseButtonPressed() Open an appropriate destination browser so that the user can specify a source to import from
void	handleEvent(Event e) Handle all events and enablements for widgets in this page
protected void	internalSaveWidgetValues() Hook method for saving widget values for restoration by the next instance of this class.
protected void	restoreWidgetValues() Hook method for restoring widget values to the values that they held last time this wizard was used to completion.
protected void	setDestinationValue(java.lang.String value) Set the contents of the receivers destination specification widget to the passed value
protected void	setupHitMap() Adds all the project critical resources to the hitMap.
protected boolean	validateDestinationGroup() Answer a boolean indicating whether the receivers destination specification widgets currently all contain valid values.
protected boolean	validateSourceGroup()

Methods inherited from class java.lang.Object

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

Field Detail

overwriteExistingFilesCheckbox

protected Button overwriteExistingFilesCheckbox

createDirectoryStructureButton

protected Button createDirectoryStructureButton

createSelectionOnlyButton

protected Button createSelectionOnlyButton

compressContentsCheckbox

protected Button compressContentsCheckbox

Constructor Detail

WizardArchivePovClipseProjectResourceExportPage

protected WizardArchivePovClipseProjectResourceExportPage(java.lang.String name,
                                                          IStructuredSelection selection)

Create an instance of this class

WizardArchivePovClipseProjectResourceExportPage

public WizardArchivePovClipseProjectResourceExportPage(IStructuredSelection selection)

Create an instance of this class.

Parameters:

selection - the selection

Method Detail

addDestinationItem

protected void addDestinationItem(java.lang.String value)

Add the passed value to self's destination widget's history

Parameters:

value - java.lang.String

createControl

public void createControl(Composite parent)

(non-Javadoc) Method declared on IDialogPage.

createDestinationGroup

protected void createDestinationGroup(Composite parent)

Create the export destination specification widgets

Parameters:

parent - org.eclipse.swt.widgets.Composite

createOptionsGroupButtons

protected void createOptionsGroupButtons(Group optionsGroup)

Create the export options specification widgets.

createFileFormatOptions

protected void createFileFormatOptions(Composite optionsGroup,
                                       Font font)

Create the buttons for the group that determine if the entire or selected directory structure should be created.

Parameters:

optionsGroup -

font -

createDirectoryStructureOptions

protected void createDirectoryStructureOptions(Composite optionsGroup,
                                               Font font)

Create the buttons for the group that determine if the entire or selected directory structure should be created.

Parameters:

optionsGroup -

font -

ensureDirectoryExists

protected boolean ensureDirectoryExists(java.io.File directory)

Attempts to ensure that the specified directory exists on the local file system. Answers a boolean indicating success.

Parameters:

directory - java.io.File

Returns:

boolean

ensureTargetIsValid

protected boolean ensureTargetIsValid(java.io.File targetDirectory)

If the target for export does not exist then attempt to create it. Answer a boolean indicating whether the target exists (ie.- if it either pre-existed or this method was able to create it)

Returns:

boolean

finish

public boolean finish()

The Finish button was pressed. Try to do the required work now and answer a boolean indicating success. If false is returned then the wizard will not close.

getDestinationLabel

protected java.lang.String getDestinationLabel()

Answer the string to display in the receiver as the destination type

getDestinationValue

protected java.lang.String getDestinationValue()

Answer the contents of self's destination specification widget. If this value does not have a suffix then add it first.

giveFocusToDestination

protected void giveFocusToDestination()

Set the current input focus to self's destination entry field

handleDestinationBrowseButtonPressed

protected void handleDestinationBrowseButtonPressed()

Open an appropriate destination browser so that the user can specify a source to import from

handleEvent

public void handleEvent(Event e)

Handle all events and enablements for widgets in this page

Parameters:

e - Event

internalSaveWidgetValues

protected void internalSaveWidgetValues()

Hook method for saving widget values for restoration by the next instance of this class.

restoreWidgetValues

protected void restoreWidgetValues()

Hook method for restoring widget values to the values that they held last time this wizard was used to completion.

setDestinationValue

protected void setDestinationValue(java.lang.String value)

Set the contents of the receivers destination specification widget to the passed value

validateSourceGroup

protected boolean validateSourceGroup()

validateDestinationGroup

protected boolean validateDestinationGroup()

Answer a boolean indicating whether the receivers destination specification widgets currently all contain valid values.

See Also:

org.eclipse.ui.dialogs.WizardDataTransferPage#validateDestinationGroup()

ensureTargetDirectoryIsValid

protected boolean ensureTargetDirectoryIsValid(java.lang.String fullPathname)

Returns a boolean indicating whether the directory portion of the passed pathname is valid and available for use.

ensureTargetFileIsValid

protected boolean ensureTargetFileIsValid(java.io.File targetFile)

Returns a boolean indicating whether the passed File handle is is valid and available for use.

setupHitMap

protected void setupHitMap()

Adds all the project critical resources to the hitMap.

ensureArchiveIsComplete

protected boolean ensureArchiveIsComplete()

Checks if all neccessary project files and folders are selected to be exported by the user.
If not the user is aksed to confirm the export despite the missing project files.

Returns:

true if the export is to be done, false if it shall be skipped.

checkResource

protected void checkResource(IResource exportResource,
                             int leadupDepth)

Parameters:

exportResource -

leadupDepth -

errorMessages -

ensureTargetIsValid

protected boolean ensureTargetIsValid()

Ensures that the target output file and its containing directory are both valid and able to be used. Answer a boolean indicating validity.

executeExportOperation

protected boolean executeExportOperation(ArchiveFileExportOperation op)

Export the passed resource and recursively export all of its child resources (iff it's a container). Answer a boolean indicating success.

getOutputSuffix

protected java.lang.String getOutputSuffix()

Answer the suffix that files exported from this wizard should have. If this suffix is a file extension (which is typically the case) then it must include the leading period character.