org.eclipse.swt.widgets

Class Tree

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.Tree

All Implemented Interfaces:

Drawable

public class Tree
extends Composite

Instances of this class provide a selectable user interface object that displays a hierarchy of items and issues 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.

Style VIRTUAL is used to create a Tree whose TreeItems are to be populated by the client on an on-demand basis instead of up-front. This can provide significant performance improvements for trees that are very large or for which TreeItem population is expensive (for example, retrieving values from an external source).

Here is an example of using a Tree with style VIRTUAL:

  final Tree tree = new Tree(parent, SWT.VIRTUAL | SWT.BORDER);
  tree.setItemCount(20);
  tree.addListener(SWT.SetData, new Listener() {
      public void handleEvent(Event event) {
          TreeItem item = (TreeItem)event.item;
          TreeItem parentItem = item.getParentItem();
          String text = null;
          if (parentItem == null) {
              text = "node " + tree.indexOf(item);
          } else {
              text = parentItem.getText() + " - " + parentItem.indexOf(item);
          }
          item.setText(text);
          System.out.println(text);
          item.setItemCount(10);
      }
  });
 

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.

Styles:

SINGLE, MULTI, CHECK, FULL_SELECTION, VIRTUAL, NO_SCROLL

Events:

Selection, DefaultSelection, Collapse, Expand, SetData, MeasureItem, EraseItem, PaintItem

Note: Only one of the styles SINGLE and MULTI may be specified.

IMPORTANT: This class is not intended to be subclassed.

See Also:

Tree, TreeItem, TreeColumn snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	columnCount
(package private) TreeColumn[]	columns
(package private) boolean	createdAsRTL
(package private) TreeItem	currentItem
(package private) boolean	customDraw
(package private) static int	DRAG_IMAGE_SIZE
(package private) boolean	dragStarted
(package private) static boolean	ENABLE_TVS_EX_FADEINOUTEXPANDOS
(package private) static int	EXPLORER_EXTRA
(package private) static boolean	EXPLORER_THEME
(package private) boolean	explorerTheme
(package private) RECT	focusRect
(package private) boolean	gestureCompleted
(package private) static int	GRID_WIDTH
(package private) int	hAnchor
(package private) static int	HEADER_EXTRA
(package private) static int	HEADER_MARGIN
(package private) static TCHAR	HeaderClass
(package private) ImageList	headerImageList
(package private) static int	HeaderProc
(package private) int	headerToolTipHandle
(package private) int	hFirstIndexOf
(package private) int	hInsert
(package private) int	hLastIndexOf
(package private) int	hSelect
(package private) int	hwndHeader
(package private) int	hwndParent
(package private) boolean	ignoreColumnMove
(package private) boolean	ignoreCustomDraw
(package private) boolean	ignoreDeselect
(package private) boolean	ignoreDrawBackground
(package private) boolean	ignoreDrawFocus
(package private) boolean	ignoreDrawForeground
(package private) boolean	ignoreDrawHot
(package private) boolean	ignoreDrawSelection
(package private) boolean	ignoreExpand
(package private) boolean	ignoreFullSelection
(package private) boolean	ignoreItemHeight
(package private) boolean	ignoreResize
(package private) boolean	ignoreSelect
(package private) boolean	ignoreShrink
(package private) ImageList	imageList
(package private) static int	INCREMENT
(package private) boolean	insertAfter
(package private) static int	INSET
(package private) int	itemCount
(package private) TreeItem[]	items
(package private) int	itemToolTipHandle
(package private) int	lastID
(package private) int	lastIndexOf
(package private) int	lastTimerCount
(package private) int	lastTimerID
(package private) boolean	linesVisible
(package private) boolean	lockSelection
(package private) boolean	newSelected
(package private) boolean	oldSelected
(package private) boolean	painted
(package private) boolean	printClient
(package private) int	scrollWidth
(package private) int	selectionForeground
(package private) boolean	shrink
(package private) static int	SORT_WIDTH
(package private) TreeColumn	sortColumn
(package private) int	sortDirection
(package private) static int	TIMER_MAX_COUNT
(package private) static TCHAR	TreeClass
(package private) static int	TreeProc

Fields inherited from class org.eclipse.swt.widgets.Composite

backgroundMode, layout, layoutCount, lpwp, tabList

Fields inherited from class org.eclipse.swt.widgets.Scrollable

horizontalBar, verticalBar

Fields inherited from class org.eclipse.swt.widgets.Control

accessible, background, backgroundImage, cursor, drawCount, font, foreground, handle, layoutData, menu, parent, region, toolTipText

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
(package private) void	_addListener(int eventType, Listener listener)
(package private) TreeItem	_getItem(int hItem)
(package private) TreeItem	_getItem(int hItem, int id)
(package private) void	_setBackgroundPixel(int newPixel)
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	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.
(package private) int	borderHandle()
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
(package private) LRESULT	CDDS_ITEMPOSTPAINT(NMTVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_ITEMPREPAINT(NMTVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_POSTPAINT(NMTVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_PREPAINT(NMTVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) void	checkBuffered()
(package private) boolean	checkData(TreeItem item, boolean redraw)
(package private) boolean	checkData(TreeItem item, int index, boolean redraw)
(package private) boolean	checkHandle(int hwnd)
(package private) boolean	checkScroll(int hItem)
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
void	clear(int index, boolean all) Clears the item at the given zero-relative index in the receiver.
(package private) void	clear(int hItem, TVITEM tvItem)
void	clearAll(boolean all) Clears all the items in the receiver.
(package private) void	clearAll(int hItem, TVITEM tvItem, boolean all)
(package private) int	CompareFunc(int lParam1, int lParam2, int lParamSort)
Point	computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.
(package private) void	createHandle()
(package private) void	createHeaderToolTips()
(package private) void	createItem(TreeColumn column, int index)
(package private) void	createItem(TreeItem item, int hParent, int hInsertAfter, int hItem)
(package private) void	createItemToolTips()
(package private) void	createParent()
(package private) void	createWidget()
(package private) int	defaultBackground()
(package private) void	deregister()
(package private) void	deselect(int hItem, TVITEM tvItem, int hIgnoreItem)
void	deselect(TreeItem item) Deselects an item in the receiver.
void	deselectAll() Deselects all selected items in the receiver.
(package private) void	destroyItem(TreeColumn column)
(package private) void	destroyItem(TreeItem item, int hItem)
(package private) void	destroyScrollBar(int type)
(package private) void	enableDrag(boolean enabled)
(package private) void	enableWidget(boolean enabled)
(package private) boolean	findCell(int x, int y, TreeItem[] item, int[] index, RECT[] cellRect, RECT[] itemRect)
(package private) int	findIndex(int hFirstItem, int hItem)
(package private) Widget	findItem(int hItem)
(package private) int	findItem(int hFirstItem, int index)
(package private) int	getBottomItem()
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.
int[]	getColumnOrder() Returns an array of zero-relative integers that map the creation order of the receiver's items to the order in which they are currently being displayed.
TreeColumn[]	getColumns() Returns an array of TreeColumns which are the columns in the receiver.
(package private) TreeItem	getFocusItem()
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.
(package private) Point	getImageSize()
TreeItem	getItem(int index) Returns the item at the given, zero-relative index in the receiver.
(package private) TreeItem	getItem(NMTVCUSTOMDRAW nmcd)
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.
(package private) int	getItemCount(int hItem)
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.
(package private) TreeItem[]	getItems(int hTreeItem)
boolean	getLinesVisible() Returns true if the receiver's lines are visible, and false otherwise.
(package private) int	getNextSelection(int hItem, TVITEM tvItem)
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 TreeItems that are currently selected in the receiver.
(package private) int	getSelection(int hItem, TVITEM tvItem, TreeItem[] selection, int index, int count, boolean bigSelection, boolean all)
int	getSelectionCount() Returns the number of selected items contained in the receiver.
TreeColumn	getSortColumn() Returns the column which shows the sort indicator for the receiver.
(package private) int	getSortColumnPixel()
int	getSortDirection() Returns the direction of the sort indicator for the receiver.
TreeItem	getTopItem() Returns the item which is currently at the top of the receiver.
(package private) boolean	hitTestSelection(int hItem, int x, int y)
(package private) int	imageIndex(Image image, int index)
(package private) int	imageIndexHeader(Image image)
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.
(package private) boolean	isCustomToolTip()
(package private) boolean	isItemSelected(NMTVCUSTOMDRAW nmcd)
(package private) void	redrawSelection()
(package private) void	register()
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseHandle()
(package private) void	releaseItem(int hItem, TVITEM tvItem, boolean release)
(package private) void	releaseItems(int hItem, TVITEM tvItem)
(package private) void	releaseWidget()
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	removeTreeListener(TreeListener listener) Removes the listener from the collection of listeners who will be notified when items in the receiver are expanded or collapsed.
(package private) void	reskinChildren(int flags)
(package private) int	scrolledHandle()
(package private) void	select(int hItem, TVITEM tvItem)
void	select(TreeItem item) Selects an item in the receiver.
void	selectAll() Selects all of the items in the receiver.
(package private) Event	sendEraseItemEvent(TreeItem item, NMTTCUSTOMDRAW nmcd, int column, RECT cellRect)
(package private) Event	sendMeasureItemEvent(TreeItem item, int index, int hDC, int detail)
(package private) Event	sendPaintItemEvent(TreeItem item, NMTTCUSTOMDRAW nmcd, int column, RECT itemRect)
(package private) void	setBackgroundImage(int hBitmap)
(package private) void	setBackgroundPixel(int pixel)
(package private) void	setCheckboxImageList()
void	setColumnOrder(int[] order) Sets the order that the items in the receiver should be displayed in to the given argument which is described in terms of the zero-relative ordering of when the items were added.
(package private) void	setCursor()
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.
(package private) void	setForegroundPixel(int pixel)
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	setItemCount(int count) Sets the number of root-level items contained in the receiver.
(package private) void	setItemCount(int count, int hParent, int hItem)
(package private) void	setItemHeight(int itemHeight) Sets the height of the area which would be used to display one of the items in the tree.
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.
(package private) void	setScrollWidth()
(package private) void	setScrollWidth(int width)
(package private) void	setSelection(int hItem, TVITEM tvItem, TreeItem[] selection)
void	setSelection(TreeItem item) Sets the receiver's selection to the given item.
void	setSelection(TreeItem[] items) Sets the receiver's selection to be the given array of items.
void	setSortColumn(TreeColumn column) Sets the column used by the sort indicator for the receiver.
void	setSortDirection(int direction) Sets the direction of the sort indicator for the receiver.
void	setTopItem(TreeItem item) Sets the item which is currently at the top of the receiver.
void	showColumn(TreeColumn column) Shows the column.
(package private) void	showItem(int hItem)
void	showItem(TreeItem item) Shows the item.
void	showSelection() Shows the selection.
(package private) void	sort()
(package private) void	sort(int hParent, boolean all)
(package private) void	subclass()
(package private) RECT	toolTipInset(RECT rect)
(package private) RECT	toolTipRect(RECT rect)
(package private) java.lang.String	toolTipText(NMTTDISPINFO hdr)
(package private) int	topHandle()
(package private) void	unsubclass()
(package private) void	updateFullSelection()
(package private) void	updateHeaderToolTips()
(package private) void	updateImageList()
(package private) void	updateImages()
(package private) void	updateMenuLocation(Event event)
(package private) void	updateOrientation()
(package private) void	updateScrollBar()
(package private) int	widgetStyle()
(package private) TCHAR	windowClass()
(package private) int	windowProc()
(package private) int	windowProc(int hwnd, int msg, int wParam, int lParam)
(package private) LRESULT	WM_CHAR(int wParam, int lParam)
(package private) LRESULT	WM_ERASEBKGND(int wParam, int lParam)
(package private) LRESULT	WM_GETOBJECT(int wParam, int lParam)
(package private) LRESULT	WM_HSCROLL(int wParam, int lParam)
(package private) LRESULT	WM_KEYDOWN(int wParam, int lParam)
(package private) LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDBLCLK(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_MOUSEMOVE(int wParam, int lParam)
(package private) LRESULT	WM_MOUSEWHEEL(int wParam, int lParam)
(package private) LRESULT	WM_MOVE(int wParam, int lParam)
(package private) LRESULT	WM_PAINT(int wParam, int lParam)
(package private) LRESULT	WM_PRINTCLIENT(int wParam, int lParam)
(package private) LRESULT	WM_RBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_SETCURSOR(int wParam, int lParam)
(package private) LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_SETFONT(int wParam, int lParam)
(package private) LRESULT	WM_SETREDRAW(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	WM_SYSCOLORCHANGE(int wParam, int lParam)
(package private) LRESULT	WM_TIMER(int wParam, int lParam)
(package private) LRESULT	WM_VSCROLL(int wParam, int lParam)
(package private) LRESULT	wmColorChild(int wParam, int lParam)
(package private) LRESULT	wmNotify(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyChild(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyHeader(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyToolTip(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyToolTip(NMTTCUSTOMDRAW nmcd, int lParam)

Methods inherited from class org.eclipse.swt.widgets.Composite

_getChildren, _getTabList, changed, checkComposited, computeTabList, copyArea, drawBackground, findDeferredControl, findMenus, fixChildren, fixTabList, getBackgroundMode, getChildren, getChildrenCount, getLayout, getLayoutDeferred, getTabList, hooksKeys, isLayoutDeferred, layout, layout, layout, layout, layout, markLayout, minimumSize, redrawChildren, releaseParent, removeControl, resizeChildren, resizeChildren, resizeEmbeddedHandle, sendResize, setBackgroundMode, setBounds, setFocus, setLayout, setLayoutDeferred, setResizeChildren, setTabGroupFocus, setTabList, translateMnemonic, translateTraversal, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateLayout, updateLayout, updateUIState, WM_GETDLGCODE, WM_GETFONT, WM_NCHITTEST, WM_PARENTNOTIFY, WM_SYSCOMMAND, WM_UPDATEUISTATE, wmNCPaint

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, createScrollBar, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, widgetExtStyle, wmScroll, wmScrollWheel

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, binarySearch, checkBackground, checkBorder, checkGesture, checkMirrored, computeSize, computeTabGroup, computeTabRoot, defaultFont, defaultForeground, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, drawThemeBackground, fillBackground, fillImageBackground, fillThemeBackground, findBackgroundControl, findBrush, findCursor, findImageControl, findMnemonic, findThemeControl, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundImage, getBackgroundPixel, getBorderWidth, getBounds, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, mapEvent, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, new_Accessible, new_GC, pack, pack, print, printWidget, redraw, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, sendFocusEvent, sendGestureEvent, sendMove, sendTouchEvent, setBackground, setBackground, setBackgroundImage, setBounds, setBounds, setBounds, setCapture, setCursor, setDefaultFont, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRadioFocus, setRadioSelection, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, setVisible, showWidget, sort, toControl, toControl, toDisplay, toDisplay, translateAccelerator, translateMnemonic, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, update, widgetCreateStruct, widgetParent, WM_ACTIVATE, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CONTEXTMENU, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ENTERIDLE, WM_GESTURE, WM_GETMINMAXINFO, WM_HELP, WM_HOTKEY, WM_IME_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INITMENUPOPUP, WM_INPUTLANGCHANGE, WM_KEYUP, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHOVER, WM_MOUSEHWHEEL, WM_MOUSELEAVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PALETTECHANGED, WM_PASTE, WM_PRINT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONDBLCLK, WM_RBUTTONUP, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING, WM_XBUTTONDBLCLK, WM_XBUTTONDOWN, WM_XBUTTONUP, wmCommandChild, wmDrawChild, wmMeasureChild, wmScrollChild

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkBits, checkOpened, checkOrientation, checkParent, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, notifyListeners, postEvent, postEvent, release, removeDisposeListener, removeListener, removeListener, reskin, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, SetWindowPos, showMenu, showMenu, toString, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

items

TreeItem[] items

columns

TreeColumn[] columns

columnCount

int columnCount

imageList

ImageList imageList

headerImageList

ImageList headerImageList

currentItem

TreeItem currentItem

sortColumn

TreeColumn sortColumn

focusRect

RECT focusRect

hwndParent

int hwndParent

hwndHeader

int hwndHeader

hAnchor

int hAnchor

hInsert

int hInsert

hSelect

int hSelect

lastID

int lastID

hFirstIndexOf

int hFirstIndexOf

hLastIndexOf

int hLastIndexOf

lastIndexOf

int lastIndexOf

itemCount

int itemCount

sortDirection

int sortDirection

dragStarted

boolean dragStarted

gestureCompleted

boolean gestureCompleted

insertAfter

boolean insertAfter

shrink

boolean shrink

ignoreShrink

boolean ignoreShrink

ignoreSelect

boolean ignoreSelect

ignoreExpand

boolean ignoreExpand

ignoreDeselect

boolean ignoreDeselect

ignoreResize

boolean ignoreResize

lockSelection

boolean lockSelection

oldSelected

boolean oldSelected

newSelected

boolean newSelected

ignoreColumnMove

boolean ignoreColumnMove

linesVisible

boolean linesVisible

customDraw

boolean customDraw

printClient

boolean printClient

painted

boolean painted

ignoreItemHeight

boolean ignoreItemHeight

ignoreCustomDraw

boolean ignoreCustomDraw

ignoreDrawForeground

boolean ignoreDrawForeground

ignoreDrawBackground

boolean ignoreDrawBackground

ignoreDrawFocus

boolean ignoreDrawFocus

ignoreDrawSelection

boolean ignoreDrawSelection

ignoreDrawHot

boolean ignoreDrawHot

ignoreFullSelection

boolean ignoreFullSelection

explorerTheme

boolean explorerTheme

createdAsRTL

boolean createdAsRTL

scrollWidth

int scrollWidth

selectionForeground

int selectionForeground

headerToolTipHandle

int headerToolTipHandle

itemToolTipHandle

int itemToolTipHandle

lastTimerID

int lastTimerID

lastTimerCount

int lastTimerCount

ENABLE_TVS_EX_FADEINOUTEXPANDOS

static final boolean ENABLE_TVS_EX_FADEINOUTEXPANDOS

TIMER_MAX_COUNT

static final int TIMER_MAX_COUNT

See Also:

Constant Field Values

INSET

static final int INSET

See Also:

Constant Field Values

GRID_WIDTH

static final int GRID_WIDTH

See Also:

Constant Field Values

SORT_WIDTH

static final int SORT_WIDTH

See Also:

Constant Field Values

HEADER_MARGIN

static final int HEADER_MARGIN

See Also:

Constant Field Values

HEADER_EXTRA

static final int HEADER_EXTRA

See Also:

Constant Field Values

INCREMENT

static final int INCREMENT

See Also:

Constant Field Values

EXPLORER_EXTRA

static final int EXPLORER_EXTRA

See Also:

Constant Field Values

DRAG_IMAGE_SIZE

static final int DRAG_IMAGE_SIZE

See Also:

Constant Field Values

EXPLORER_THEME

static final boolean EXPLORER_THEME

See Also:

Constant Field Values

TreeProc

static final int TreeProc

TreeClass

static final TCHAR TreeClass

HeaderProc

static final int HeaderProc

HeaderClass

static final TCHAR HeaderClass

Constructor Detail

Tree

public Tree(Composite parent,
    int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

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.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.SINGLE, SWT.MULTI, SWT.CHECK, SWT.FULL_SELECTION, SWT.VIRTUAL, SWT.NO_SCROLL, Widget.checkSubclass(), Widget.getStyle()

Method Detail

checkStyle

static int checkStyle(int style)

_addListener

void _addListener(int eventType,
                Listener listener)

Overrides:

_addListener in class Widget

_getItem

TreeItem _getItem(int hItem)

_getItem

TreeItem _getItem(int hItem,
                int id)

_setBackgroundPixel

void _setBackgroundPixel(int newPixel)

addSelectionListener

public 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.

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.

Parameters:

listener - the listener which should be notified when the user changes the receiver's selection

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

addTreeListener

public 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.

Parameters:

listener - the listener which should be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

TreeListener, removeTreeListener(org.eclipse.swt.events.TreeListener)

borderHandle

int borderHandle()

Overrides:

borderHandle in class Control

CDDS_ITEMPOSTPAINT

LRESULT CDDS_ITEMPOSTPAINT(NMTVCUSTOMDRAW nmcd,
                         int wParam,
                         int lParam)

CDDS_ITEMPREPAINT

LRESULT CDDS_ITEMPREPAINT(NMTVCUSTOMDRAW nmcd,
                        int wParam,
                        int lParam)

CDDS_POSTPAINT

LRESULT CDDS_POSTPAINT(NMTVCUSTOMDRAW nmcd,
                     int wParam,
                     int lParam)

CDDS_PREPAINT

LRESULT CDDS_PREPAINT(NMTVCUSTOMDRAW nmcd,
                    int wParam,
                    int lParam)

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam)

Overrides:

callWindowProc in class Scrollable

checkBuffered

void checkBuffered()

Overrides:

checkBuffered in class Composite

checkData

boolean checkData(TreeItem item,
                boolean redraw)

checkData

boolean checkData(TreeItem item,
                int index,
                boolean redraw)

checkHandle

boolean checkHandle(int hwnd)

Overrides:

checkHandle in class Control

checkScroll

boolean checkScroll(int hItem)

checkSubclass

protected void checkSubclass()

Description copied from class: Widget

Checks that this class can be subclassed.

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.

Overrides:

checkSubclass in class Composite

clear

public void clear(int index,
         boolean all)

Clears the item at the given zero-relative index in the receiver. The text, icon and other attributes of the item are set to the default value. If the tree was created with the SWT.VIRTUAL style, these attributes are requested again as needed.

Parameters:

index - the index of the item to clear

all - true if all child items of the indexed item should be cleared recursively, and false otherwise

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

See Also:

SWT.VIRTUAL, SWT.SetData

clear

void clear(int hItem,
         TVITEM tvItem)

clearAll

public void clearAll(boolean all)

Clears all the items in the receiver. The text, icon and other attributes of the items are set to their default values. If the tree was created with the SWT.VIRTUAL style, these attributes are requested again as needed.

Parameters:

all - true if all child items should be cleared recursively, and false otherwise

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

See Also:

SWT.VIRTUAL, SWT.SetData

clearAll

void clearAll(int hItem,
            TVITEM tvItem,
            boolean all)

CompareFunc

int CompareFunc(int lParam1,
              int lParam2,
              int lParamSort)

computeSize

public Point computeSize(int wHint,
                int hHint,
                boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

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.

Overrides:

computeSize in class Composite

Parameters:

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

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(boolean), "computeTrim, getClientArea for controls that implement them"

createHandle

void createHandle()

Overrides:

createHandle in class Composite

createHeaderToolTips

void createHeaderToolTips()

createItem

void createItem(TreeColumn column,
              int index)

createItem

void createItem(TreeItem item,
              int hParent,
              int hInsertAfter,
              int hItem)

createItemToolTips

void createItemToolTips()

createParent

void createParent()

createWidget

void createWidget()

Overrides:

createWidget in class Scrollable

defaultBackground

int defaultBackground()

Overrides:

defaultBackground in class Control

deregister

void deregister()

Overrides:

deregister in class Control

deselect

void deselect(int hItem,
            TVITEM tvItem,
            int hIgnoreItem)

deselect

public void deselect(TreeItem item)

Deselects an item in the receiver. If the item was already deselected, it remains deselected.

Parameters:

item - the item to be deselected

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.4

deselectAll

public void deselectAll()

Deselects all selected items in the receiver.

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

destroyItem

void destroyItem(TreeColumn column)

destroyItem

void destroyItem(TreeItem item,
               int hItem)

destroyScrollBar

void destroyScrollBar(int type)

Overrides:

destroyScrollBar in class Scrollable

enableDrag

void enableDrag(boolean enabled)

Overrides:

enableDrag in class Control

enableWidget

void enableWidget(boolean enabled)

Overrides:

enableWidget in class Control

findCell

boolean findCell(int x,
               int y,
               TreeItem[] item,
               int[] index,
               RECT[] cellRect,
               RECT[] itemRect)

findIndex

int findIndex(int hFirstItem,
            int hItem)

findItem

Widget findItem(int hItem)

Overrides:

findItem in class Widget

findItem

int findItem(int hFirstItem,
           int index)

getFocusItem

TreeItem getFocusItem()

getGridLineWidth

public int getGridLineWidth()

Returns the width in pixels of a grid line.

Returns:

the width of a grid line in pixels

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

getHeaderHeight

public int getHeaderHeight()

Returns the height of the receiver's header

Returns:

the height of the header or zero if the header is not visible

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

getHeaderVisible

public boolean getHeaderVisible()

Returns 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.

Returns:

the receiver's header's visibility state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

getImageSize

Point getImageSize()

getBottomItem

int getBottomItem()

getColumn

public TreeColumn getColumn(int index)

Returns the column at the given, zero-relative index in the receiver. Throws an exception if the index is out of range. Columns are returned in the order that they were created. If no TreeColumns 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.

Parameters:

index - the index of the column to return

Returns:

the column at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

See Also:

getColumnOrder(), setColumnOrder(int[]), TreeColumn.getMoveable(), TreeColumn.setMoveable(boolean), SWT.Move

getColumnCount

public int getColumnCount()

Returns the number of columns contained in the receiver. If no TreeColumns 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.

Returns:

the number of columns

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

getColumnOrder

public int[] getColumnOrder()

Returns an array of zero-relative integers that map the creation order of the receiver's items to the order in which they are currently being displayed.

Specifically, the indices of the returned array represent the current visual order of the items, and the contents of the array represent the creation order of the items.

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.

Returns:

the current visual order of the receiver's items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

See Also:

setColumnOrder(int[]), TreeColumn.getMoveable(), TreeColumn.setMoveable(boolean), SWT.Move

getColumns

public TreeColumn[] getColumns()

Returns an array of TreeColumns which are the columns in the receiver. Columns are returned in the order that they were created. If no TreeColumns 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.

Returns:

the items in the receiver

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

See Also:

getColumnOrder(), setColumnOrder(int[]), TreeColumn.getMoveable(), TreeColumn.setMoveable(boolean), SWT.Move

getItem

public TreeItem getItem(int index)

Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:

index - the index of the item to return

Returns:

the item at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

getItem

TreeItem getItem(NMTVCUSTOMDRAW nmcd)

getItem

public TreeItem getItem(Point point)

Returns the item at the given point in the receiver or null if no such item exists. The point is in the coordinate system of the receiver.

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.

Parameters:

point - the point used to locate the item

Returns:

the item at the given point, or null if the point is not in a selectable item

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver that are direct item children of the receiver. The number that is returned is the number of roots in the tree.

Returns:

the number of items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItemCount

int getItemCount(int hItem)

getItemHeight

public int getItemHeight()

Returns the height of the area which would be used to display one of the items in the tree.

Returns:

the height of one item

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItems

public TreeItem[] getItems()

Returns a (possibly empty) array of items contained in the receiver that are direct item children of the receiver. These are the roots of the tree.

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.

Returns:

the items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItems

TreeItem[] getItems(int hTreeItem)

getLinesVisible

public boolean getLinesVisible()

Returns 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.

Returns:

the visibility state of the lines

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

getNextSelection

int getNextSelection(int hItem,
                   TVITEM tvItem)

getParentItem

public TreeItem getParentItem()

Returns the receiver's parent item, which must be a TreeItem or null when the receiver is a root.

Returns:

the receiver's parent item

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getSelection

int getSelection(int hItem,
               TVITEM tvItem,
               TreeItem[] selection,
               int index,
               int count,
               boolean bigSelection,
               boolean all)

getSelection

public TreeItem[] getSelection()

Returns an array of TreeItems 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.

Returns:

an array representing the selection

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getSelectionCount

public int getSelectionCount()

Returns the number of selected items contained in the receiver.

Returns:

the number of selected items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getSortColumn

public TreeColumn getSortColumn()

Returns the column which shows the sort indicator for the receiver. The value may be null if no column shows the sort indicator.

Returns:

the sort indicator

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

See Also:

setSortColumn(TreeColumn)

getSortColumnPixel

int getSortColumnPixel()

getSortDirection

public int getSortDirection()

Returns the direction of the sort indicator for the receiver. The value will be one of UP, DOWN or NONE.

Returns:

the sort direction

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

See Also:

setSortDirection(int)

getTopItem

public TreeItem getTopItem()

Returns the item which is currently at the top of the receiver. This item can change when items are expanded, collapsed, scrolled or new items are added or removed.

Returns:

the item at the top of the receiver

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

2.1

hitTestSelection

boolean hitTestSelection(int hItem,
                       int x,
                       int y)

imageIndex

int imageIndex(Image image,
             int index)

imageIndexHeader

int imageIndexHeader(Image image)

indexOf

public 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. If no column is found, returns -1.

Parameters:

column - the search column

Returns:

the index of the column

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the column is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

indexOf

public 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. If no item is found, returns -1.

Parameters:

item - the search item

Returns:

the index of the item

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

isCustomToolTip

boolean isCustomToolTip()

isItemSelected

boolean isItemSelected(NMTVCUSTOMDRAW nmcd)

redrawSelection

void redrawSelection()

register

void register()

Overrides:

register in class Control

releaseItem

void releaseItem(int hItem,
               TVITEM tvItem,
               boolean release)

releaseItems

void releaseItems(int hItem,
                TVITEM tvItem)

releaseHandle

void releaseHandle()

Overrides:

releaseHandle in class Control

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Composite

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Composite

removeAll

public void removeAll()

Removes all of the items from the receiver.

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

SelectionListener, addSelectionListener(org.eclipse.swt.events.SelectionListener)

removeTreeListener

public 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.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

TreeListener, addTreeListener(org.eclipse.swt.events.TreeListener)

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Composite

setInsertMark

public void setInsertMark(TreeItem item,
                 boolean before)

Display a mark indicating the point at which an item will be inserted. The drop insert item has a visual hint to show where a dragged item will be inserted when dropped on the tree.

Parameters:

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'.

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setItemCount

public void setItemCount(int count)

Sets the number of root-level items contained in the receiver.

Parameters:

count - the number of items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

setItemCount

void setItemCount(int count,
                int hParent,
                int hItem)

setItemHeight

void setItemHeight(int itemHeight)

Sets the height of the area which would be used to display one of the items in the tree.

Parameters:

itemHeight - the height of one item

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

setLinesVisible

public void setLinesVisible(boolean show)

Marks the receiver's lines as visible if the argument is 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.

Parameters:

show - the new visibility state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

scrolledHandle

int scrolledHandle()

Overrides:

scrolledHandle in class Scrollable

select

void select(int hItem,
          TVITEM tvItem)

select

public void select(TreeItem item)

Selects an item in the receiver. If the item was already selected, it remains selected.

Parameters:

item - the item to be selected

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.4

selectAll

public void selectAll()

Selects all of the items in the receiver.

If the receiver is single-select, do nothing.

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

sendEraseItemEvent

Event sendEraseItemEvent(TreeItem item,
                       NMTTCUSTOMDRAW nmcd,
                       int column,
                       RECT cellRect)

sendMeasureItemEvent

Event sendMeasureItemEvent(TreeItem item,
                         int index,
                         int hDC,
                         int detail)

sendPaintItemEvent

Event sendPaintItemEvent(TreeItem item,
                       NMTTCUSTOMDRAW nmcd,
                       int column,
                       RECT itemRect)

setBackgroundImage

void setBackgroundImage(int hBitmap)

Overrides:

setBackgroundImage in class Control

setBackgroundPixel

void setBackgroundPixel(int pixel)

Overrides:

setBackgroundPixel in class Control

setCursor

void setCursor()

Overrides:

setCursor in class Control

setColumnOrder

public void setColumnOrder(int[] order)

Sets the order that the items in the receiver should be displayed in to the given argument which is described in terms of the zero-relative ordering of when the items were added.

Parameters:

order - the new order to display the items

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item order is null
• ERROR_INVALID_ARGUMENT - if the item order is not the same length as the number of items

Since:

3.2

See Also:

getColumnOrder(), TreeColumn.getMoveable(), TreeColumn.setMoveable(boolean), SWT.Move

setCheckboxImageList

void setCheckboxImageList()

setFont

public void setFont(Font font)

Description copied from class: Control

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.

Overrides:

setFont in class Control

Parameters:

font - the new font (or null)

setForegroundPixel

void setForegroundPixel(int pixel)

Overrides:

setForegroundPixel in class Control

setHeaderVisible

public void setHeaderVisible(boolean show)

Marks the receiver's header as visible if the argument is 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.

Parameters:

show - the new visibility state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

setRedraw

public void setRedraw(boolean redraw)

Description copied from class: Control

If the argument is 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.

Overrides:

setRedraw in class Control

Parameters:

redraw - the new redraw state

See Also:

Control.redraw(int, int, int, int, boolean), Control.update()

setScrollWidth

void setScrollWidth()

setScrollWidth

void setScrollWidth(int width)

setSelection

void setSelection(int hItem,
                TVITEM tvItem,
                TreeItem[] selection)

setSelection

public void setSelection(TreeItem item)

Sets the receiver's selection to the given item. The current selection is cleared before the new item is selected.

If the item is not in the receiver, then it is ignored.

Parameters:

item - the item to select

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

setSelection

public void setSelection(TreeItem[] items)

Sets the receiver's selection to be the given array of items. The current selection is cleared before the new items are selected.

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.

Parameters:

items - the array of items

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the array of items is null
• ERROR_INVALID_ARGUMENT - if one of the items has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

deselectAll()

setSortColumn

public void setSortColumn(TreeColumn column)

Sets the column used by the sort indicator for the receiver. A null value will clear the sort indicator. The current sort column is cleared before the new column is set.

Parameters:

column - the column used by the sort indicator or null

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the column is disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

setSortDirection

public void setSortDirection(int direction)

Sets the direction of the sort indicator for the receiver. The value can be one of UP, DOWN or NONE.

Parameters:

direction - the direction of the sort indicator

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.2

setTopItem

public void setTopItem(TreeItem item)

Sets the item which is currently at the top of the receiver. This item can change when items are expanded, collapsed, scrolled or new items are added or removed.

Parameters:

item - the item to be shown

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

2.1

See Also:

getTopItem()

showItem

void showItem(int hItem)

showColumn

public void showColumn(TreeColumn column)

Shows the column. If the column is already showing in the receiver, this method simply returns. Otherwise, the columns are scrolled until the column is visible.

Parameters:

column - the column to be shown

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

Since:

3.1

showItem

public void showItem(TreeItem item)

Shows the item. If the item is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled and expanded until the item is visible.

Parameters:

item - the item to be shown

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

showSelection()

showSelection

public void showSelection()

Shows the selection. If the selection is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled until the selection is visible.

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

showItem(TreeItem)

sort

void sort()

sort

void sort(int hParent,
        boolean all)

subclass

void subclass()

Overrides:

subclass in class Control

toolTipInset

RECT toolTipInset(RECT rect)

toolTipRect

RECT toolTipRect(RECT rect)

toolTipText

java.lang.String toolTipText(NMTTDISPINFO hdr)

Overrides:

toolTipText in class Composite

topHandle

int topHandle()

Overrides:

topHandle in class Control

updateFullSelection

void updateFullSelection()

updateHeaderToolTips

void updateHeaderToolTips()

updateImageList

void updateImageList()

updateImages

void updateImages()

Overrides:

updateImages in class Control

updateMenuLocation

void updateMenuLocation(Event event)

Overrides:

updateMenuLocation in class Widget

updateOrientation

void updateOrientation()

Overrides:

updateOrientation in class Composite

updateScrollBar

void updateScrollBar()

unsubclass

void unsubclass()

Overrides:

unsubclass in class Control

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Composite

windowClass

TCHAR windowClass()

Overrides:

windowClass in class Scrollable

windowProc

int windowProc()

Overrides:

windowProc in class Scrollable

windowProc

int windowProc(int hwnd,
             int msg,
             int wParam,
             int lParam)

Overrides:

windowProc in class Control

WM_CHAR

LRESULT WM_CHAR(int wParam,
              int lParam)

Overrides:

WM_CHAR in class Control

WM_ERASEBKGND

LRESULT WM_ERASEBKGND(int wParam,
                    int lParam)

Overrides:

WM_ERASEBKGND in class Composite

WM_GETOBJECT

LRESULT WM_GETOBJECT(int wParam,
                   int lParam)

Overrides:

WM_GETOBJECT in class Control

WM_HSCROLL

LRESULT WM_HSCROLL(int wParam,
                 int lParam)

Overrides:

WM_HSCROLL in class Scrollable

WM_KEYDOWN

LRESULT WM_KEYDOWN(int wParam,
                 int lParam)

Overrides:

WM_KEYDOWN in class Control

WM_KILLFOCUS

LRESULT WM_KILLFOCUS(int wParam,
                   int lParam)

Overrides:

WM_KILLFOCUS in class Control

WM_LBUTTONDBLCLK

LRESULT WM_LBUTTONDBLCLK(int wParam,
                       int lParam)

Overrides:

WM_LBUTTONDBLCLK in class Control

WM_LBUTTONDOWN

LRESULT WM_LBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_LBUTTONDOWN in class Composite

WM_MOUSEMOVE

LRESULT WM_MOUSEMOVE(int wParam,
                   int lParam)

Overrides:

WM_MOUSEMOVE in class Control

WM_MOUSEWHEEL

LRESULT WM_MOUSEWHEEL(int wParam,
                    int lParam)

Overrides:

WM_MOUSEWHEEL in class Scrollable

WM_MOVE

LRESULT WM_MOVE(int wParam,
              int lParam)

Overrides:

WM_MOVE in class Control

WM_RBUTTONDOWN

LRESULT WM_RBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_RBUTTONDOWN in class Control

WM_PAINT

LRESULT WM_PAINT(int wParam,
               int lParam)

Overrides:

WM_PAINT in class Composite

WM_PRINTCLIENT

LRESULT WM_PRINTCLIENT(int wParam,
                     int lParam)

Overrides:

WM_PRINTCLIENT in class Composite

WM_SETCURSOR

LRESULT WM_SETCURSOR(int wParam,
                   int lParam)

Overrides:

WM_SETCURSOR in class Control

WM_SETFOCUS

LRESULT WM_SETFOCUS(int wParam,
                  int lParam)

Overrides:

WM_SETFOCUS in class Control

WM_SETFONT

LRESULT WM_SETFONT(int wParam,
                 int lParam)

Overrides:

WM_SETFONT in class Composite

WM_SETREDRAW

LRESULT WM_SETREDRAW(int wParam,
                   int lParam)

Overrides:

WM_SETREDRAW in class Control

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Composite

WM_SYSCOLORCHANGE

LRESULT WM_SYSCOLORCHANGE(int wParam,
                        int lParam)

Overrides:

WM_SYSCOLORCHANGE in class Composite

WM_VSCROLL

LRESULT WM_VSCROLL(int wParam,
                 int lParam)

Overrides:

WM_VSCROLL in class Scrollable

WM_TIMER

LRESULT WM_TIMER(int wParam,
               int lParam)

Overrides:

WM_TIMER in class Control

wmColorChild

LRESULT wmColorChild(int wParam,
                   int lParam)

Overrides:

wmColorChild in class Control

wmNotify

LRESULT wmNotify(NMHDR hdr,
               int wParam,
               int lParam)

Overrides:

wmNotify in class Composite

wmNotifyChild

LRESULT wmNotifyChild(NMHDR hdr,
                    int wParam,
                    int lParam)

Overrides:

wmNotifyChild in class Control

wmNotifyHeader

LRESULT wmNotifyHeader(NMHDR hdr,
                     int wParam,
                     int lParam)

wmNotifyToolTip

LRESULT wmNotifyToolTip(NMHDR hdr,
                      int wParam,
                      int lParam)

wmNotifyToolTip

LRESULT wmNotifyToolTip(NMTTCUSTOMDRAW nmcd,
                      int lParam)