Package org.eclipse.jface.viewers
Class ComboBoxViewerCellEditor
- java.lang.Object
-
- org.eclipse.jface.viewers.CellEditor
-
- org.eclipse.jface.viewers.ComboBoxViewerCellEditor
-
public class ComboBoxViewerCellEditor extends CellEditor
A cell editor that presents a list of items in a combo box. In contrast toComboBoxCellEditorit wraps the underlyingCCombousing aComboViewer- Since:
- 3.4
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.eclipse.jface.viewers.CellEditor
CellEditor.LayoutData
-
-
Field Summary
Fields Modifier and Type Field Description static intDROP_DOWN_ON_KEY_ACTIVATIONThe list is dropped down when the activation is done through the keyboardstatic intDROP_DOWN_ON_MOUSE_ACTIVATIONThe list is dropped down when the activation is done through the mousestatic intDROP_DOWN_ON_PROGRAMMATIC_ACTIVATIONThe list is dropped down when the activation is done without ui-interactionstatic intDROP_DOWN_ON_TRAVERSE_ACTIVATIONThe list is dropped down when the activation is done by traversing from cell to cell-
Fields inherited from class org.eclipse.jface.viewers.CellEditor
COPY, CUT, DELETE, FIND, PASTE, REDO, SELECT_ALL, UNDO
-
-
Constructor Summary
Constructors Constructor Description ComboBoxViewerCellEditor(Composite parent)Creates a new cell editor with a combo viewer and a default styleComboBoxViewerCellEditor(Composite parent, int style)Creates a new cell editor with a combo viewer and the given style
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidactivate(ColumnViewerEditorActivationEvent activationEvent)Activate the editor but also inform the editor which event triggered its activation.protected ControlcreateControl(Composite parent)Creates the control for this cell editor under the given parent control.protected ObjectdoGetValue()TheComboBoxCellEditorimplementation of thisCellEditorframework method returns the zero-based index of the current selection.protected voiddoSetFocus()Sets the focus to the cell editor's control.protected voiddoSetValue(Object value)Set a new valueprotected voidfocusLost()Processes a focus lost event that occurred in this cell editor.CellEditor.LayoutDatagetLayoutData()TheComboBoxCellEditorimplementation of thisCellEditorframework method sets the minimum width of the cell.ComboViewergetViewer()protected voidkeyReleaseOccured(KeyEvent keyEvent)Processes a key release event that occurred in this cell editor.voidsetActivationStyle(int activationStyle)This method allows to control how the combo reacts when activatedvoidsetContenProvider(IStructuredContentProvider provider)Deprecated.As of 3.7, replaced bysetContentProvider(IStructuredContentProvider)voidsetContentProvider(IStructuredContentProvider provider)voidsetInput(Object input)voidsetLabelProvider(IBaseLabelProvider labelProvider)-
Methods inherited from class org.eclipse.jface.viewers.CellEditor
activate, addListener, addPropertyChangeListener, create, deactivate, deactivate, dependsOnExternalFocusListener, dispose, fireApplyEditorValue, fireCancelEditor, fireEditorValueChanged, fireEnablementChanged, getControl, getDoubleClickTimeout, getErrorMessage, getStyle, getValidator, getValue, isActivated, isCopyEnabled, isCorrect, isCutEnabled, isDeleteEnabled, isDirty, isFindEnabled, isPasteEnabled, isRedoEnabled, isSelectAllEnabled, isUndoEnabled, isValueValid, markDirty, performCopy, performCut, performDelete, performFind, performPaste, performRedo, performSelectAll, performUndo, removeListener, removePropertyChangeListener, setErrorMessage, setFocus, setStyle, setValidator, setValue, setValueValid, valueChanged
-
-
-
-
Field Detail
-
DROP_DOWN_ON_MOUSE_ACTIVATION
public static final int DROP_DOWN_ON_MOUSE_ACTIVATION
The list is dropped down when the activation is done through the mouse- See Also:
- Constant Field Values
-
DROP_DOWN_ON_KEY_ACTIVATION
public static final int DROP_DOWN_ON_KEY_ACTIVATION
The list is dropped down when the activation is done through the keyboard- See Also:
- Constant Field Values
-
DROP_DOWN_ON_PROGRAMMATIC_ACTIVATION
public static final int DROP_DOWN_ON_PROGRAMMATIC_ACTIVATION
The list is dropped down when the activation is done without ui-interaction- See Also:
- Constant Field Values
-
DROP_DOWN_ON_TRAVERSE_ACTIVATION
public static final int DROP_DOWN_ON_TRAVERSE_ACTIVATION
The list is dropped down when the activation is done by traversing from cell to cell- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ComboBoxViewerCellEditor
public ComboBoxViewerCellEditor(Composite parent)
Creates a new cell editor with a combo viewer and a default style- Parameters:
parent- the parent control
-
ComboBoxViewerCellEditor
public ComboBoxViewerCellEditor(Composite parent, int style)
Creates a new cell editor with a combo viewer and the given style- Parameters:
parent- the parent controlstyle- the style bits
-
-
Method Detail
-
createControl
protected Control createControl(Composite parent)
Description copied from class:CellEditorCreates the control for this cell editor under the given parent control.This framework method must be implemented by concrete subclasses.
- Specified by:
createControlin classCellEditor- Parameters:
parent- the parent control- Returns:
- the new control, or
nullif this cell editor has no control
-
doGetValue
protected Object doGetValue()
TheComboBoxCellEditorimplementation of thisCellEditorframework method returns the zero-based index of the current selection.- Specified by:
doGetValuein classCellEditor- Returns:
- the zero-based index of the current selection wrapped as an
Integer - See Also:
CellEditor.getValue()
-
doSetFocus
protected void doSetFocus()
Description copied from class:CellEditorSets the focus to the cell editor's control.This framework method must be implemented by concrete subclasses.
- Specified by:
doSetFocusin classCellEditor- See Also:
CellEditor.setFocus()
-
getLayoutData
public CellEditor.LayoutData getLayoutData()
TheComboBoxCellEditorimplementation of thisCellEditorframework method sets the minimum width of the cell. The minimum width is 10 characters ifcomboBoxis notnullordisposedeles it is 60 pixels to make sure the arrow button and some text is visible. The list of CCombo will be wide enough to show its longest item.- Overrides:
getLayoutDatain classCellEditor- Returns:
- the layout data object
-
doSetValue
protected void doSetValue(Object value)
Set a new value- Specified by:
doSetValuein classCellEditor- Parameters:
value- the new value- See Also:
CellEditor.setValue(java.lang.Object)
-
setLabelProvider
public void setLabelProvider(IBaseLabelProvider labelProvider)
- Parameters:
labelProvider- the label provider used- See Also:
StructuredViewer.setLabelProvider(IBaseLabelProvider)
-
setContentProvider
public void setContentProvider(IStructuredContentProvider provider)
- Parameters:
provider- the content provider used- Since:
- 3.7
- See Also:
StructuredViewer.setContentProvider(IContentProvider)
-
setContenProvider
@Deprecated public void setContenProvider(IStructuredContentProvider provider)
Deprecated.As of 3.7, replaced bysetContentProvider(IStructuredContentProvider)- Parameters:
provider- the content provider used- See Also:
StructuredViewer.setContentProvider(IContentProvider)
-
setInput
public void setInput(Object input)
- Parameters:
input- the input used- See Also:
StructuredViewer.setInput(Object)
-
getViewer
public ComboViewer getViewer()
- Returns:
- get the viewer
-
focusLost
protected void focusLost()
Description copied from class:CellEditorProcesses a focus lost event that occurred in this cell editor.The default implementation of this framework method applies the current value and deactivates the cell editor. Subclasses should call this method at appropriate times. Subclasses may also extend or reimplement.
- Overrides:
focusLostin classCellEditor
-
keyReleaseOccured
protected void keyReleaseOccured(KeyEvent keyEvent)
Description copied from class:CellEditorProcesses a key release event that occurred in this cell editor.The default implementation of this framework method cancels editing when the ESC key is pressed. When the RETURN key is pressed the current value is applied and the cell editor deactivates. Subclasses should call this method at appropriate times. Subclasses may also extend or reimplement.
- Overrides:
keyReleaseOccuredin classCellEditor- Parameters:
keyEvent- the key event
-
activate
public void activate(ColumnViewerEditorActivationEvent activationEvent)
Description copied from class:CellEditorActivate the editor but also inform the editor which event triggered its activation. The default implementation simply callsCellEditor.activate()- Overrides:
activatein classCellEditor- Parameters:
activationEvent- the editor activation event
-
setActivationStyle
public void setActivationStyle(int activationStyle)
This method allows to control how the combo reacts when activated- Parameters:
activationStyle- the style used
-
-