|
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.swt.widgets.Composite
org.eclipse.swt.widgets.Table
Instances of this class implement a selectable user interface object that displays a list of images and strings and issues notification when selected.
The item children that may be added to instances of this class
must be of type TableItem
.
Style VIRTUAL
is used to create a Table
whose
TableItem
s are to be populated by the client on an on-demand basis
instead of up-front. This can provide significant performance improvements for
tables that are very large or for which TableItem
population is
expensive (for example, retrieving values from an external source).
Here is an example of using a Table
with style VIRTUAL
:
final Table table = new Table (parent, SWT.VIRTUAL | SWT.BORDER);
table.setItemCount (1000000);
table.addListener (SWT.SetData, new Listener () {
public void handleEvent (Event event) {
TableItem item = (TableItem) event.item;
int index = table.indexOf (item);
item.setText ("Item " + index);
System.out.println (item.getText ());
}
});
Note that although this class is a subclass of Composite
,
it does not normally make sense to add Control
children to
it, or set a layout on it, unless implementing something like a cell
editor.
Note: Only one of the styles SINGLE, and MULTI may be specified.
IMPORTANT: This class is not intended to be subclassed.
Constructor Summary | |
---|---|
Table(Composite parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
Method Summary | |
---|---|
void |
addSelectionListener(SelectionListener listener)
Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener
interface.
|
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. |
TableColumn |
getColumn(int index)
Returns the column at the given, zero-relative index in the receiver. |
int |
getColumnCount()
Returns the number of columns contained in the receiver. |
TableColumn[] |
getColumns()
Returns an array of TableColumn s which are the
columns in the receiver. |
int |
getGridLineWidth()
Returns the width in pixels of a grid line. |
int |
getHeaderHeight()
Returns the height of the receiver's header |
boolean |
getHeaderVisible()
Returns true if the receiver's header is visible,
and false otherwise.
|
TableItem |
getItem(int index)
Returns the item at the given, zero-relative index in the receiver. |
TableItem |
getItem(Point point)
Returns the item at the given point in the receiver or null if no such item exists. |
int |
getItemCount()
Returns the number of items contained in the receiver. |
int |
getItemHeight()
Returns the height of the area which would be used to display one of the items in the receiver. |
TableItem[] |
getItems()
Returns a (possibly empty) array of TableItem s which
are the items in the receiver.
|
boolean |
getLinesVisible()
Returns true if the receiver's lines are visible,
and false otherwise. |
TableItem[] |
getSelection()
Returns an array of TableItem s that are currently
selected in the receiver. |
int |
getSelectionCount()
Returns the number of selected items contained in the receiver. |
int |
getSelectionIndex()
Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected. |
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(TableColumn column)
Searches the receiver's list starting at the first column (index 0) until a column is found that is equal to the argument, and returns the index of that column. |
int |
indexOf(TableItem item)
Searches the receiver's list starting at the first item (index 0) 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's list 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 |
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 user changes the receiver's selection. |
void |
select(int index)
Selects the item at the given zero-relative index in the receiver. |
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 |
setHeaderVisible(boolean show)
Marks the receiver's header as visible if the argument is true ,
and marks it invisible otherwise.
|
void |
setItemCount(int count)
Sets the number of items contained in the receiver. |
void |
setLinesVisible(boolean show)
Marks the receiver's lines as visible if the argument is true ,
and marks it invisible otherwise. |
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(TableItem[] items)
Sets the receiver's selection to be the given array of items. |
void |
setTopIndex(int index)
Sets the zero-relative index of the item which is currently at the top of the receiver. |
void |
showColumn(TableColumn column)
Shows the column. |
void |
showItem(TableItem item)
Shows the item. |
void |
showSelection()
Shows the selection. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
checkSubclass, getBackgroundMode, getChildren, getLayout, getTabList, layout, layout, setBackgroundMode, setLayout, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, 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 |
Constructor Detail |
public Table(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 composite control which will be the parent of the new instance (cannot be null)style
- the style of control to construct
IllegalArgumentException
- SWTException
- SWT.SINGLE
,
SWT.MULTI
,
SWT.CHECK
,
SWT.FULL_SELECTION
,
SWT.HIDE_SELECTION
,
SWT#VIRTUAL
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
When widgetSelected
is called, the item field of the event object is valid.
If the receiver has the SWT.CHECK
style and the check selection changes,
the event object detail field contains the value SWT.CHECK
.
widgetDefaultSelected
is typically called when an item is double-clicked.
The item field of the event object is valid for default selection, but the detail field is not used.
listener
- the listener which should be notified when the user changes the receiver's selection
IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public void deselect(int[] indices)
indices
- the array of indices for the items to deselect
IllegalArgumentException
- SWTException
- 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 deselectAll()
SWTException
- public TableColumn getColumn(int index)
TableColumn
s were created by the programmer,
this method will throw ERROR_INVALID_RANGE
despite
the fact that a single column of data may be visible in the table.
This occurs when the programmer uses the table like a list, adding
items but never creating a column.
index
- the index of the column to return
IllegalArgumentException
- SWTException
- public int getColumnCount()
TableColumn
s were created by the programmer,
this value is zero, despite the fact that visually, one column
of items may be visible. This occurs when the programmer uses
the table like a list, adding items but never creating a column.
SWTException
- public TableColumn[] getColumns()
TableColumn
s which are the
columns in the receiver. Columns are returned in the order
that they were created. If no TableColumn
s were
created by the programmer, the array is empty, despite the fact
that visually, one column of items may be visible. This occurs
when the programmer uses the table like a list, adding items but
never creating a column.
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
- public int getGridLineWidth()
SWTException
- public int getHeaderHeight()
SWTException
- public boolean getHeaderVisible()
true
if the receiver's header is visible,
and false
otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.
SWTException
- public TableItem getItem(int index)
index
- the index of the item to return
IllegalArgumentException
- SWTException
- public TableItem getItem(Point point)
The item that is returned represents an item that could be selected by the user. For example, if selection only occurs in items in the first column, then null is returned if the point is outside of the item. Note that the SWT.FULL_SELECTION style hint, which specifies the selection policy, determines the extent of the selection.
point
- the point used to locate the item
IllegalArgumentException
- SWTException
- public int getItemCount()
SWTException
- public int getItemHeight()
SWTException
- public TableItem[] getItems()
TableItem
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
- public boolean getLinesVisible()
true
if the receiver's lines are visible,
and false
otherwise. Note that some platforms draw
grid lines while others may draw alternating row colors.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.
SWTException
- public TableItem[] getSelection()
TableItem
s that are currently
selected in the receiver. The order of the items is unspecified.
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
- public int getSelectionCount()
SWTException
- public int getSelectionIndex()
SWTException
- 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
- public int getTopIndex()
SWTException
- public int indexOf(TableColumn column)
column
- the search column
IllegalArgumentException
- SWTException
- public int indexOf(TableItem item)
item
- the search item
IllegalArgumentException
- SWTException
- 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[] indices)
indices
- the array of indices of the items
IllegalArgumentException
- SWTException
- public void remove(int index)
index
- the index for the item
IllegalArgumentException
- SWTException
- public void remove(int start, int end)
start
- the start of the rangeend
- the end of the range
IllegalArgumentException
- SWTException
- public void removeAll()
SWTException
- public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notified
IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(SelectionListener)
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
- setSelection(int[])
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
- setSelection(int,int)
public void selectAll()
If the receiver is single-select, do nothing.
SWTException
- public void setHeaderVisible(boolean show)
true
,
and marks it invisible otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.
show
- the new visibility state
SWTException
- public void setItemCount(int count)
count
- the number of items
SWTException
- public void setLinesVisible(boolean show)
true
,
and marks it invisible otherwise. Note that some platforms draw grid lines
while others may draw alternating row colors.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.
show
- the new visibility state
SWTException
- 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
- deselectAll()
,
select(int[])
public void setSelection(TableItem[] 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
- deselectAll()
,
select(int[])
,
setSelection(int[])
public void setSelection(int index)
index
- the index of the item to select
SWTException
- deselectAll()
,
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
- deselectAll()
,
select(int,int)
public void setTopIndex(int index)
index
- the index of the top item
SWTException
- public void showColumn(TableColumn column)
column
- the column to be shown
IllegalArgumentException
- SWTException
- public void showItem(TableItem item)
item
- the item to be shown
IllegalArgumentException
- SWTException
- showSelection()
public void showSelection()
SWTException
- showItem(TableItem)
|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |