A massive organize imports and formatting of the sources using default Eclipse code...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / obfuscator / export / WizardObfuscatorResourceExportPage1.java
index 2b0c9e2..bb5dd99 100644 (file)
@@ -9,7 +9,7 @@
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/
 package net.sourceforge.phpeclipse.obfuscator.export;
+
 import java.io.File;
 import java.lang.reflect.InvocationTargetException;
 import java.util.List;
@@ -40,71 +40,85 @@ import org.eclipse.swt.widgets.Widget;
 import org.eclipse.ui.dialogs.WizardExportResourcesPage;
 
 /**
- *     Page 1 of the base resource export-to-file-system Wizard
+ * Page 1 of the base resource export-to-file-system Wizard
  */
-/*package*/
-class WizardObfuscatorResourceExportPage1
-       extends WizardExportResourcesPage
-       implements Listener {
+/* package */
+class WizardObfuscatorResourceExportPage1 extends WizardExportResourcesPage
+               implements Listener {
 
        // widgets
        private Combo destinationNameField;
+
        private Button destinationBrowseButton;
+
        protected Button overwriteExistingFilesCheckbox;
-//     protected Button createDirectoryStructureButton;
-//     protected Button createSelectionOnlyButton;
+
+       // protected Button createDirectoryStructureButton;
+       // protected Button createSelectionOnlyButton;
 
        // constants
        private static final int SIZING_TEXT_FIELD_WIDTH = 250;
 
        // dialog store id constants
-       private static final String STORE_DESTINATION_NAMES_ID =
-               "WizardObfuscatorResourceExportPage1.STORE_DESTINATION_NAMES_ID";       //$NON-NLS-1$
-       private static final String STORE_OVERWRITE_EXISTING_FILES_ID =
-               "WizardObfuscatorResourceExportPage1.STORE_OVERWRITE_EXISTING_FILES_ID";        //$NON-NLS-1$
-//     private static final String STORE_CREATE_STRUCTURE_ID =
-//             "WizardObfuscatorResourceExportPage1.STORE_CREATE_STRUCTURE_ID";        //$NON-NLS-1$
-       //messages
-       private static final String SELECT_DESTINATION_MESSAGE = ObfuscatorExportMessages.getString("FileExport.selectDestinationMessage"); //$NON-NLS-1$
-       private static final String SELECT_DESTINATION_TITLE = ObfuscatorExportMessages.getString("FileExport.selectDestinationTitle"); //$NON-NLS-1$
+       private static final String STORE_DESTINATION_NAMES_ID = "WizardObfuscatorResourceExportPage1.STORE_DESTINATION_NAMES_ID"; //$NON-NLS-1$
+
+       private static final String STORE_OVERWRITE_EXISTING_FILES_ID = "WizardObfuscatorResourceExportPage1.STORE_OVERWRITE_EXISTING_FILES_ID"; //$NON-NLS-1$
+       // private static final String STORE_CREATE_STRUCTURE_ID =
+       // "WizardObfuscatorResourceExportPage1.STORE_CREATE_STRUCTURE_ID";
+       // //$NON-NLS-1$
+
+       // messages
+       private static final String SELECT_DESTINATION_MESSAGE = ObfuscatorExportMessages
+                       .getString("FileExport.selectDestinationMessage"); //$NON-NLS-1$
+
+       private static final String SELECT_DESTINATION_TITLE = ObfuscatorExportMessages
+                       .getString("FileExport.selectDestinationTitle"); //$NON-NLS-1$
+
        /**
-        *      Create an instance of this class
+        * Create an instance of this class
         */
-       protected WizardObfuscatorResourceExportPage1(
-               String name,
-               IStructuredSelection selection) {
+       protected WizardObfuscatorResourceExportPage1(String name,
+                       IStructuredSelection selection) {
                super(name, selection);
        }
+
        /**
-        *      Create an instance of this class
+        * Create an instance of this class
         */
        public WizardObfuscatorResourceExportPage1(IStructuredSelection selection) {
                this("fileSystemExportPage1", selection); //$NON-NLS-1$
-               setTitle(ObfuscatorExportMessages.getString("ObfuscatorTransfer.fileSystemTitle")); //$NON-NLS-1$
-               setDescription(ObfuscatorExportMessages.getString("FileExport.exportLocalFileSystem")); //$NON-NLS-1$
+               setTitle(ObfuscatorExportMessages
+                               .getString("ObfuscatorTransfer.fileSystemTitle")); //$NON-NLS-1$
+               setDescription(ObfuscatorExportMessages
+                               .getString("FileExport.exportLocalFileSystem")); //$NON-NLS-1$
        }
+
        /**
-        *      Add the passed value to self's destination widget's history
-        *
-        *      @param value java.lang.String
+        * Add the passed value to self's destination widget's history
+        * 
+        * @param value
+        *            java.lang.String
         */
        protected void addDestinationItem(String value) {
                destinationNameField.add(value);
        }
-       /** (non-Javadoc)
-        * Method declared on IDialogPage.
+
+       /**
+        * (non-Javadoc) Method declared on IDialogPage.
         */
        public void createControl(Composite parent) {
                super.createControl(parent);
                giveFocusToDestination();
-//             WorkbenchHelp.setHelp(
-//                     getControl(),
-//                     IDataTransferHelpContextIds.FILE_SYSTEM_EXPORT_WIZARD_PAGE);
+               // WorkbenchHelp.setHelp(
+               // getControl(),
+               // IDataTransferHelpContextIds.FILE_SYSTEM_EXPORT_WIZARD_PAGE);
        }
+
        /**
-        *      Create the export destination specification widgets
-        *
-        *      @param parent org.eclipse.swt.widgets.Composite
+        * Create the export destination specification widgets
+        * 
+        * @param parent
+        *            org.eclipse.swt.widgets.Composite
         */
        protected void createDestinationGroup(Composite parent) {
 
@@ -114,8 +128,7 @@ class WizardObfuscatorResourceExportPage1
                GridLayout layout = new GridLayout();
                layout.numColumns = 3;
                destinationSelectionGroup.setLayout(layout);
-               destinationSelectionGroup.setLayoutData(
-                       new GridData(
+               destinationSelectionGroup.setLayoutData(new GridData(
                                GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_FILL));
                destinationSelectionGroup.setFont(font);
 
@@ -124,21 +137,21 @@ class WizardObfuscatorResourceExportPage1
                destinationLabel.setFont(font);
 
                // destination name entry field
-               destinationNameField =
-                       new Combo(destinationSelectionGroup, SWT.SINGLE | SWT.BORDER);
+               destinationNameField = new Combo(destinationSelectionGroup, SWT.SINGLE
+                               | SWT.BORDER);
                destinationNameField.addListener(SWT.Modify, this);
                destinationNameField.addListener(SWT.Selection, this);
-               GridData data =
-                       new GridData(
-                               GridData.HORIZONTAL_ALIGN_FILL | GridData.GRAB_HORIZONTAL);
+               GridData data = new GridData(GridData.HORIZONTAL_ALIGN_FILL
+                               | GridData.GRAB_HORIZONTAL);
                data.widthHint = SIZING_TEXT_FIELD_WIDTH;
                destinationNameField.setLayoutData(data);
                destinationNameField.setFont(font);
 
                // destination browse button
-               destinationBrowseButton =
-                       new Button(destinationSelectionGroup, SWT.PUSH);
-               destinationBrowseButton.setText(ObfuscatorExportMessages.getString("ObfuscatorTransfer.browse")); //$NON-NLS-1$
+               destinationBrowseButton = new Button(destinationSelectionGroup,
+                               SWT.PUSH);
+               destinationBrowseButton.setText(ObfuscatorExportMessages
+                               .getString("ObfuscatorTransfer.browse")); //$NON-NLS-1$
                destinationBrowseButton.addListener(SWT.Selection, this);
                destinationBrowseButton.setFont(font);
                setButtonLayoutData(destinationBrowseButton);
@@ -155,63 +168,69 @@ class WizardObfuscatorResourceExportPage1
                Font font = optionsGroup.getFont();
                createOverwriteExisting(optionsGroup, font);
 
-//             createDirectoryStructureOptions(optionsGroup, font);
+               // createDirectoryStructureOptions(optionsGroup, font);
        }
 
        /**
-        * Create the buttons for the group that determine if the entire or
-        * selected directory structure should be created.
+        * Create the buttons for the group that determine if the entire or selected
+        * directory structure should be created.
+        * 
         * @param optionsGroup
         * @param font
         */
-//     protected void createDirectoryStructureOptions(
-//             Group optionsGroup,
-//             Font font) {
-//             // create directory structure radios
-//             createDirectoryStructureButton =
-//                     new Button(optionsGroup, SWT.RADIO | SWT.LEFT);
-//             createDirectoryStructureButton.setText(ObfuscatorExportMessages.getString("FileExport.createDirectoryStructure")); //$NON-NLS-1$
-//             createDirectoryStructureButton.setSelection(false);
-//             createDirectoryStructureButton.setFont(font);
-//
-//             // create directory structure radios
-//             createSelectionOnlyButton =
-//                     new Button(optionsGroup, SWT.RADIO | SWT.LEFT);
-//             createSelectionOnlyButton.setText(
-//                     ObfuscatorExportMessages.getString(
-//                             "FileExport.createSelectedDirectories"));//$NON-NLS-1$
-//             createSelectionOnlyButton.setSelection(true);
-//             createSelectionOnlyButton.setFont(font);
-//     }
-
+       // protected void createDirectoryStructureOptions(
+       // Group optionsGroup,
+       // Font font) {
+       // // create directory structure radios
+       // createDirectoryStructureButton =
+       // new Button(optionsGroup, SWT.RADIO | SWT.LEFT);
+       // createDirectoryStructureButton.setText(ObfuscatorExportMessages.getString("FileExport.createDirectoryStructure"));
+       // //$NON-NLS-1$
+       // createDirectoryStructureButton.setSelection(false);
+       // createDirectoryStructureButton.setFont(font);
+       //
+       // // create directory structure radios
+       // createSelectionOnlyButton =
+       // new Button(optionsGroup, SWT.RADIO | SWT.LEFT);
+       // createSelectionOnlyButton.setText(
+       // ObfuscatorExportMessages.getString(
+       // "FileExport.createSelectedDirectories"));//$NON-NLS-1$
+       // createSelectionOnlyButton.setSelection(true);
+       // createSelectionOnlyButton.setFont(font);
+       // }
        /**
         * Create the button for checking if we should ask if we are going to
         * overwrite existing files.
+        * 
         * @param optionsGroup
         * @param font
         */
        protected void createOverwriteExisting(Group optionsGroup, Font font) {
                // overwrite... checkbox
-               overwriteExistingFilesCheckbox =
-                       new Button(optionsGroup, SWT.CHECK | SWT.LEFT);
-               overwriteExistingFilesCheckbox.setText(ObfuscatorExportMessages.getString("ExportFile.overwriteExisting")); //$NON-NLS-1$
+               overwriteExistingFilesCheckbox = new Button(optionsGroup, SWT.CHECK
+                               | SWT.LEFT);
+               overwriteExistingFilesCheckbox.setText(ObfuscatorExportMessages
+                               .getString("ExportFile.overwriteExisting")); //$NON-NLS-1$
                overwriteExistingFilesCheckbox.setFont(font);
        }
 
        /**
-        * Attempts to ensure that the specified directory exists on the local file system.
-        * Answers a boolean indicating success.
-        *
+        * Attempts to ensure that the specified directory exists on the local file
+        * system. Answers a boolean indicating success.
+        * 
         * @return boolean
-        * @param directory java.io.File
+        * @param directory
+        *            java.io.File
         */
        protected boolean ensureDirectoryExists(File directory) {
                if (!directory.exists()) {
-                       if (!queryYesNoQuestion(ObfuscatorExportMessages.getString("ObfuscatorTransfer.createTargetDirectory"))) //$NON-NLS-1$
+                       if (!queryYesNoQuestion(ObfuscatorExportMessages
+                                       .getString("ObfuscatorTransfer.createTargetDirectory"))) //$NON-NLS-1$
                                return false;
 
                        if (!directory.mkdirs()) {
-                               displayErrorDialog(ObfuscatorExportMessages.getString("ObfuscatorTransfer.directoryCreationError")); //$NON-NLS-1$
+                               displayErrorDialog(ObfuscatorExportMessages
+                                               .getString("ObfuscatorTransfer.directoryCreationError")); //$NON-NLS-1$
                                giveFocusToDestination();
                                return false;
                        }
@@ -219,30 +238,34 @@ class WizardObfuscatorResourceExportPage1
 
                return true;
        }
+
        /**
-        *      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)
-        *
-        *      @return boolean
+        * 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)
+        * 
+        * @return boolean
         */
        protected boolean ensureTargetIsValid(File targetDirectory) {
                if (targetDirectory.exists() && !targetDirectory.isDirectory()) {
-                       displayErrorDialog(ObfuscatorExportMessages.getString("FileExport.directoryExists")); //$NON-NLS-1$
+                       displayErrorDialog(ObfuscatorExportMessages
+                                       .getString("FileExport.directoryExists")); //$NON-NLS-1$
                        giveFocusToDestination();
                        return false;
                }
 
                return ensureDirectoryExists(targetDirectory);
        }
+
        /**
-        *  Set up and execute the passed Operation.  Answer a boolean indicating success.
-        *
-        *  @return boolean
+        * Set up and execute the passed Operation. Answer a boolean indicating
+        * success.
+        * 
+        * @return boolean
         */
        protected boolean executeExportOperation(ObfuscatorExportOperation op) {
-//             op.setCreateLeadupStructure(
-//                     createDirectoryStructureButton.getSelection());
+               // op.setCreateLeadupStructure(
+               // createDirectoryStructureButton.getSelection());
                op.setOverwriteFiles(overwriteExistingFilesCheckbox.getSelection());
 
                try {
@@ -256,20 +279,23 @@ class WizardObfuscatorResourceExportPage1
 
                IStatus status = op.getStatus();
                if (!status.isOK()) {
-                       ErrorDialog.openError(getContainer().getShell(), ObfuscatorExportMessages.getString("ObfuscatorTransfer.exportProblems"), //$NON-NLS-1$
-                       null, // no special message
-                       status);
+                       ErrorDialog.openError(getContainer().getShell(),
+                                       ObfuscatorExportMessages
+                                                       .getString("ObfuscatorTransfer.exportProblems"), //$NON-NLS-1$
+                                       null, // no special message
+                                       status);
                        return false;
                }
 
                return true;
        }
+
        /**
-        *      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.
-        *
-        *      @return boolean
+        * 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.
+        * 
+        * @return boolean
         */
        public boolean finish() {
                if (!ensureTargetIsValid(new File(getDestinationValue())))
@@ -277,53 +303,55 @@ class WizardObfuscatorResourceExportPage1
 
                List resourcesToExport = getWhiteCheckedResources();
 
-               //Save dirty editors if possible but do not stop if not all are saved
+               // Save dirty editors if possible but do not stop if not all are saved
                saveDirtyEditors();
                // about to invoke the operation so save our state
                saveWidgetValues();
 
                if (resourcesToExport.size() > 0)
-                       return executeExportOperation(
-                               new ObfuscatorExportOperation(
-                                       null,
-                                       resourcesToExport,
-                                       getDestinationValue(),
-                                       this));
+                       return executeExportOperation(new ObfuscatorExportOperation(null,
+                                       resourcesToExport, getDestinationValue(), this));
 
-               MessageDialog.openInformation(getContainer().getShell(), ObfuscatorExportMessages.getString("ObfuscatorTransfer.information"), //$NON-NLS-1$
-               ObfuscatorExportMessages.getString("FileExport.noneSelected")); //$NON-NLS-1$
+               MessageDialog.openInformation(getContainer().getShell(),
+                               ObfuscatorExportMessages
+                                               .getString("ObfuscatorTransfer.information"), //$NON-NLS-1$
+                               ObfuscatorExportMessages.getString("FileExport.noneSelected")); //$NON-NLS-1$
 
                return false;
        }
+
        /**
-        *      Answer the string to display in self as the destination type
-        *
-        *      @return java.lang.String
+        * Answer the string to display in self as the destination type
+        * 
+        * @return java.lang.String
         */
        protected String getDestinationLabel() {
                return ObfuscatorExportMessages.getString("FileExport.toDirectory"); //$NON-NLS-1$
        }
+
        /**
-        *      Answer the contents of self's destination specification widget
-        *
-        *      @return java.lang.String
+        * Answer the contents of self's destination specification widget
+        * 
+        * @return java.lang.String
         */
        protected String getDestinationValue() {
                return destinationNameField.getText().trim();
        }
+
        /**
-        *      Set the current input focus to self's destination entry field
+        * Set the current input focus to self's destination entry field
         */
        protected void giveFocusToDestination() {
                destinationNameField.setFocus();
        }
+
        /**
-        *      Open an appropriate destination browser so that the user can specify a source
-        *      to import from
+        * Open an appropriate destination browser so that the user can specify a
+        * source to import from
         */
        protected void handleDestinationBrowseButtonPressed() {
-               DirectoryDialog dialog =
-                       new DirectoryDialog(getContainer().getShell(), SWT.SAVE);
+               DirectoryDialog dialog = new DirectoryDialog(getContainer().getShell(),
+                               SWT.SAVE);
                dialog.setMessage(SELECT_DESTINATION_MESSAGE);
                dialog.setText(SELECT_DESTINATION_TITLE);
                dialog.setFilterPath(getDestinationValue());
@@ -334,9 +362,12 @@ class WizardObfuscatorResourceExportPage1
                        setDestinationValue(selectedDirectoryName);
                }
        }
+
        /**
         * Handle all events and enablements for widgets in this page
-        * @param e Event
+        * 
+        * @param e
+        *            Event
         */
        public void handleEvent(Event e) {
                Widget source = e.widget;
@@ -346,43 +377,43 @@ class WizardObfuscatorResourceExportPage1
 
                updatePageCompletion();
        }
+
        /**
-        *      Hook method for saving widget values for restoration by the next instance
-        *      of this class.
+        * Hook method for saving widget values for restoration by the next instance
+        * of this class.
         */
        protected void internalSaveWidgetValues() {
                // update directory names history
                IDialogSettings settings = getDialogSettings();
                if (settings != null) {
-                       String[] directoryNames =
-                               settings.getArray(STORE_DESTINATION_NAMES_ID);
+                       String[] directoryNames = settings
+                                       .getArray(STORE_DESTINATION_NAMES_ID);
                        if (directoryNames == null)
                                directoryNames = new String[0];
 
-                       directoryNames =
-                               addToHistory(directoryNames, getDestinationValue());
+                       directoryNames = addToHistory(directoryNames, getDestinationValue());
                        settings.put(STORE_DESTINATION_NAMES_ID, directoryNames);
 
                        // options
-                       settings.put(
-                               STORE_OVERWRITE_EXISTING_FILES_ID,
-                               overwriteExistingFilesCheckbox.getSelection());
+                       settings.put(STORE_OVERWRITE_EXISTING_FILES_ID,
+                                       overwriteExistingFilesCheckbox.getSelection());
 
-//                     settings.put(
-//                             STORE_CREATE_STRUCTURE_ID,
-//                             createDirectoryStructureButton.getSelection());
+                       // settings.put(
+                       // STORE_CREATE_STRUCTURE_ID,
+                       // createDirectoryStructureButton.getSelection());
 
                }
        }
+
        /**
-        *      Hook method for restoring widget values to the values that they held
-        *      last time this wizard was used to completion.
+        * Hook method for restoring widget values to the values that they held last
+        * time this wizard was used to completion.
         */
        protected void restoreWidgetValues() {
                IDialogSettings settings = getDialogSettings();
                if (settings != null) {
-                       String[] directoryNames =
-                               settings.getArray(STORE_DESTINATION_NAMES_ID);
+                       String[] directoryNames = settings
+                                       .getArray(STORE_DESTINATION_NAMES_ID);
                        if (directoryNames == null)
                                return; // ie.- no settings stored
 
@@ -392,26 +423,28 @@ class WizardObfuscatorResourceExportPage1
                                addDestinationItem(directoryNames[i]);
 
                        // options
-                       overwriteExistingFilesCheckbox.setSelection(
-                               settings.getBoolean(STORE_OVERWRITE_EXISTING_FILES_ID));
+                       overwriteExistingFilesCheckbox.setSelection(settings
+                                       .getBoolean(STORE_OVERWRITE_EXISTING_FILES_ID));
 
-//                     boolean createDirectories =
-//                             settings.getBoolean(STORE_CREATE_STRUCTURE_ID);
-//                     createDirectoryStructureButton.setSelection(createDirectories);
-//                     createSelectionOnlyButton.setSelection(!createDirectories);
+                       // boolean createDirectories =
+                       // settings.getBoolean(STORE_CREATE_STRUCTURE_ID);
+                       // createDirectoryStructureButton.setSelection(createDirectories);
+                       // createSelectionOnlyButton.setSelection(!createDirectories);
                }
        }
+
        /**
-        *      Set the contents of the receivers destination specification widget to
-        *      the passed value
-        *
+        * Set the contents of the receivers destination specification widget to the
+        * passed value
+        * 
         */
        protected void setDestinationValue(String value) {
                destinationNameField.setText(value);
        }
+
        /**
-        *      Answer a boolean indicating whether the receivers destination specification
-        *      widgets currently all contain valid values.
+        * Answer a boolean indicating whether the receivers destination
+        * specification widgets currently all contain valid values.
         */
        protected boolean validateDestinationGroup() {
                String destinationValue = getDestinationValue();
@@ -420,32 +453,34 @@ class WizardObfuscatorResourceExportPage1
                        return false;
                }
 
-               String conflictingContainer =
-                       getConflictingContainerNameFor(destinationValue);
+               String conflictingContainer = getConflictingContainerNameFor(destinationValue);
                if (conflictingContainer == null)
                        setErrorMessage(""); //$NON-NLS-1$
                else {
-                       setErrorMessage(ObfuscatorExportMessages.format("FileExport.conflictingContainer", //$NON-NLS-1$
-                       new Object[] { conflictingContainer }));
+                       setErrorMessage(ObfuscatorExportMessages.format(
+                                       "FileExport.conflictingContainer", //$NON-NLS-1$
+                                       new Object[] { conflictingContainer }));
                        giveFocusToDestination();
                        return false;
                }
 
                return true;
        }
-       
+
        /**
         * Get the message used to denote an empty destination.
         */
-       protected String destinationEmptyMessage(){
-               return ObfuscatorExportMessages.getString("FileExport.destinationEmpty"); //$NON-NLS-1$
+       protected String destinationEmptyMessage() {
+               return ObfuscatorExportMessages
+                               .getString("FileExport.destinationEmpty"); //$NON-NLS-1$
        }
 
        /**
-        * Returns the name of a container with a location that encompasses targetDirectory.
-        * Returns null if there is no conflict.
+        * Returns the name of a container with a location that encompasses
+        * targetDirectory. Returns null if there is no conflict.
         * 
-        * @param targetDirectory the path of the directory to check.
+        * @param targetDirectory
+        *            the path of the directory to check.
         * @return the conflicting container name or <code>null</code>
         */
        protected String getConflictingContainerNameFor(String targetDirectory) {