Top Description Fields Constructors Methods
org.eclipse.swt.custom

public Class TreeCursor

extends Canvas
Class Inheritance
Imports
org.eclipse.swt.*, org.eclipse.swt.accessibility.*, org.eclipse.swt.events.*, org.eclipse.swt.graphics.*, org.eclipse.swt.widgets.*
A TreeCursor provides a way for the user to navigate around a Tree with columns using the keyboard. It also provides a mechanism for selecting an individual cell in a tree.

For a detailed example of using a TreeCursor to navigate to a cell and then edit it see https://github.com/eclipse-platform/eclipse.platform.swt/tree/master/examples/org.eclipse.swt.snippets/src/org/eclipse/swt/snippets/Snippet360.java .

Styles:
BORDER
Events:
Selection, DefaultSelection
Since
3.8

Field Summary

Modifier and TypeField and Description
pack-priv Color
background

pack-priv static final int
BACKGROUND

Hides org.eclipse.swt.widgets.Widget.BACKGROUND.

pack-priv TreeColumn
column

pack-priv Listener
disposeColumnListener

pack-priv Listener
disposeItemListener

pack-priv Color
foreground

pack-priv static final int
FOREGROUND

Hides org.eclipse.swt.widgets.Widget.FOREGROUND.

pack-priv Listener
listener

pack-priv Listener
resizeListener

pack-priv TreeItem
row

pack-priv Tree
tree

pack-priv Listener
treeListener

Constructor Summary

AccessConstructor and Description
public
TreeCursor(Tree
a Tree control which will be the parent of the new instance (cannot be null)
parent, int
the style of control to construct
style)

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

Method Summary

Modifier and TypeMethod and Description
pack-priv void
_resize()

