|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.viewers.Viewer
org.eclipse.jface.viewers.ContentViewer
org.eclipse.jface.viewers.StructuredViewer
org.eclipse.jface.viewers.AbstractListViewer
org.eclipse.jface.viewers.ComboViewer
public class ComboViewer
A concrete viewer based either on an SWT Combo control or CCombo
control. This class is intended as an alternative to the JFace ListViewer, which displays
its content in a combo box rather than a list. Wherever possible, this class attempts to behave
like ListViewer.
This class is designed to be instantiated with a pre-existing SWT combo control and configured with a domain-specific content provider, label provider, element filter (optional), and element sorter (optional).
ListViewer| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.jface.viewers.StructuredViewer |
|---|
StructuredViewer.ColorAndFontCollector, StructuredViewer.ColorAndFontCollectorWithProviders |
| Field Summary |
|---|
| Fields inherited from class org.eclipse.jface.viewers.Viewer |
|---|
WIDGET_DATA_KEY |
| Constructor Summary | |
|---|---|
ComboViewer(CCombo list)
Creates a combo viewer on the given CCombo control. |
|
ComboViewer(Combo list)
Creates a combo viewer on the given combo control. |
|
ComboViewer(Composite parent)
Creates a combo viewer on a newly-created combo control under the given parent. |
|
ComboViewer(Composite parent,
int style)
Creates a combo viewer on a newly-created combo control under the given parent. |
|
| Method Summary | |
|---|---|
CCombo |
getCCombo()
Returns this list viewer's list control. |
Combo |
getCombo()
Returns this list viewer's list control. |
Control |
getControl()
Returns the primary control associated with this viewer. |
protected void |
listAdd(String string,
int index)
Adds the given string to the underlying widget at the given index |
protected void |
listDeselectAll()
Deselects all selected items in the underlying widget. |
protected int |
listGetItemCount()
Returns the number of items contained in the underlying widget. |
protected int[] |
listGetSelectionIndices()
Returns the zero-relative indices of the items which are currently selected in the underlying widget. |
protected void |
listRemove(int index)
Removes the item from the underlying widget at the given zero-relative index. |
protected void |
listRemoveAll()
Removes all of the items from the underlying widget. |
protected void |
listSetItem(int index,
String string)
Sets the text of the item at the given index in the underlying widget. |
protected void |
listSetItems(String[] labels)
Sets the underlying widget's items to be the given array of items. |
protected void |
listSetSelection(int[] ixs)
Selects the items at the given zero-relative indices in the underlying widget. |
protected void |
listShowSelection()
Shows the selection. |
void |
reveal(Object element)
Ensures that the given element is visible, scrolling the viewer if necessary. |
| Methods inherited from class org.eclipse.jface.viewers.AbstractListViewer |
|---|
add, add, doFindInputItem, doFindItem, doUpdateItem, getElementAt, getLabelProvider, getSelectionFromWidget, indexForElement, inputChanged, insert, internalRefresh, listGetTopIndex, listSetTopIndex, remove, remove, setLabelProvider, setSelectionToWidget |
| Methods inherited from class org.eclipse.jface.viewers.ContentViewer |
|---|
getContentProvider, getInput, labelProviderChanged |
| Methods inherited from class org.eclipse.jface.viewers.Viewer |
|---|
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider |
|---|
addSelectionChangedListener, removeSelectionChangedListener, setSelection |
| Constructor Detail |
|---|
public ComboViewer(Composite parent)
parent - the parent control
public ComboViewer(Composite parent,
int style)
parent - the parent controlstyle - the SWT style bitspublic ComboViewer(Combo list)
list - the combo controlpublic ComboViewer(CCombo list)
list - the CCombo control| Method Detail |
|---|
protected void listAdd(String string,
int index)
AbstractListViewer
listAdd in class AbstractListViewerstring - the string to addindex - position to insert the string into
protected void listSetItem(int index,
String string)
AbstractListViewer
listSetItem in class AbstractListViewerindex - index to modifystring - new textprotected int[] listGetSelectionIndices()
AbstractListViewerNote: This is not the actual structure used by the receiver to maintain its selection, so modifying the array will not affect the receiver.
listGetSelectionIndices in class AbstractListViewerprotected int listGetItemCount()
AbstractListViewer
listGetItemCount in class AbstractListViewerprotected void listSetItems(String[] labels)
AbstractListViewer
listSetItems in class AbstractListViewerlabels - the array of label textprotected void listRemoveAll()
AbstractListViewer
listRemoveAll in class AbstractListViewerprotected void listRemove(int index)
AbstractListViewer
listRemove in class AbstractListViewerindex - the index for the itempublic Control getControl()
Viewer
getControl in class Viewerpublic CCombo getCCombo()
public Combo getCombo()
public void reveal(Object element)
StructuredViewer
reveal in class StructuredViewerelement - the element to revealprotected void listSetSelection(int[] ixs)
AbstractListViewerIndices that are out of range and duplicate indices are ignored. If the receiver is single-select and multiple indices are specified, then all indices are ignored.
listSetSelection in class AbstractListViewerixs - the indices of the items to selectprotected void listDeselectAll()
AbstractListViewer
listDeselectAll in class AbstractListViewerprotected void listShowSelection()
AbstractListViewer
listShowSelection in class AbstractListViewer
|
Eclipse Platform Release 3.7 |
|||||||||
| 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, 2011. All rights reserved.