A massive organize imports and formatting of the sources using default Eclipse code...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / dialogs / AbstractElementListSelectionDialog.java
index ecc06af..103f5e5 100644 (file)
@@ -23,129 +23,152 @@ import org.eclipse.swt.widgets.Text;
 /**
  * An abstract class to select elements out of a list of elements.
  */
-public abstract class AbstractElementListSelectionDialog extends SelectionStatusDialog {
-       
+public abstract class AbstractElementListSelectionDialog extends
+               SelectionStatusDialog {
+
        private ILabelProvider fRenderer;
-       private boolean fIgnoreCase= true;
-       private boolean fIsMultipleSelection= false;
-       private boolean fMatchEmptyString= true;
-       private boolean fAllowDuplicates= true;
-       
+
+       private boolean fIgnoreCase = true;
+
+       private boolean fIsMultipleSelection = false;
+
+       private boolean fMatchEmptyString = true;
+
+       private boolean fAllowDuplicates = true;
+
        private Label fMessage;
 
        protected FilteredList fFilteredList;
+
        private Text fFilterText;
-       
-       private ISelectionValidator fValidator; 
-       private String fFilter= null;
-       
-       private String fEmptyListMessage= ""; //$NON-NLS-1$
-       private String fEmptySelectionMessage= ""; //$NON-NLS-1$
-               
-       private int fWidth= 60;
-       private int fHeight= 18;
-       
-       private Object[] fSelection= new Object[0];
-       
+
+       private ISelectionValidator fValidator;
+
+       private String fFilter = null;
+
+       private String fEmptyListMessage = ""; //$NON-NLS-1$
+
+       private String fEmptySelectionMessage = ""; //$NON-NLS-1$
+
+       private int fWidth = 60;
+
+       private int fHeight = 18;
+
+       private Object[] fSelection = new Object[0];
+
        /**
         * Constructs a list selection dialog.
-        * @param renderer The label renderer used
-        * @param ignoreCase Decides if the match string ignores lower/upppr case
-        * @param multipleSelection Allow multiple selection     
+        * 
+        * @param renderer
+        *            The label renderer used
+        * @param ignoreCase
+        *            Decides if the match string ignores lower/upppr case
+        * @param multipleSelection
+        *            Allow multiple selection
         */
-       protected AbstractElementListSelectionDialog(Shell parent, ILabelProvider renderer)
-       {
-               super(parent);          
-               fRenderer= renderer;
-               
-               int shellStyle= getShellStyle();
+       protected AbstractElementListSelectionDialog(Shell parent,
+                       ILabelProvider renderer) {
+               super(parent);
+               fRenderer = renderer;
+
+               int shellStyle = getShellStyle();
                setShellStyle(shellStyle | SWT.MAX | SWT.RESIZE);
        }
 
        /**
-        * Handles default selection (double click).
-        * By default, the OK button is pressed.
-        */     
+        * Handles default selection (double click). By default, the OK button is
+        * pressed.
+        */
        protected void handleDefaultSelected() {
                if (validateCurrentSelection())
                        buttonPressed(IDialogConstants.OK_ID);
        }
-       
+
        /**
         * Specifies if sorting, filtering and folding is case sensitive.
         */
        public void setIgnoreCase(boolean ignoreCase) {
-               fIgnoreCase= ignoreCase;
+               fIgnoreCase = ignoreCase;
        }
-       
+
        /**
         * Returns if sorting, filtering and folding is case sensitive.
         */
        public boolean isCaseIgnored() {
                return fIgnoreCase;
        }
-       
+
        /**
-        * Specifies whether everything or nothing should be filtered on
-        * empty filter string.
+        * Specifies whether everything or nothing should be filtered on empty
+        * filter string.
         */
        public void setMatchEmptyString(boolean matchEmptyString) {
-               fMatchEmptyString= matchEmptyString;
+               fMatchEmptyString = matchEmptyString;
        }
-       
+
        /**
         * Specifies if multiple selection is allowed.
         */
        public void setMultipleSelection(boolean multipleSelection) {
-               fIsMultipleSelection= multipleSelection;
+               fIsMultipleSelection = multipleSelection;
        }
 
        /**
         * Specifies whether duplicate entries are displayed or not.
         */
        public void setAllowDuplicates(boolean allowDuplicates) {
-               fAllowDuplicates= allowDuplicates;
+               fAllowDuplicates = allowDuplicates;
        }
-       
+
        /**
         * Sets the list size in unit of characters.
-        * @param width  the width of the list.
-        * @param height the height of the list.
+        * 
+        * @param width
+        *            the width of the list.
+        * @param height
+        *            the height of the list.
         */
        public void setSize(int width, int height) {
-               fWidth= width;
-               fHeight= height;
+               fWidth = width;
+               fHeight = height;
        }
-       
+
        /**
         * Sets the message to be displayed if the list is empty.
-        * @param message the message to be displayed.
+        * 
+        * @param message
+        *            the message to be displayed.
         */
        public void setEmptyListMessage(String message) {
-               fEmptyListMessage= message;
+               fEmptyListMessage = message;
        }
 
        /**
         * Sets the message to be displayed if the selection is empty.
-        * @param message the message to be displayed.
+        * 
+        * @param message
+        *            the message to be displayed.
         */
        public void setEmptySelectionMessage(String message) {
-               fEmptySelectionMessage= message;
+               fEmptySelectionMessage = message;
        }
-       
+
        /**
-        * Sets an optional validator to check if the selection is valid.
-        * The validator is invoked whenever the selection changes.
-        * @param validator the validator to validate the selection.
+        * Sets an optional validator to check if the selection is valid. The
+        * validator is invoked whenever the selection changes.
+        * 
+        * @param validator
+        *            the validator to validate the selection.
         */
        public void setValidator(ISelectionValidator validator) {
-               fValidator= validator;
-       }       
-       
+               fValidator = validator;
+       }
+
        /**
-        * Sets the elements of the list (widget).
-        * To be called within open().
-        * @param elements the elements of the list.
+        * Sets the elements of the list (widget). To be called within open().
+        * 
+        * @param elements
+        *            the elements of the list.
         */
        protected void setListElements(Object[] elements) {
                Assert.isNotNull(fFilteredList);
@@ -154,18 +177,22 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
 
        /**
         * Sets the filter pattern.
-        * @param filter the filter pattern.
+        * 
+        * @param filter
+        *            the filter pattern.
         */
        public void setFilter(String filter) {
                if (fFilterText == null)
-                       fFilter= filter;
+                       fFilter = filter;
                else
                        fFilterText.setText(filter);
-       } 
-       
+       }
+
        /**
         * Returns the current filter pattern.
-        * @return returns the current filter pattern or <code>null<code> if filter was not set.
+        * 
+        * @return returns the current filter pattern or
+        *         <code>null<code> if filter was not set.
         */
        public String getFilter() {
                if (fFilteredList == null)
@@ -175,8 +202,9 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
        }
 
        /**
-        * Returns the indices referring the current selection.
-        * To be called within open().
+        * Returns the indices referring the current selection. To be called within
+        * open().
+        * 
         * @return returns the indices of the current selection.
         */
        protected int[] getSelectionIndices() {
@@ -185,30 +213,34 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
        }
 
        /**
-        * Returns an index referring the first current selection.
-        * To be called within open().
+        * Returns an index referring the first current selection. To be called
+        * within open().
+        * 
         * @return returns the indices of the current selection.
         */
        protected int getSelectionIndex() {
                Assert.isNotNull(fFilteredList);
                return fFilteredList.getSelectionIndex();
        }
-       
+
        /**
-        * Sets the selection referenced by an array of elements.
-        * To be called within open().
-        * @param selection the indices of the selection.
+        * Sets the selection referenced by an array of elements. To be called
+        * within open().
+        * 
+        * @param selection
+        *            the indices of the selection.
         */
        protected void setSelection(Object[] selection) {
                Assert.isNotNull(fFilteredList);
                fFilteredList.setSelection(selection);
        }
-       
+
        /**
-        * Returns an array of the currently selected elements.
-        * To be called within or after open().
+        * Returns an array of the currently selected elements. To be called within
+        * or after open().
+        * 
         * @return returns an array of the currently selected elements.
-        */     
+        */
        protected Object[] getSelectedElements() {
                Assert.isNotNull(fFilteredList);
                return fFilteredList.getSelection();
@@ -216,67 +248,70 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
 
        /**
         * Returns all elements which are folded together to one entry in the list.
-        * @param  index the index selecting the entry in the list.
+        * 
+        * @param index
+        *            the index selecting the entry in the list.
         * @return returns an array of elements folded together.
         */
        public Object[] getFoldedElements(int index) {
                Assert.isNotNull(fFilteredList);
                return fFilteredList.getFoldedElements(index);
        }
-                
+
        /**
         * Creates the message text widget and sets layout data.
-        * @param composite the parent composite of the message area.
+        * 
+        * @param composite
+        *            the parent composite of the message area.
         */
        protected Label createMessageArea(Composite composite) {
-               Label label= super.createMessageArea(composite);
+               Label label = super.createMessageArea(composite);
 
-               GridData data= new GridData();
-               data.grabExcessVerticalSpace= false;
-               data.grabExcessHorizontalSpace= true;
-               data.horizontalAlignment= GridData.FILL;
-               data.verticalAlignment= GridData.BEGINNING;
+               GridData data = new GridData();
+               data.grabExcessVerticalSpace = false;
+               data.grabExcessHorizontalSpace = true;
+               data.horizontalAlignment = GridData.FILL;
+               data.verticalAlignment = GridData.BEGINNING;
                label.setLayoutData(data);
-               
-               fMessage= label;
-               
+
+               fMessage = label;
+
                return label;
-       }       
+       }
 
        /**
-        * Handles a selection changed event.
-        * By default, the current selection is validated.
+        * Handles a selection changed event. By default, the current selection is
+        * validated.
         */
        protected void handleSelectionChanged() {
                validateCurrentSelection();
        }
-       
+
        /**
-        * Validates the current selection and updates the status line
-        * accordingly.
+        * Validates the current selection and updates the status line accordingly.
         */
        protected boolean validateCurrentSelection() {
                Assert.isNotNull(fFilteredList);
 
                IStatus status;
-               Object[] elements= getSelectedElements();
+               Object[] elements = getSelectedElements();
 
                if (elements.length > 0) {
                        if (fValidator != null) {
-                               status= fValidator.validate(elements);
+                               status = fValidator.validate(elements);
                        } else {
-                               status= new StatusInfo();
+                               status = new StatusInfo();
                        }
-               } else {                        
+               } else {
                        if (fFilteredList.isEmpty()) {
-                               status= new StatusInfo(IStatus.ERROR, fEmptyListMessage);
+                               status = new StatusInfo(IStatus.ERROR, fEmptyListMessage);
                        } else {
-                               status= new StatusInfo(IStatus.ERROR, fEmptySelectionMessage);
+                               status = new StatusInfo(IStatus.ERROR, fEmptySelectionMessage);
                        }
                }
 
                updateStatus(status);
-               
+
                return status.isOK();
        }
 
@@ -286,80 +321,83 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
        protected void cancelPressed() {
                setResult(null);
                super.cancelPressed();
-       }       
+       }
 
        /**
         * Creates a filtered list.
-        * @param parent the parent composite.
+        * 
+        * @param parent
+        *            the parent composite.
         * @return returns the filtered list widget.
         */
        protected FilteredList createFilteredList(Composite parent) {
-               int flags= SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL |
-                       (fIsMultipleSelection ? SWT.MULTI : SWT.SINGLE);
-                       
-               FilteredList list= new FilteredList(parent, flags, fRenderer,
-                       fIgnoreCase, fAllowDuplicates, fMatchEmptyString);
-
-               GridData data= new GridData();
-               data.widthHint= convertWidthInCharsToPixels(fWidth);
-               data.heightHint= convertHeightInCharsToPixels(fHeight);
-               data.grabExcessVerticalSpace= true;
-               data.grabExcessHorizontalSpace= true;
-               data.horizontalAlignment= GridData.FILL;
-               data.verticalAlignment= GridData.FILL;
+               int flags = SWT.BORDER | SWT.V_SCROLL | SWT.H_SCROLL
+                               | (fIsMultipleSelection ? SWT.MULTI : SWT.SINGLE);
+
+               FilteredList list = new FilteredList(parent, flags, fRenderer,
+                               fIgnoreCase, fAllowDuplicates, fMatchEmptyString);
+
+               GridData data = new GridData();
+               data.widthHint = convertWidthInCharsToPixels(fWidth);
+               data.heightHint = convertHeightInCharsToPixels(fHeight);
+               data.grabExcessVerticalSpace = true;
+               data.grabExcessHorizontalSpace = true;
+               data.horizontalAlignment = GridData.FILL;
+               data.verticalAlignment = GridData.FILL;
                list.setLayoutData(data);
-               
+
                list.setFilter((fFilter == null ? "" : fFilter)); //$NON-NLS-1$         
 
                list.addSelectionListener(new SelectionListener() {
                        public void widgetDefaultSelected(SelectionEvent e) {
                                handleDefaultSelected();
                        }
+
                        public void widgetSelected(SelectionEvent e) {
                                handleWidgetSelected();
                        }
                });
 
-               fFilteredList= list;            
+               fFilteredList = list;
 
-               return list;            
+               return list;
        }
 
-       // 3515 
+       // 3515
        private void handleWidgetSelected() {
-               Object[] newSelection= fFilteredList.getSelection();
-               
+               Object[] newSelection = fFilteredList.getSelection();
+
                if (newSelection.length != fSelection.length) {
-                       fSelection= newSelection;
+                       fSelection = newSelection;
                        handleSelectionChanged();
                } else {
-                       for (int i= 0; i != newSelection.length; i++) {
+                       for (int i = 0; i != newSelection.length; i++) {
                                if (!newSelection[i].equals(fSelection[i])) {
-                                       fSelection= newSelection;
+                                       fSelection = newSelection;
                                        handleSelectionChanged();
                                        break;
                                }
                        }
-               }               
+               }
        }
 
        protected Text createFilterText(Composite parent) {
-               Text text= new Text(parent, SWT.BORDER);
+               Text text = new Text(parent, SWT.BORDER);
 
-               GridData data= new GridData();
-               data.grabExcessVerticalSpace= false;
-               data.grabExcessHorizontalSpace= true;
-               data.horizontalAlignment= GridData.FILL;
-               data.verticalAlignment= GridData.BEGINNING;
+               GridData data = new GridData();
+               data.grabExcessVerticalSpace = false;
+               data.grabExcessHorizontalSpace = true;
+               data.horizontalAlignment = GridData.FILL;
+               data.verticalAlignment = GridData.BEGINNING;
                text.setLayoutData(data);
 
                text.setText((fFilter == null ? "" : fFilter)); //$NON-NLS-1$
-               
-               Listener listener= new Listener() {
+
+               Listener listener = new Listener() {
                        public void handleEvent(Event e) {
                                fFilteredList.setFilter(fFilterText.getText());
                        }
-               };              
+               };
                text.addListener(SWT.Modify, listener);
 
                text.addKeyListener(new KeyListener() {
@@ -367,12 +405,13 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
                                if (e.keyCode == SWT.ARROW_DOWN)
                                        fFilteredList.setFocus();
                        }
-                       
-                       public void keyReleased(KeyEvent e) {}
+
+                       public void keyReleased(KeyEvent e) {
+                       }
                });
 
-               fFilterText= text;
-                               
+               fFilterText = text;
+
                return text;
        }
 
@@ -387,11 +426,11 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
                });
                return getReturnCode();
        }
-       
+
        private void access$superOpen() {
                super.open();
-       } 
-       
+       }
+
        /*
         * @see Window#create(Shell)
         */
@@ -400,22 +439,22 @@ public abstract class AbstractElementListSelectionDialog extends SelectionStatus
 
                Assert.isNotNull(fFilteredList);
 
-       if (fFilteredList.isEmpty()) {
-               handleEmptyList();
-       } else {
-               validateCurrentSelection();
+               if (fFilteredList.isEmpty()) {
+                       handleEmptyList();
+               } else {
+                       validateCurrentSelection();
                        fFilterText.selectAll();
                        fFilterText.setFocus();
-       }
+               }
        }
-       
+
        /**
         * Handles empty list by disabling widgets.
         */
        protected void handleEmptyList() {
-       fMessage.setEnabled(false);
-       fFilterText.setEnabled(false);
-       fFilteredList.setEnabled(false);                
+               fMessage.setEnabled(false);
+               fFilterText.setEnabled(false);
+               fFilteredList.setEnabled(false);
        }
-       
+
 }