|
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.ListViewer
public class ListViewer
A concrete viewer based on an SWT List control.
This class is not intended to be subclassed. It is designed to be
instantiated with a pre-existing SWT List control and configured
with a domain-specific content provider, label provider, element filter (optional),
and element sorter (optional).
Note that the SWT List control only supports the display of strings, not icons.
If you need to show icons for items, use TableViewer instead.
TableViewer| 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 | |
|---|---|
ListViewer(Composite parent)
Creates a list viewer on a newly-created list control under the given parent. |
|
ListViewer(Composite parent,
int style)
Creates a list viewer on a newly-created list control under the given parent. |
|
ListViewer(List list)
Creates a list viewer on the given list control. |
|
| Method Summary | |
|---|---|
Control |
getControl()
Returns the primary control associated with this viewer. |
List |
getList()
Returns this list viewer's list control. |
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 int |
listGetTopIndex()
Returns the index of the item currently at the top of the viewable area. |
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 |
listSetTopIndex(int index)
Sets the index of the item to be at the top of the viewable area. |
protected void |
listShowSelection()
Shows the selection. |
void |
reveal(Object element)
Ensures that the given element is visible, scrolling the viewer if necessary. |
protected void |
setSelectionToWidget(List in,
boolean reveal)
Parlays the given list of selected elements into selections on this viewer's control. |
| Methods inherited from class org.eclipse.jface.viewers.AbstractListViewer |
|---|
add, add, doFindInputItem, doFindItem, doUpdateItem, getElementAt, getLabelProvider, getSelectionFromWidget, indexForElement, inputChanged, insert, internalRefresh, remove, remove, setLabelProvider |
| 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 ListViewer(Composite parent)
MULTI, H_SCROLL, V_SCROLL, and BORDER.
The viewer has no input, no content provider, a default label provider,
no sorter, and no filters.
parent - the parent control
public ListViewer(Composite parent,
int style)
parent - the parent controlstyle - the SWT style bitspublic ListViewer(List list)
list - the list control| Method Detail |
|---|
public Control getControl()
Viewer
getControl in class Viewerpublic List getList()
public void reveal(Object element)
StructuredViewer
reveal in class StructuredViewerelement - the element to reveal
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 itemprotected 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 AbstractListViewerprotected int listGetTopIndex()
AbstractListViewerDefault implementation returns -1.
listGetTopIndex in class AbstractListViewerprotected void listSetTopIndex(int index)
AbstractListViewerDefault implementation does nothing.
listSetTopIndex in class AbstractListViewerindex - the given index. -1 for none. index will always refer to a valid index.
protected void setSelectionToWidget(List in,
boolean reveal)
StructuredViewerSubclasses should override to set their selection based on the given list of elements.
setSelectionToWidget in class AbstractListViewerin - list of selected elements (element type: Object)
or null if the selection is to be clearedreveal - true if the selection is to be made visible,
and false otherwise
|
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.