public void
addSelectionListener(SelectionListener
the listener which should be notified
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.

pack-priv int
countSubTreePages(TreeItem root)

pack-priv int
findIndex(TreeItem[] items, TreeItem treeItem)

pack-priv TreeItem
findItem(TreeItem[] items, Point pt)

public Color

Returns:

the receiver's background color
getBackground()

Overrides org.eclipse.swt.widgets.Control.getBackground.

Returns the background color that the receiver will use to draw.
public int

Returns:

the column index for the current position
getColumn()

Returns the index of the column over which the TreeCursor is positioned.

public Color

Returns:

the receiver's foreground color
getForeground()

Overrides org.eclipse.swt.widgets.Control.getForeground.

Returns the foreground color that the receiver will use to draw.
pack-priv TreeItem
getLastVisibleItem(TreeItem[] items)

pack-priv TreeItem
getNextItem(TreeItem item)

pack-priv TreeItem
getPreviousItem(TreeItem item)

public TreeItem

Returns:

the item for the current position, or null if none
getRow()

Returns the row over which the TreeCursor is positioned.

pack-priv void
keyDown(Event event)

pack-priv void
onDispose(Event event)

pack-priv void
paint(Event event)

public void
removeSelectionListener(SelectionListener
the listener which should no longer be notified
listener)

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

public void
setBackground(Color
the new color (or null)
color)

Overrides org.eclipse.swt.widgets.Control.setBackground.

Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.
public void
setForeground(Color
the new color (or null)
color)

Overrides org.eclipse.swt.widgets.Control.setForeground.

Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
pack-priv void
setRowColumn(int row, int column, boolean notify)

pack-priv void
setRowColumn(TreeItem row, TreeColumn column, boolean notify)

public void
setSelection(int
the index of the root-level row for the cell to select
row, int
the index of column for the cell to select
column)

Positions the TreeCursor over the root-level cell at the given row and column in the parent tree.

public void
setSelection(TreeItem
the TreeItem of the row for the cell to select
row, int
the index of column for the cell to select
column)

Positions the TreeCursor over the cell at the given row and column in the parent tree.

public void
setVisible(boolean
the new visibility state
visible)

Overrides org.eclipse.swt.widgets.Control.setVisible.

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
pack-priv void
treeCollapse(Event event)

pack-priv void
treeExpand(Event event)

pack-priv void
treeFocusIn(Event event)

pack-priv void
treeMouseDown(Event event)

pack-priv void
unhookRowColumnListeners()

Inherited from org.eclipse.swt.widgets.Canvas:
drawBackgroundgetCaretgetIMEscrollsetCaretsetFontsetIME

Field Detail

backgroundback to summary
pack-priv Color background
BACKGROUNDback to summary
pack-priv static final int BACKGROUND

Hides org.eclipse.swt.widgets.Widget.BACKGROUND.

columnback to summary
pack-priv TreeColumn column
disposeColumnListenerback to summary
pack-priv Listener disposeColumnListener
disposeItemListenerback to summary
pack-priv Listener disposeItemListener
foregroundback to summary
pack-priv Color foreground
FOREGROUNDback to summary
pack-priv static final int FOREGROUND

Hides org.eclipse.swt.widgets.Widget.FOREGROUND.

listenerback to summary
pack-priv Listener listener
resizeListenerback to summary
pack-priv Listener resizeListener
rowback to summary
pack-priv TreeItem row
treeback to summary
pack-priv Tree tree
treeListenerback to summary
pack-priv Listener treeListener

Constructor Detail

TreeCursorback to summary
public TreeCursor(Tree parent, int style)

Constructs a new instance of this class given its parent tree 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:Tree

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

style:int

the style of control to construct

Exceptions
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#BORDER, Widget#checkSubclass(), Widget#getStyle()

Method Detail

_resizeback to summary
pack-priv void _resize()
addSelectionListenerback to summary
public 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.

When widgetSelected is called, the item field of the event object is valid. If the receiver 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.

Parameters
listener:SelectionListener

the listener which should be notified

Exceptions
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, SelectionEvent, removeSelectionListener(SelectionListener)
countSubTreePagesback to summary
pack-priv int countSubTreePages(TreeItem root)
findIndexback to summary
pack-priv int findIndex(TreeItem[] items, TreeItem treeItem)
findItemback to summary
pack-priv TreeItem findItem(TreeItem[] items, Point pt)
getBackgroundback to summary
public Color getBackground()

Overrides org.eclipse.swt.widgets.Control.getBackground.

Returns the background color that the receiver will use to draw.

Returns:Color

the receiver's background color

Annotations
@Override
getColumnback to summary
public int getColumn()

Returns the index of the column over which the TreeCursor is positioned.

Returns:int

the column index for the current position

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
getForegroundback to summary
public Color getForeground()

Overrides org.eclipse.swt.widgets.Control.getForeground.

Returns the foreground color that the receiver will use to draw.

Returns:Color

the receiver's foreground color

Annotations
@Override
getLastVisibleItemback to summary
pack-priv TreeItem getLastVisibleItem(TreeItem[] items)
getNextItemback to summary
pack-priv TreeItem getNextItem(TreeItem item)
getPreviousItemback to summary
pack-priv TreeItem getPreviousItem(TreeItem item)
getRowback to summary
public TreeItem getRow()

Returns the row over which the TreeCursor is positioned.

Returns:TreeItem

the item for the current position, or null if none

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
keyDownback to summary
pack-priv void keyDown(Event event)
onDisposeback to summary
pack-priv void onDispose(Event event)
paintback to summary
pack-priv void paint(Event event)
removeSelectionListenerback to summary
public void removeSelectionListener(SelectionListener listener)

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

Parameters
listener:SelectionListener

the listener which should no longer be notified

Exceptions
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(SelectionListener)
setBackgroundback to summary
public void setBackground(Color color)

Overrides org.eclipse.swt.widgets.Control.setBackground.

Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.

Note

This operation is a hint and may be overridden by the platform. For example, on Windows the background of a Button cannot be changed.

Parameters
color:Color

the new color (or null)

Annotations
@Override
Exceptions
IllegalArgumentException:
  • ERROR_INVALID_ARGUMENT - if the argument 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
setForegroundback to summary
public void setForeground(Color color)

Overrides org.eclipse.swt.widgets.Control.setForeground.

Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.

Note

This operation is a hint and may be overridden by the platform.

Parameters
color:Color

the new color (or null)

Annotations
@Override
Exceptions
IllegalArgumentException:
  • ERROR_INVALID_ARGUMENT - if the argument 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
setRowColumnback to summary
pack-priv void setRowColumn(int row, int column, boolean notify)
setRowColumnback to summary
pack-priv void setRowColumn(TreeItem row, TreeColumn column, boolean notify)
setSelectionback to summary
public void setSelection(int row, int column)

Positions the TreeCursor over the root-level cell at the given row and column in the parent tree.

Parameters
row:int

the index of the root-level row for the cell to select

column:int

the index of column for the cell to select

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setSelectionback to summary
public void setSelection(TreeItem row, int column)

Positions the TreeCursor over the cell at the given row and column in the parent tree.

Parameters
row:TreeItem

the TreeItem of the row for the cell to select

column:int

the index of column for the cell to select

Exceptions
SWTException:
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
setVisibleback to summary
public void setVisible(boolean visible)

Overrides org.eclipse.swt.widgets.Control.setVisible.

Doc from org.eclipse.swt.widgets.Control.setVisible.

Marks the receiver 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
visible:boolean

the new visibility state

Annotations
@Override
treeCollapseback to summary
pack-priv void treeCollapse(Event event)
treeExpandback to summary
pack-priv void treeExpand(Event event)
treeFocusInback to summary
pack-priv void treeFocusIn(Event event)
treeMouseDownback to summary
pack-priv void treeMouseDown(Event event)
unhookRowColumnListenersback to summary
pack-priv void unhookRowColumnListeners()