|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.viewers.CellEditor
org.eclipse.jface.viewers.TextCellEditor
public class TextCellEditor
A cell editor that manages a text entry field. The cell editor's value is the text string itself.
This class may be instantiated or subclassed.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.jface.viewers.CellEditor |
|---|
CellEditor.LayoutData |
| Field Summary | |
|---|---|
protected Text |
text
The text control; initially null. |
| Fields inherited from class org.eclipse.jface.viewers.CellEditor |
|---|
COPY, CUT, DELETE, FIND, PASTE, REDO, SELECT_ALL, UNDO |
| Constructor Summary | |
|---|---|
TextCellEditor()
Creates a new text string cell editor with no control The cell editor value is the string itself, which is initially the empty string. |
|
TextCellEditor(Composite parent)
Creates a new text string cell editor parented under the given control. |
|
TextCellEditor(Composite parent,
int style)
Creates a new text string cell editor parented under the given control. |
|
| Method Summary | |
|---|---|
protected Control |
createControl(Composite parent)
Creates the control for this cell editor under the given parent control. |
protected boolean |
dependsOnExternalFocusListener()
This implementation of CellEditor.dependsOnExternalFocusListener() returns false if the
current instance's class is TextCellEditor, and true otherwise. |
protected java.lang.Object |
doGetValue()
The TextCellEditor implementation of
this CellEditor framework method returns
the text string. |
protected void |
doSetFocus()
Sets the focus to the cell editor's control. |
protected void |
doSetValue(java.lang.Object value)
The TextCellEditor implementation of
this CellEditor framework method accepts
a text string (type String). |
protected void |
editOccured(ModifyEvent e)
Processes a modify event that occurred in this text cell editor. |
CellEditor.LayoutData |
getLayoutData()
Since a text editor field is scrollable we don't set a minimumSize. |
protected void |
handleDefaultSelection(SelectionEvent event)
Handles a default selection event from the text control by applying the editor value and deactivating this cell editor. |
boolean |
isCopyEnabled()
The TextCellEditor implementation of this
CellEditor method returns true if
the current selection is not empty. |
boolean |
isCutEnabled()
The TextCellEditor implementation of this
CellEditor method returns true if
the current selection is not empty. |
boolean |
isDeleteEnabled()
The TextCellEditor implementation of this
CellEditor method returns true
if there is a selection or if the caret is not positioned
at the end of the text. |
boolean |
isPasteEnabled()
The TextCellEditor implementation of this
CellEditor method always returns true. |
boolean |
isSaveAllEnabled()
Check if save all is enabled |
boolean |
isSelectAllEnabled()
Returns true if this cell editor is
able to perform the select all action. |
protected void |
keyReleaseOccured(KeyEvent keyEvent)
Processes a key release event that occurred in this cell editor. |
void |
performCopy()
The TextCellEditor implementation of this
CellEditor method copies the
current selection to the clipboard. |
void |
performCut()
The TextCellEditor implementation of this
CellEditor method cuts the
current selection to the clipboard. |
void |
performDelete()
The TextCellEditor implementation of this
CellEditor method deletes the
current selection or, if there is no selection,
the character next character from the current position. |
void |
performPaste()
The TextCellEditor implementation of this
CellEditor method pastes the
the clipboard contents over the current selection. |
void |
performSelectAll()
The TextCellEditor implementation of this
CellEditor method selects all of the
current text. |
| Methods inherited from class org.eclipse.jface.viewers.CellEditor |
|---|
activate, activate, addListener, addPropertyChangeListener, create, deactivate, deactivate, dispose, fireApplyEditorValue, fireCancelEditor, fireEditorValueChanged, fireEnablementChanged, focusLost, getControl, getDoubleClickTimeout, getErrorMessage, getStyle, getValidator, getValue, isActivated, isCorrect, isDirty, isFindEnabled, isRedoEnabled, isUndoEnabled, isValueValid, markDirty, performFind, performRedo, performUndo, removeListener, removePropertyChangeListener, setErrorMessage, setFocus, setStyle, setValidator, setValue, setValueValid, valueChanged |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Text text
null.
| Constructor Detail |
|---|
public TextCellEditor()
public TextCellEditor(Composite parent)
parent - the parent control
public TextCellEditor(Composite parent,
int style)
parent - the parent controlstyle - the style bits| Method Detail |
|---|
protected Control createControl(Composite parent)
CellEditorThis framework method must be implemented by concrete subclasses.
createControl in class CellEditorparent - the parent control
null if this cell editor has
no controlprotected java.lang.Object doGetValue()
TextCellEditor implementation of
this CellEditor framework method returns
the text string.
doGetValue in class CellEditorCellEditor.getValue()protected void doSetFocus()
CellEditorThis framework method must be implemented by concrete subclasses.
doSetFocus in class CellEditorCellEditor.setFocus()protected void doSetValue(java.lang.Object value)
TextCellEditor implementation of
this CellEditor framework method accepts
a text string (type String).
doSetValue in class CellEditorvalue - a text string (type String)CellEditor.setValue(java.lang.Object)protected void editOccured(ModifyEvent e)
fireEditorValueChanged.
Subclasses should call this method at appropriate times. Subclasses
may extend or reimplement.
e - the SWT modify eventpublic CellEditor.LayoutData getLayoutData()
getLayoutData in class CellEditorprotected void handleDefaultSelection(SelectionEvent event)
event - the selection eventpublic boolean isCopyEnabled()
TextCellEditor implementation of this
CellEditor method returns true if
the current selection is not empty.
isCopyEnabled in class CellEditortrue if copy is possible, false
otherwisepublic boolean isCutEnabled()
TextCellEditor implementation of this
CellEditor method returns true if
the current selection is not empty.
isCutEnabled in class CellEditortrue if cut is possible, false
otherwisepublic boolean isDeleteEnabled()
TextCellEditor implementation of this
CellEditor method returns true
if there is a selection or if the caret is not positioned
at the end of the text.
isDeleteEnabled in class CellEditortrue if delete is possible, false
otherwisepublic boolean isPasteEnabled()
TextCellEditor implementation of this
CellEditor method always returns true.
isPasteEnabled in class CellEditortrue if paste is possible, false
otherwisepublic boolean isSaveAllEnabled()
public boolean isSelectAllEnabled()
true if this cell editor is
able to perform the select all action.
This default implementation always returns
false.
Subclasses may override
isSelectAllEnabled in class CellEditortrue if select all is possible,
false otherwiseprotected void keyReleaseOccured(KeyEvent keyEvent)
The TextCellEditor implementation of this framework method
ignores when the RETURN key is pressed since this is handled in
handleDefaultSelection.
An exception is made for Ctrl+Enter for multi-line texts, since
a default selection event is not sent in this case.
keyReleaseOccured in class CellEditorkeyEvent - the key eventpublic void performCopy()
TextCellEditor implementation of this
CellEditor method copies the
current selection to the clipboard.
performCopy in class CellEditorpublic void performCut()
TextCellEditor implementation of this
CellEditor method cuts the
current selection to the clipboard.
performCut in class CellEditorpublic void performDelete()
TextCellEditor implementation of this
CellEditor method deletes the
current selection or, if there is no selection,
the character next character from the current position.
performDelete in class CellEditorpublic void performPaste()
TextCellEditor implementation of this
CellEditor method pastes the
the clipboard contents over the current selection.
performPaste in class CellEditorpublic void performSelectAll()
TextCellEditor implementation of this
CellEditor method selects all of the
current text.
performSelectAll in class CellEditorprotected boolean dependsOnExternalFocusListener()
CellEditor.dependsOnExternalFocusListener() returns false if the
current instance's class is TextCellEditor, and true otherwise.
Subclasses that hook their own focus listener should override this method
and return false. See also bug 58777.
dependsOnExternalFocusListener in class CellEditortrue to indicate that a focus listener has to be
attached
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.