|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.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 issue notificiation when selected.
The item children that may be added to instances of this class
must be of type TableItem
.
Note that although this class is a subclass of Composite
,
it does not make sense to add Control
children to it,
or set a layout on it.
Note: Only one of the styles SINGLE, and MULTI may be specified.
IMPORTANT: This class is not intended to be subclassed.
Field Summary |
Fields inherited from class org.eclipse.swt.widgets.Control |
handle |
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 receiver's selection changes, by sending it one of the messages defined in the SelectionListener
interface. |
protected void |
checkSubclass()
Checks that this class can be subclassed. |
Point |
computeSize(int wHint,
int hHint,
boolean changed)
Returns the preferred size of the receiver. |
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's. |
TableItem[] |
getItems()
Returns an 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 receiver's selection changes. |
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 at the given zero-relative indices in the receiver. |
void |
selectAll()
Selects all the items in the receiver. |
void |
setFont(Font font)
Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null. |
void |
setHeaderVisible(boolean show)
Marks the receiver's header as visible if the argument is true ,
and marks it invisible otherwise. |
void |
setLinesVisible(boolean show)
Marks the receiver's lines as visible if the argument is true ,
and marks it invisible otherwise. |
void |
setRedraw(boolean redraw)
If the argument is false , causes subsequent drawing
operations in the receiver to be ignored. |
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 at 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 |
showItem(TableItem item)
Shows the item. |
void |
showSelection()
Shows the selection. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
getChildren, getLayout, getTabList, layout, layout, setFocus, 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, getStyle, 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
,
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 reciever has SWT.CHECK
style set 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
IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
protected void checkSubclass()
Widget
The SWT class library is intended to be subclassed
only at specific, controlled points (most notably,
Composite
and Canvas
when
implementing new widgets). This method enforces this
rule unless it is overridden.
IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.
The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.
checkSubclass
in class Composite
public Point computeSize(int wHint, int hHint, boolean changed)
Control
The preferred size of a control is the size that it would
best be displayed at. The width hint and height hint arguments
allow the caller to ask a control questions such as "Given a particular
width, how high does the control need to be to show all of the contents?"
To indicate that the caller does not wish to constrain a particular
dimension, the constant SWT.DEFAULT
is passed for the hint.
If the changed flag is true
, it indicates that the receiver's
contents have changed, therefore any caches that a layout manager
containing the control may have been keeping need to be flushed. When the
control is resized, the changed flag will be false
, so layout
manager caches can be retained.
computeSize
in class Composite
wHint
- the width hint (can be SWT.DEFAULT
)hHint
- the height hint (can be SWT.DEFAULT
)changed
- true
if the control's contents have changed, and false
otherwise
Layout
,
Control.getBorderWidth()
,
Control.getBounds()
,
Control.getSize()
,
Control.pack()
,
"computeTrim, getClientArea for controls that implement them"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 is may be visible. This occurs when the programmer uses
the table like a list, adding items but never creating a column.
SWTException
- SWTError
- public TableColumn[] getColumns()
TableColumn
s which are the
columns in the receiver. 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)
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.
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. 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
- SWTError
- 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 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[] indices)
indices
- the array of indices for the items to select
IllegalArgumentException
- SWTException
- public void select(int index)
index
- the index of the item to select
SWTException
- public void select(int start, int end)
start
- the start of the rangeend
- the end of the range
SWTException
- public void selectAll()
SWTException
- public void setFont(Font font)
Control
setFont
in class Control
font
- the new font (or null)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.
SWTException
- public void setLinesVisible(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.
SWTException
- public void setRedraw(boolean redraw)
Control
false
, causes subsequent drawing
operations in the receiver to be ignored. No drawing of any kind
can occur in the receiver until the flag is set to true.
Graphics operations that occurred while the flag was
false
are lost. When the flag is set to true
,
the entire widget is marked as needing to be redrawn.
Note: This operation is a hint and may not be supported on some platforms or for some widgets.
setRedraw
in class Control
redraw
- the new redraw stateControl.redraw()
,
Control.update()
public void setSelection(int[] indices)
indices
- the indices of the items to select
IllegalArgumentException
- SWTException
- deselectAll()
,
select(int[])
public void setSelection(TableItem[] items)
items
- the array of items
IllegalArgumentException
- SWTException
- deselectAll()
,
select(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)
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 showItem(TableItem item)
item
- the item to be shown
IllegalArgumentException
- SWTException
- showSelection()
public void showSelection()
IllegalArgumentException
- SWTException
- showItem(TableItem)
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |