| /* |
| * Copyright (C) 2008 The Android Open Source Project |
| * |
| * Licensed under the Eclipse Public License, Version 1.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.eclipse.org/org/documents/epl-v10.php |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package com.android.ide.eclipse.adt.internal.editors.ui; |
| |
| import com.android.SdkConstants; |
| |
| import org.eclipse.core.runtime.Assert; |
| import org.eclipse.jface.viewers.DialogCellEditor; |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.events.FocusAdapter; |
| import org.eclipse.swt.events.FocusEvent; |
| import org.eclipse.swt.events.KeyAdapter; |
| import org.eclipse.swt.events.KeyEvent; |
| import org.eclipse.swt.events.ModifyEvent; |
| import org.eclipse.swt.events.ModifyListener; |
| import org.eclipse.swt.events.MouseAdapter; |
| import org.eclipse.swt.events.MouseEvent; |
| import org.eclipse.swt.events.SelectionAdapter; |
| import org.eclipse.swt.events.SelectionEvent; |
| import org.eclipse.swt.events.TraverseEvent; |
| import org.eclipse.swt.events.TraverseListener; |
| import org.eclipse.swt.widgets.Button; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| import org.eclipse.swt.widgets.Text; |
| |
| import java.text.MessageFormat; |
| |
| /** |
| * Custom DialogCellEditor, replacing the Label with an editable {@link Text} widget. |
| * <p/>Also set the button to {@link SWT#FLAT} to make sure it looks good on MacOS X. |
| * <p/>Most of the code comes from TextCellEditor. |
| */ |
| public abstract class EditableDialogCellEditor extends DialogCellEditor { |
| |
| private Text text; |
| |
| private ModifyListener modifyListener; |
| |
| /** |
| * State information for updating action enablement |
| */ |
| private boolean isSelection = false; |
| |
| private boolean isDeleteable = false; |
| |
| private boolean isSelectable = false; |
| |
| EditableDialogCellEditor(Composite parent) { |
| super(parent); |
| } |
| |
| /* |
| * Re-implement this method only to properly set the style in the button, or it won't look |
| * good in MacOS X |
| */ |
| @Override |
| protected Button createButton(Composite parent) { |
| Button result = new Button(parent, SWT.DOWN | SWT.FLAT); |
| result.setText("..."); //$NON-NLS-1$ |
| return result; |
| } |
| |
| |
| @Override |
| protected Control createContents(Composite cell) { |
| text = new Text(cell, SWT.SINGLE); |
| text.addSelectionListener(new SelectionAdapter() { |
| @Override |
| public void widgetDefaultSelected(SelectionEvent e) { |
| handleDefaultSelection(e); |
| } |
| }); |
| text.addKeyListener(new KeyAdapter() { |
| // hook key pressed - see PR 14201 |
| @Override |
| public void keyPressed(KeyEvent e) { |
| keyReleaseOccured(e); |
| |
| // as a result of processing the above call, clients may have |
| // disposed this cell editor |
| if ((getControl() == null) || getControl().isDisposed()) { |
| return; |
| } |
| checkSelection(); // see explanation below |
| checkDeleteable(); |
| checkSelectable(); |
| } |
| }); |
| text.addTraverseListener(new TraverseListener() { |
| @Override |
| public void keyTraversed(TraverseEvent e) { |
| if (e.detail == SWT.TRAVERSE_ESCAPE |
| || e.detail == SWT.TRAVERSE_RETURN) { |
| e.doit = false; |
| } |
| } |
| }); |
| // We really want a selection listener but it is not supported so we |
| // use a key listener and a mouse listener to know when selection changes |
| // may have occurred |
| text.addMouseListener(new MouseAdapter() { |
| @Override |
| public void mouseUp(MouseEvent e) { |
| checkSelection(); |
| checkDeleteable(); |
| checkSelectable(); |
| } |
| }); |
| text.addFocusListener(new FocusAdapter() { |
| @Override |
| public void focusLost(FocusEvent e) { |
| EditableDialogCellEditor.this.focusLost(); |
| } |
| }); |
| text.setFont(cell.getFont()); |
| text.setBackground(cell.getBackground()); |
| text.setText("");//$NON-NLS-1$ |
| text.addModifyListener(getModifyListener()); |
| return text; |
| } |
| |
| /** |
| * Checks to see if the "deletable" state (can delete/ |
| * nothing to delete) has changed and if so fire an |
| * enablement changed notification. |
| */ |
| private void checkDeleteable() { |
| boolean oldIsDeleteable = isDeleteable; |
| isDeleteable = isDeleteEnabled(); |
| if (oldIsDeleteable != isDeleteable) { |
| fireEnablementChanged(DELETE); |
| } |
| } |
| |
| /** |
| * Checks to see if the "selectable" state (can select) |
| * has changed and if so fire an enablement changed notification. |
| */ |
| private void checkSelectable() { |
| boolean oldIsSelectable = isSelectable; |
| isSelectable = isSelectAllEnabled(); |
| if (oldIsSelectable != isSelectable) { |
| fireEnablementChanged(SELECT_ALL); |
| } |
| } |
| |
| /** |
| * Checks to see if the selection state (selection / |
| * no selection) has changed and if so fire an |
| * enablement changed notification. |
| */ |
| private void checkSelection() { |
| boolean oldIsSelection = isSelection; |
| isSelection = text.getSelectionCount() > 0; |
| if (oldIsSelection != isSelection) { |
| fireEnablementChanged(COPY); |
| fireEnablementChanged(CUT); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * Method declared on CellEditor. |
| */ |
| @Override |
| protected void doSetFocus() { |
| if (text != null) { |
| text.selectAll(); |
| text.setFocus(); |
| checkSelection(); |
| checkDeleteable(); |
| checkSelectable(); |
| } |
| } |
| |
| /* |
| * (non-Javadoc) |
| * @see org.eclipse.jface.viewers.DialogCellEditor#updateContents(java.lang.Object) |
| */ |
| @Override |
| protected void updateContents(Object value) { |
| Assert.isTrue(text != null && (value == null || (value instanceof String))); |
| if (value != null) { |
| text.removeModifyListener(getModifyListener()); |
| text.setText((String) value); |
| text.addModifyListener(getModifyListener()); |
| } |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of |
| * this <code>CellEditor</code> framework method returns |
| * the text string. |
| * |
| * @return the text string |
| */ |
| @Override |
| protected Object doGetValue() { |
| return text.getText(); |
| } |
| |
| |
| /** |
| * Processes a modify event that occurred in this text cell editor. |
| * This framework method performs validation and sets the error message |
| * accordingly, and then reports a change via <code>fireEditorValueChanged</code>. |
| * Subclasses should call this method at appropriate times. Subclasses |
| * may extend or reimplement. |
| * |
| * @param e the SWT modify event |
| */ |
| protected void editOccured(ModifyEvent e) { |
| String value = text.getText(); |
| if (value == null) { |
| value = "";//$NON-NLS-1$ |
| } |
| Object typedValue = value; |
| boolean oldValidState = isValueValid(); |
| boolean newValidState = isCorrect(typedValue); |
| |
| if (!newValidState) { |
| // try to insert the current value into the error message. |
| setErrorMessage(MessageFormat.format(getErrorMessage(), |
| new Object[] { value })); |
| } |
| valueChanged(oldValidState, newValidState); |
| } |
| |
| /** |
| * Return the modify listener. |
| */ |
| private ModifyListener getModifyListener() { |
| if (modifyListener == null) { |
| modifyListener = new ModifyListener() { |
| @Override |
| public void modifyText(ModifyEvent e) { |
| editOccured(e); |
| } |
| }; |
| } |
| return modifyListener; |
| } |
| |
| /** |
| * Handles a default selection event from the text control by applying the editor |
| * value and deactivating this cell editor. |
| * |
| * @param event the selection event |
| * |
| * @since 3.0 |
| */ |
| protected void handleDefaultSelection(SelectionEvent event) { |
| // same with enter-key handling code in keyReleaseOccured(e); |
| fireApplyEditorValue(); |
| deactivate(); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method returns <code>true</code> if |
| * the current selection is not empty. |
| */ |
| @Override |
| public boolean isCopyEnabled() { |
| if (text == null || text.isDisposed()) { |
| return false; |
| } |
| return text.getSelectionCount() > 0; |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method returns <code>true</code> if |
| * the current selection is not empty. |
| */ |
| @Override |
| public boolean isCutEnabled() { |
| if (text == null || text.isDisposed()) { |
| return false; |
| } |
| return text.getSelectionCount() > 0; |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method returns <code>true</code> |
| * if there is a selection or if the caret is not positioned |
| * at the end of the text. |
| */ |
| @Override |
| public boolean isDeleteEnabled() { |
| if (text == null || text.isDisposed()) { |
| return false; |
| } |
| return text.getSelectionCount() > 0 |
| || text.getCaretPosition() < text.getCharCount(); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method always returns <code>true</code>. |
| */ |
| @Override |
| public boolean isPasteEnabled() { |
| if (text == null || text.isDisposed()) { |
| return false; |
| } |
| return true; |
| } |
| |
| /** |
| * Check if save all is enabled |
| * @return true if it is |
| */ |
| public boolean isSaveAllEnabled() { |
| if (text == null || text.isDisposed()) { |
| return false; |
| } |
| return true; |
| } |
| |
| /** |
| * Returns <code>true</code> if this cell editor is |
| * able to perform the select all action. |
| * <p> |
| * This default implementation always returns |
| * <code>false</code>. |
| * </p> |
| * <p> |
| * Subclasses may override |
| * </p> |
| * @return <code>true</code> if select all is possible, |
| * <code>false</code> otherwise |
| */ |
| @Override |
| public boolean isSelectAllEnabled() { |
| if (text == null || text.isDisposed()) { |
| return false; |
| } |
| return text.getCharCount() > 0; |
| } |
| |
| /** |
| * Processes a key release event that occurred in this cell editor. |
| * <p> |
| * The <code>TextCellEditor</code> implementation of this framework method |
| * ignores when the RETURN key is pressed since this is handled in |
| * <code>handleDefaultSelection</code>. |
| * An exception is made for Ctrl+Enter for multi-line texts, since |
| * a default selection event is not sent in this case. |
| * </p> |
| * |
| * @param keyEvent the key event |
| */ |
| @Override |
| protected void keyReleaseOccured(KeyEvent keyEvent) { |
| if (keyEvent.character == '\r') { // Return key |
| // Enter is handled in handleDefaultSelection. |
| // Do not apply the editor value in response to an Enter key event |
| // since this can be received from the IME when the intent is -not- |
| // to apply the value. |
| // See bug 39074 [CellEditors] [DBCS] canna input mode fires bogus event from Text Control |
| // |
| // An exception is made for Ctrl+Enter for multi-line texts, since |
| // a default selection event is not sent in this case. |
| if (text != null && !text.isDisposed() |
| && (text.getStyle() & SWT.MULTI) != 0) { |
| if ((keyEvent.stateMask & SWT.CTRL) != 0) { |
| super.keyReleaseOccured(keyEvent); |
| } |
| } |
| return; |
| } |
| super.keyReleaseOccured(keyEvent); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method copies the |
| * current selection to the clipboard. |
| */ |
| @Override |
| public void performCopy() { |
| text.copy(); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method cuts the |
| * current selection to the clipboard. |
| */ |
| @Override |
| public void performCut() { |
| text.cut(); |
| checkSelection(); |
| checkDeleteable(); |
| checkSelectable(); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method deletes the |
| * current selection or, if there is no selection, |
| * the character next character from the current position. |
| */ |
| @Override |
| public void performDelete() { |
| if (text.getSelectionCount() > 0) { |
| // remove the contents of the current selection |
| text.insert(""); //$NON-NLS-1$ |
| } else { |
| // remove the next character |
| int pos = text.getCaretPosition(); |
| if (pos < text.getCharCount()) { |
| text.setSelection(pos, pos + 1); |
| text.insert(""); //$NON-NLS-1$ |
| } |
| } |
| checkSelection(); |
| checkDeleteable(); |
| checkSelectable(); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method pastes the |
| * the clipboard contents over the current selection. |
| */ |
| @Override |
| public void performPaste() { |
| text.paste(); |
| checkSelection(); |
| checkDeleteable(); |
| checkSelectable(); |
| } |
| |
| /** |
| * The <code>TextCellEditor</code> implementation of this |
| * <code>CellEditor</code> method selects all of the |
| * current text. |
| */ |
| @Override |
| public void performSelectAll() { |
| text.selectAll(); |
| checkSelection(); |
| checkDeleteable(); |
| } |
| |
| @Override |
| protected void focusLost() { |
| if (SdkConstants.currentPlatform() == SdkConstants.PLATFORM_LINUX) { |
| // On Linux, something about the order of focus event delivery prevents the |
| // callback on the "..." button to be invoked, which means the |
| // customizer dialog never shows up (see issue #18348). |
| // (Note that simply trying to Display.asyncRun() the super.focusLost() |
| // method does not work.) |
| // |
| // We can work around this by not deactivating on a focus loss. |
| // This means that in some cases the cell editor will still be |
| // shown in the property sheet, but I've tested that the values |
| // are all committed as before. This is better than having a non-operational |
| // customizer, but since this issue only happens on Linux the workaround |
| // is only done on Linux such that on other platforms we deactivate |
| // immediately on focus loss. |
| // |
| if (isActivated()) { |
| fireApplyEditorValue(); |
| // super.focusLost calls the following which we're deliberately |
| // suppressing here: |
| // deactivate(); |
| } |
| } else { |
| super.focusLost(); |
| } |
| } |
| } |