|
Eclipse Platform Release 3.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.Tree
Instances of this class provide a selectable user interface object that displays a hierarchy of items and issue notification when an item in the hierarchy is selected.
The item children that may be added to instances of this class
must be of type TreeItem
.
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 | |
---|---|
Tree(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.
|
void |
addTreeListener(TreeListener listener)
Adds the listener to the collection of listeners who will be notified when an item in the receiver is expanded or collapsed by sending it one of the messages defined in the TreeListener
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 |
deselectAll()
Deselects all selected items in the receiver. |
TreeColumn |
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. |
TreeColumn[] |
getColumns()
Returns an array of TreeColumn 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.
|
TreeItem |
getItem(int index)
Returns the item at the given, zero-relative index in the receiver. |
TreeItem |
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 that are direct item children of the receiver. |
int |
getItemHeight()
Returns the height of the area which would be used to display one of the items in the tree. |
TreeItem[] |
getItems()
Returns a (possibly empty) array of items contained in the receiver that are direct item children of the receiver. |
boolean |
getLinesVisible()
Returns true if the receiver's lines are visible,
and false otherwise.
|
TreeItem |
getParentItem()
Returns the receiver's parent item, which must be a TreeItem or null when the receiver is a
root. |
TreeItem[] |
getSelection()
Returns an array of TreeItem s that are currently
selected in the receiver. |
int |
getSelectionCount()
Returns the number of selected items contained in the receiver. |
TreeItem |
getTopItem()
Returns the item which is currently at the top of the receiver. |
int |
indexOf(TreeColumn 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(TreeItem 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. |
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 |
removeTreeListener(TreeListener listener)
Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.. |
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 |
setInsertMark(TreeItem item,
boolean before)
Display a mark indicating the point at which an item will be inserted. |
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(TreeItem[] items)
Sets the receiver's selection to be the given array of items. |
void |
setTopItem(TreeItem item)
Sets the item which is currently at the top of the receiver. |
void |
showColumn(TreeColumn column)
Shows the column. |
void |
showItem(TreeItem item)
Shows the item. |
void |
showSelection()
Shows the selection. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setFocus, setLayout, setLayoutDeferred, 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 Tree(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
,
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
public void addTreeListener(TreeListener listener)
TreeListener
interface.
listener
- the listener which should be notified
IllegalArgumentException
- SWTException
- TreeListener
,
removeTreeListener(org.eclipse.swt.events.TreeListener)
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
public void deselectAll()
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 TreeColumn getColumn(int index)
TreeColumn
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 tree.
This occurs when the programmer uses the tree like a list, adding
items but never creating a column.
index
- the index of the column to return
IllegalArgumentException
- SWTException
- public int getColumnCount()
TreeColumn
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 tree like a list, adding items but never creating a column.
SWTException
- public TreeColumn[] getColumns()
TreeColumn
s which are the
columns in the receiver. If no TreeColumn
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 tree 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 TreeItem getItem(int index)
index
- the index of the item to return
IllegalArgumentException
- SWTException
- public TreeItem getItem(Point point)
point
- the point used to locate the item
IllegalArgumentException
- SWTException
- public int getItemCount()
SWTException
- public int getItemHeight()
SWTException
- public TreeItem[] getItems()
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 TreeItem getParentItem()
TreeItem
or null when the receiver is a
root.
SWTException
- public TreeItem[] getSelection()
TreeItem
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 TreeItem getTopItem()
SWTException
- public int indexOf(TreeColumn column)
column
- the search column
IllegalArgumentException
- SWTException
- public int indexOf(TreeItem item)
item
- the search item
IllegalArgumentException
- SWTException
- 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 removeTreeListener(TreeListener listener)
listener
- the listener which should no longer be notified
IllegalArgumentException
- SWTException
- TreeListener
,
addTreeListener(org.eclipse.swt.events.TreeListener)
public void setInsertMark(TreeItem item, boolean before)
item
- the insert item. Null will clear the insertion mark.before
- true places the insert mark above 'item'. false places
the insert mark below 'item'.
IllegalArgumentException
- 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.
show
- the new visibility state
SWTException
- 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 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. Nested calls
to this method are stacked.
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(int, int, int, int, boolean)
,
Control.update()
public void setSelection(TreeItem[] 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()
public void setTopItem(TreeItem item)
item
- the item to be shown
IllegalArgumentException
- SWTException
- getTopItem()
public void showColumn(TreeColumn column)
column
- the column to be shown
IllegalArgumentException
- SWTException
- public void showItem(TreeItem item)
item
- the item to be shown
IllegalArgumentException
- SWTException
- showSelection()
public void showSelection()
SWTException
- showItem(TreeItem)
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.