|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.ercp.swt.mobile.ListView
A widget that allows the user to select one or more items from a collection of items that can be displayed in a multi-column way with different styles.
ListView lays out its children items in one or more columns from top to
bottom. If a layout orientation hint is not specified, the implementation
chooses the orientation. If there is only enough screen width for one column,
the list scrolls vertically. If there is room to display multiple columns
within the widget, then the list scrolls horizontally. The list never scrolls
in more than one direction. The layout orientation may be set at runtime by
calling method setLayout(int)
.
The item density hint determines the size and positioning of items in order
to fit more or less within the widget. Applications can query the preferred
sizes of the icons for each density level. Note that the sizes may be diverse
in different platforms. When the given icons do not match the prefered size,
the implementation may adjust icon sizes without throwing any exception.
Applications can change the item density level at runtime by calling method
setLayoutDensity(int)
. Some platforms may use
context-sensitive device keys to allow the user to change the ListView's
density level at run-time. For example, by activating "zoom in/out" device
keys when the ListView is focused.
Applications can query the current layout and density values by calling the corresponding "get" methods.
Note: If styles not applicable to ListView are specified, they are ignored.
Note: ListView is a subclass of Scrollable. Changing the scrollbar values (
ScrollBar.setSelection(int)
) will affect the scrolling
position of the ListView control. However, changing the range of scrollbars,
such as setMaximum(int)
and setMinimum(int)
,
will not affect the ListView at all.
IMPORTANT: This class is not intended to be subclassed.
Field Summary | |
---|---|
static int |
HIGH
A high density level. |
static int |
LOW
A low density level. |
static int |
MEDIUM
A medium density level. |
Constructor Summary | |
---|---|
ListView(Composite parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
|
ListView(Composite parent,
int style,
int density)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance styles. |
Method Summary | |
---|---|
void |
add(String item,
Image icon)
Adds the string item and an optional icon to the end of the receiver's list. |
void |
add(String string,
Image icon,
int index)
Adds the string item and an optional icon to the receiver's list at the given zero-relative index. |
void |
addSelectionListener(SelectionListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's selection changes. |
void |
deselect(int index)
Deselects the item at the given zero-relative index in the receiver. |
void |
deselect(int[] indices)
Deselects the items at the given zero-relative indices in the receiver. |
void |
deselect(int start,
int end)
Deselects the items at the given zero-relative indices in the receiver. |
void |
deselectAll()
Deselects all selected items in the receiver. |
int |
getFocusIndex()
Returns the zero-relative index of the item which currently has the focus in the receiver, or -1 if no item has focus. |
Image |
getIcon(int index)
Returns the item icon at the given, zero-relative index in the receiver. |
Point |
getIconSize(int style)
Gets the preferred icon size that matches the density style. |
String |
getItem(int index)
Returns the item at the given, zero-relative index in the receiver. |
int |
getItemCount()
Returns the number of items contained in the receiver. |
String[] |
getItems()
Returns an array of String s which are the items in the
receiver.
|
int |
getLayout()
Returns the value of the layout orientation. |
int |
getLayoutDensity()
Returns the value of the item density level. |
String[] |
getSelection()
Returns an array of String s that are currently selected
in the receiver. |
int |
getSelectionCount()
Returns the number of selected items contained in the receiver. |
int[] |
getSelectionIndices()
Returns the zero-relative indices of the items which are currently selected in the receiver. |
int |
getTopIndex()
Returns the zero-relative index of the item which is currently at the top of the receiver. |
int |
indexOf(String string)
Gets the index of an item. |
int |
indexOf(String string,
int start)
Searches the receiver's list starting at the given, zero-relative index until an item is found that is equal to the argument, and returns the index of that item. |
boolean |
isSelected(int index)
Returns true if the item is selected, and
false otherwise. |
void |
remove(int index)
Removes the item from the receiver at the given zero-relative index. |
void |
remove(int[] indices)
Removes the items from the receiver at the given zero-relative indices. |
void |
remove(int start,
int end)
Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive). |
void |
remove(String string)
Searches the receiver's list starting at the first item until an item is found that is equal to the argument, and removes that item from the list. |
void |
removeAll()
Removes all of the items from the receiver. |
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the receiver's selection changes. |
void |
select(int index)
Selects the item at the given zero-relative index in the receiver's list. |
void |
select(int[] indices)
Selects the items at the given zero-relative indices in the receiver. |
void |
select(int start,
int end)
Selects the items in the range specified by the given zero-relative indices in the receiver. |
void |
selectAll()
Selects all of the items in the receiver. |
void |
setItem(int index,
String string,
Image icon)
Sets the text and icon of the item in the receiver's list at the given zero-relative index to the string argument. |
void |
setItems(String[] items,
Image[] icons)
Sets the receiver's items to be the given array of items and icons. |
void |
setLayout(int style)
Changes the widget layout orientation, which affects which way the widget scrolls. |
void |
setLayoutDensity(int style)
Changes the item density level. |
void |
setSelection(int index)
Selects the item at the given zero-relative index in the receiver. |
void |
setSelection(int[] indices)
Selects the items at the given zero-relative indices in the receiver. |
void |
setSelection(int start,
int end)
Selects the items in the range specified by the given zero-relative indices in the receiver. |
void |
setSelection(String[] items)
Sets the receiver's selection to be the given array of items. |
void |
showSelection()
Shows the selection. |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int LOW
Value 1
is assigned to LOW
.
public static final int MEDIUM
Value 2
is assigned to MEDIUM
.
public static final int HIGH
Value 3
is assigned to HIGH
.
Constructor Detail |
public ListView(Composite parent, int style)
The style value is either one of the style constants defined in class
SWT
which is applicable to instances of this class, or
must be built by bitwise OR 'ing together (that is, using the
int
"|" operator) two or more of those SWT
style constants. The class description lists the style constants that are
applicable to the class. Style bits are also inherited from superclasses.
parent
- a widget which will be the parent of the new instance (cannot
be null)style
- the style value of the widget to construct. See Description for details.
IllegalArgumentException
- SWTException
- SWT.SINGLE
,
SWT.MULTI
,
SWT.HORIZONTAL
,
SWT.VERTICAL
public ListView(Composite parent, int style, int density)
The style value is either one of the style constants defined in class
SWT
which is applicable to instances of this class, or
must be built by bitwise OR 'ing together (that is, using the
int
"|" operator) two or more of those SWT
style constants. The class description lists the style constants that are
applicable to the class. Style bits are also inherited from superclasses.
The density style is one of HIGH, MEDIUM and LOW.
parent
- a widget which will be the parent of the new instance (cannot
be null)style
- the style value of the widget to construct. See Description for details.density
- the density style value.
IllegalArgumentException
- SWTException
- SWT.SINGLE
,
SWT.MULTI
,
SWT.HORIZONTAL
,
SWT.VERTICAL
,
HIGH
,
MEDIUM
,
LOW
,
getLayoutDensity()
Method Detail |
public int getLayoutDensity()
SWTException
- LOW
,
MEDIUM
,
HIGH
public int getLayout()
SWTException
- SWT.HORIZONTAL
,
SWT.VERTICAL
public void add(String item, Image icon)
item
- the new item texticon
- the icon of the item, or null.
IllegalArgumentException
- SWTException
- SWTError
- add(String,Image, int)
public void add(String string, Image icon, int index)
Note: To add an item at the end of the list, use the result of calling
getItemCount()
as the index or use
add(String, Image)
.
string
- the new itemicon
- the icon part of the item, or null.index
- the index for the item
IllegalArgumentException
- SWTException
- SWTError
- add(String, Image)
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
widgetSelected
is called when the selection changes.
widgetDefaultSelected
is typically called when an item is
double-clicked.
listener
- the listener which should be notified
IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public void deselect(int index)
index
- the index of the item to deselect
SWTException
- public void deselect(int start, int end)
start
- the start index of the items to deselectend
- the end index of the items to deselect
SWTException
- public void deselect(int[] indices)
indices
- the array of indices for the items to deselect
IllegalArgumentException
- SWTException
- public void deselectAll()
SWTException
- public int getFocusIndex()
SWTException
- public String getItem(int index)
index
- the index of the item to return
IllegalArgumentException
- SWTException
- SWTError
- public Image getIcon(int index)
index
- the index of the item to return
IllegalArgumentException
- SWTException
- SWTError
- public Point getIconSize(int style)
style
- the size style. Only HIGH, MEDIUM, and LOW can be used.
IllegalArgumentException
- SWTException
- LOW
,
MEDIUM
,
HIGH
public int getItemCount()
SWTException
- SWTError
- public String[] getItems()
String
s which are the items in the
receiver.
Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.
SWTException
- SWTError
- public String[] getSelection()
String
s that are currently selected
in the receiver. An empty array indicates that no items are selected.
Note: This is not the actual structure used by the receiver to maintain its selection, so modifying the array will not affect the receiver.
SWTException
- SWTError
- public int getSelectionCount()
SWTException
- SWTError
- public int[] getSelectionIndices()
Note: This is not the actual structure used by the receiver to maintain its selection, so modifying the array will not affect the receiver.
SWTException
- SWTError
- public int getTopIndex()
SWTException
- public int indexOf(String string)
The list is searched starting at 0 until an item is found that is equal to the search item. If no item is found, -1 is returned. Indexing is zero based.
string
- the search item
IllegalArgumentException
- SWTException
- public int indexOf(String string, int start)
string
- the search itemstart
- the zero-relative index at which to start the search
IllegalArgumentException
- SWTException
- SWTError
- public boolean isSelected(int index)
true
if the item is selected, and
false
otherwise. Indices out of range are ignored.
index
- the index of the item
SWTException
- public void remove(int index)
index
- the index for the item
IllegalArgumentException
- SWTException
- SWTError
- public void remove(int start, int end)
start
- the start of the rangeend
- the end of the range
IllegalArgumentException
- SWTException
- SWTError
- public void remove(String string)
string
- the item to remove
IllegalArgumentException
- SWTException
- SWTError
- public void remove(int[] indices)
indices
- the array of indices of the items
IllegalArgumentException
- SWTException
- SWTError
- public void removeAll()
SWTException
- public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notified
IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
public void select(int index)
index
- the index of the item to select
SWTException
- public void select(int start, int end)
If an item in the given range is not selected, it is selected. If an item in the given range was already selected, it remains selected. Indices that are out of range are ignored and no items will be selected if start is greater than end. If the receiver is single-select and there is more than one item in the given range, then all indices are ignored.
start
- the start of the rangeend
- the end of the range
SWTException
- List.setSelection(int,int)
public void select(int[] indices)
If the item at a given index is not selected, it is selected. If the item at a given index was already selected, it remains selected. Indices 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.
indices
- the array of indices for the items to select
IllegalArgumentException
- SWTException
- List.setSelection(int[])
public void selectAll()
If the receiver is single-select, do nothing.
SWTException
- public void setItem(int index, String string, Image icon)
remove
'ing the old item at the index, and then
add
'ing the new item at that index.
index
- the index for the itemstring
- the new text for the itemicon
- the icon image for the item, can be Null.
IllegalArgumentException
- SWTException
- SWTError
- public void setItems(String[] items, Image[] icons)
items
- the array of itemsicons
- the array of icons. Can be NULL.
IllegalArgumentException
- items
array is nullicons
does not match the number in
items
SWTException
- SWTError
- public void setLayout(int style)
style
- the orientation style. Only SWT.VERTICAL and SWT.HORIZONTAL
can be used.
IllegalArgumentException
- SWTException
- SWT.HORIZONTAL
,
SWT.VERTICAL
public void setLayoutDensity(int style)
style
- the density level. Only HIGH, MEDIUM, LOW can be used.
IllegalArgumentException
- SWTException
- LOW
,
MEDIUM
,
HIGH
public void setSelection(int index)
index
- the index of the item to select
SWTException
- List.deselectAll()
,
List.select(int)
public void setSelection(int start, int end)
Indices that are out of range are ignored and no items will be selected if start is greater than end. If the receiver is single-select and there is more than one item in the given range, then all indices are ignored.
start
- the start index of the items to selectend
- the end index of the items to select
SWTException
- List.deselectAll()
,
List.select(int,int)
public void setSelection(int[] indices)
Indices 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.
indices
- the indices of the items to select
IllegalArgumentException
- SWTException
- List.deselectAll()
,
List.select(int[])
public void setSelection(String[] items)
Items that are not in the receiver are ignored. If the receiver is single-select and multiple items are specified, then all items are ignored.
items
- the array of items
IllegalArgumentException
- SWTException
- List.deselectAll()
,
List.select(int[])
,
List.setSelection(int[])
public void showSelection()
SWTException
-
|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |