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, NO_SEARCH
Events:
Selection, DefaultSelection, Collapse, Expand, SetData, MeasureItem, EraseItem, PaintItem, EmptinessChanged

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

IMPORTANT: This class is not intended to be subclassed.

See Also:

  • Field Details

    • modelHandle

      long modelHandle

    • checkRenderer

      long checkRenderer

    • columnCount

      int columnCount

    • sortDirection

      int sortDirection

    • selectionCountOnPress

      int selectionCountOnPress

    • selectionCountOnRelease

      int selectionCountOnRelease

    • ignoreCell

      long ignoreCell

    • items

      TreeItem[] items

    • nextId

      int nextId

    • columns

      TreeColumn[] columns

    • sortColumn

      TreeColumn sortColumn

    • currentItem

      TreeItem currentItem

    • imageList

      ImageList imageList

    • headerImageList

      ImageList headerImageList

    • firstCustomDraw

      boolean firstCustomDraw

    • firstCompute

      boolean firstCompute
      True iff computeSize has never been called on this Tree

    • modelChanged

      boolean modelChanged

    • expandAll

      boolean expandAll

    • drawState

      int drawState

    • drawFlags

      int drawFlags

    • background

      GdkRGBA background

    • foreground

      GdkRGBA foreground

    • drawForegroundRGBA

      GdkRGBA drawForegroundRGBA

    • isOwnerDrawn

      boolean isOwnerDrawn
      The owner of the widget is responsible for drawing

    • ignoreSize

      boolean ignoreSize

    • pixbufSizeSet

      boolean pixbufSizeSet

    • hasChildren

      boolean hasChildren

    • pixbufHeight

      int pixbufHeight

    • pixbufWidth

      int pixbufWidth

    • headerHeight

      int headerHeight

    • headerVisible

      boolean headerVisible

    • topItem

      TreeItem topItem

    • cachedAdjustment

      double cachedAdjustment

    • currentAdjustment

      double currentAdjustment

    • headerBackground

      Color headerBackground

    • headerForeground

      Color headerForeground

    • boundsChangedSinceLastDraw

      boolean boundsChangedSinceLastDraw

    • wasScrolled

      boolean wasScrolled

    • rowActivated

      boolean rowActivated

    • headerCSSProvider

      private long headerCSSProvider

    • ID_COLUMN

      static final int ID_COLUMN
      See Also:

    • CHECKED_COLUMN

      static final int CHECKED_COLUMN
      See Also:

    • GRAYED_COLUMN

      static final int GRAYED_COLUMN
      See Also:

    • FOREGROUND_COLUMN

      static final int FOREGROUND_COLUMN
      See Also:

    • BACKGROUND_COLUMN

      static final int BACKGROUND_COLUMN
      See Also:

    • FONT_COLUMN

      static final int FONT_COLUMN
      See Also:

    • FIRST_COLUMN

      static final int FIRST_COLUMN
      See Also:

    • CELL_PIXBUF

      static final int CELL_PIXBUF
      See Also:

    • CELL_TEXT

      static final int CELL_TEXT
      See Also:

    • CELL_FOREGROUND

      static final int CELL_FOREGROUND
      See Also:

    • CELL_BACKGROUND

      static final int CELL_BACKGROUND
      See Also:

    • CELL_FONT

      static final int CELL_FONT
      See Also:

    • CELL_SURFACE

      static final int CELL_SURFACE
      See Also:

    • CELL_TYPES

      static final int CELL_TYPES
      See Also:

  • Constructor Details

    • 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:
      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:

  • Method Details

    • _addListener

      void _addListener(int eventType, Listener listener)
      Overrides:
      _addListener in class Widget

    • _getItem

      TreeItem _getItem(long iter)

    • _getItem

      TreeItem _getItem(long parentIter, long iter, int index)

    • reallocateIds

      void reallocateIds(int newSize)

    • findAvailableId

      int findAvailableId()

    • getId

      int getId(long iter, boolean queryModel)

    • checkStyle

      static int checkStyle(int style)

    • cellDataProc

      long cellDataProc(long tree_column, long cell, long tree_model, long iter, long data)
      Overrides:
      cellDataProc in class Widget

    • checkData

      boolean checkData(TreeItem item)

    • 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

    • 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:
      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:

    • 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:
      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:

    • calculateWidth

      int calculateWidth(long column, long iter, boolean recurse)

    • 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:
      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:

    • clear

      void clear(long parentIter, int index, boolean all)

    • 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:

    • clearAll

      void clearAll(boolean all, long parentIter)

    • computeSizeInPixels

      Point computeSizeInPixels(int wHint, int hHint, boolean changed)
      Overrides:
      computeSizeInPixels in class Composite

    • copyModel

      void copyModel(long oldModel, int oldStart, long newModel, int newStart, long oldParent, long newParent, int modelLength)

    • createColumn

      void createColumn(TreeColumn column, int index)

    • createHandle

      void createHandle(int index)
      Overrides:
      createHandle in class Composite

    • bindArrowKeyBindings

      void bindArrowKeyBindings()
      Binds the left and right arrow keys to allow for expanding and collapsing of the tree nodes. Note: This function is to only be called in GTK4. Binding of the arrow keys are also done in GTK3, however it is done through GtkBindingSets in CSS. See Device.init() for more information, specifically, swt_functional_gtk_3_20.css

    • applyThemeBackground

      int applyThemeBackground()
      Overrides:
      applyThemeBackground in class Composite
      Returns:
    • 0 to remove THEME_BACKGROUND
    • 1 to apply THEME_BACKGROUND
    • otherwise don't change THEME_BACKGROUND state

    • createItem

      void createItem(TreeColumn column, int index)

    • createItem

      void createItem(TreeItem item, long parentIter, int index)
      The fastest way to insert many items is documented in TreeItem(org.eclipse.swt.widgets.Tree,int,int) and TreeItem.setItemCount(int)

    • createRenderers

      void createRenderers(long columnHandle, int modelIndex, boolean check, int columnStyle)

    • createWidget

      void createWidget(int index)
      Overrides:
      createWidget in class Scrollable

    • defaultBackground

      GdkRGBA defaultBackground()
      Overrides:
      defaultBackground in class Control

    • deregister

      void deregister()
      Overrides:
      deregister in class Composite

    • 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:
      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)

    • dragDetect

      boolean dragDetect(int x, int y, boolean filter, boolean dragOnTimeout, boolean[] consume)
      Overrides:
      dragDetect in class Control

    • eventWindow

      long eventWindow()
      Overrides:
      eventWindow in class Control

    • getClientAreaInPixels

      Rectangle getClientAreaInPixels()
      Overrides:
      getClientAreaInPixels in class Composite

    • getClientWidth

      int getClientWidth()
      Overrides:
      getClientWidth in class Control

    • 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:
      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:

    • 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:

    • getColumnTypes

      long[] getColumnTypes(int columnCount)

    • 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:

    • getContextBackgroundGdkRGBA

      GdkRGBA getContextBackgroundGdkRGBA()
      Overrides:
      getContextBackgroundGdkRGBA in class Control

    • getContextColorGdkRGBA

      GdkRGBA getContextColorGdkRGBA()
      Overrides:
      getContextColorGdkRGBA in class Control

    • getFocusItem

      TreeItem getFocusItem()

    • getGridLineWidth

      public int getGridLineWidth()
      Returns the width in points of a grid line.
      Returns:
      the width of a grid line in points
      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

    • getHeaderBackground

      public Color getHeaderBackground()
      Returns the header background color.
      Returns:
      the receiver's header background color.
      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.106

    • getHeaderForeground

      public Color getHeaderForeground()
      Returns the header foreground color.
      Returns:
      the receiver's header foreground color.
      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.106

    • 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

    • 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:
      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

      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:
      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

    • 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(long parent)

    • 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

    • 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

    • getPixbufRenderer

      long getPixbufRenderer(long column)

    • 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:

    • 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:

    • getTextRenderer

      long getTextRenderer(long column)

    • 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

    • _getCachedTopItem

      TreeItem _getCachedTopItem()

    • gtk_button_press_event

      long gtk_button_press_event(long widget, long event)
      Overrides:
      gtk_button_press_event in class Composite

    • gtk_gesture_press_event

      int gtk_gesture_press_event(long gesture, int n_press, double x, double y, long event)
      Description copied from class: Control
      Handling multi-press event on GTK4
      Overrides:
      gtk_gesture_press_event in class Control
      Parameters:
      gesture - the corresponding controller responsible for capturing the event
      n_press - how many touch/button presses happened with this one
      x - the x coordinate, in widget allocation coordinates
      y - the y coordinate, in widget allocation coordinates
      event - the GdkEvent captured

    • gtk_row_activated

      long gtk_row_activated(long tree, long path, long column)
      Overrides:
      gtk_row_activated in class Widget

    • gtk3_key_press_event

      long gtk3_key_press_event(long widget, long event)
      Overrides:
      gtk3_key_press_event in class Composite

    • sendTreeDefaultSelection

      void sendTreeDefaultSelection()
      Used to emulate DefaultSelection event. See Bug 312568. Feature in GTK. 'row-activation' event comes before DoubleClick event. This is causing the editor not to get focus after double-click. The solution is to manually send the DefaultSelection event after a double-click, and to emulate it for Space/Return.

    • gtk_button_release_event

      long gtk_button_release_event(long widget, long event)
      Overrides:
      gtk_button_release_event in class Control

    • gtk_changed

      long gtk_changed(long widget)
      Overrides:
      gtk_changed in class Widget

    • gtk_expand_collapse_cursor_row

      long gtk_expand_collapse_cursor_row(long widget, long logical, long expand, long open_all)
      Overrides:
      gtk_expand_collapse_cursor_row in class Widget

    • drawInheritedBackground

      void drawInheritedBackground(long cairo)

    • gtk_draw

      long gtk_draw(long widget, long cairo)
      Overrides:
      gtk_draw in class Composite

    • gtk_motion_notify_event

      long gtk_motion_notify_event(long widget, long event)
      Overrides:
      gtk_motion_notify_event in class Control

    • gtk_row_has_child_toggled

      long gtk_row_has_child_toggled(long model, long path, long iter)
      Overrides:
      gtk_row_has_child_toggled in class Widget

    • gtk_scroll_event

      long gtk_scroll_event(long widget, long eventPtr)
      Overrides:
      gtk_scroll_event in class Scrollable

    • gtk_start_interactive_search

      long gtk_start_interactive_search(long widget)
      Overrides:
      gtk_start_interactive_search in class Widget

    • gtk_test_collapse_row

      long gtk_test_collapse_row(long tree, long iter, long path)
      Overrides:
      gtk_test_collapse_row in class Widget

    • gtk_test_expand_row

      long gtk_test_expand_row(long tree, long iter, long path)
      Overrides:
      gtk_test_expand_row in class Widget

    • gtk_toggled

      long gtk_toggled(long renderer, long pathStr)
      Overrides:
      gtk_toggled in class Widget

    • gtk_widget_get_preferred_size

      void gtk_widget_get_preferred_size(long widget, GtkRequisition requisition)
      Overrides:
      gtk_widget_get_preferred_size in class Widget

    • hideFirstColumn

      void hideFirstColumn()

    • hookEvents

      void hookEvents()
      Overrides:
      hookEvents in class Composite

    • 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:
      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:
      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

    • mnemonicHit

      boolean mnemonicHit(char key)
      Overrides:
      mnemonicHit in class Control

    • mnemonicMatch

      boolean mnemonicMatch(char key)
      Overrides:
      mnemonicMatch in class Control

    • paintWindow

      long paintWindow()
      Overrides:
      paintWindow in class Control

    • propagateDraw

      void propagateDraw(long container, long cairo)
      Description copied from class: Composite

      Propagates draw events from a parent container to its children using gtk_container_propagate_draw(). This method only works if the fixedHandle has been connected to the "draw" signal, and only propagates draw events to other siblings of handle (i.e. other children of fixedHandle, but not handle itself).

      It's useful to propagate draw events to other child widgets for things like Table/Tree editors, or other scenarios where a widget is a child of a non-standard container widget (i.e., not a direct child of a Composite).

      Overrides:
      propagateDraw in class Composite
      Parameters:
      container - the parent container, i.e. fixedHandle
      cairo - the cairo context provided by GTK

    • recreateRenderers

      void recreateRenderers()

    • redrawBackgroundImage

      void redrawBackgroundImage()
      Overrides:
      redrawBackgroundImage in class Scrollable

    • register

      void register()
      Overrides:
      register in class Composite

    • releaseItem

      void releaseItem(TreeItem item, boolean release)

    • releaseItems

      void releaseItems(long parentIter)

    • releaseChildren

      void releaseChildren(boolean destroy)
      Overrides:
      releaseChildren in class Composite

    • releaseWidget

      void releaseWidget()
      Overrides:
      releaseWidget in class Composite

    • remove

      void remove(long parentIter, int start, int end)

    • 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:
      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:

    • 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:
      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:

    • sendMeasureEvent

      void sendMeasureEvent(long cell, long width, long height)

    • rendererGetPreferredWidthProc

      long rendererGetPreferredWidthProc(long cell, long handle, long minimun_size, long natural_size)
      Overrides:
      rendererGetPreferredWidthProc in class Widget

    • rendererSnapshotProc

      long rendererSnapshotProc(long cell, long snapshot, long widget, long background_area, long cell_area, long flags)
      Overrides:
      rendererSnapshotProc in class Widget

    • rendererRenderProc

      long rendererRenderProc(long cell, long cr, long widget, long background_area, long cell_area, long flags)
      Overrides:
      rendererRenderProc in class Widget

    • rendererRender

      void rendererRender(long cell, long cr, long snapshot, long widget, long background_area, long cell_area, long expose_area, long flags)

    • getGC

      private GC getGC(long cr)

    • resetCustomDraw

      void resetCustomDraw()

    • reskinChildren

      void reskinChildren(int flags)
      Overrides:
      reskinChildren in class Composite

    • searchEnabled

      boolean searchEnabled()

    • 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:
      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

      void setItemCount(long parentIter, int count)

    • setItemCount

      public void setItemCount(int count)
      Sets the number of root-level items contained in the receiver.

      The fastest way to insert many items is documented in TreeItem(Tree,int,int) and TreeItem.setItemCount(int)

      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

    • 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:
      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

    • setBackgroundGdkRGBA

      void setBackgroundGdkRGBA(long context, long handle, GdkRGBA rgba)
      Overrides:
      setBackgroundGdkRGBA in class Control

    • setBackgroundSurface

      void setBackgroundSurface(Image image)
      Overrides:
      setBackgroundSurface in class Control

    • setBounds

      int setBounds(int x, int y, int width, int height, boolean move, boolean resize)
      Overrides:
      setBounds in class Composite

    • 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
      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:

    • setFontDescription

      void setFontDescription(long font)
      Overrides:
      setFontDescription in class Control

    • setForegroundGdkRGBA

      void setForegroundGdkRGBA(GdkRGBA rgba)
      Overrides:
      setForegroundGdkRGBA in class Control

    • setHeaderBackground

      public void setHeaderBackground(Color color)
      Sets the header background color to the color specified by the argument, or to the default system color if the argument is null.

      Note: This operation is a HINT and is not supported on all platforms. If the native header has a 3D look and feel (e.g. Windows 7), this method will cause the header to look FLAT irrespective of the state of the tree style.

      Parameters:
      color - the new color (or null)
      Throws:
      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
      Since:
      3.106

    • updateHeaderCSS

      void updateHeaderCSS()

    • setHeaderForeground

      public void setHeaderForeground(Color color)
      Sets the header foreground color to the color specified by the argument, or to the default system color if the argument is null.

      Note: This operation is a HINT and is not supported on all platforms. If the native header has a 3D look and feel (e.g. Windows 7), this method will cause the header to look FLAT irrespective of the state of the tree style.

      Parameters:
      color - the new color (or null)
      Throws:
      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
      Since:
      3.106

    • 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

    • 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

    • setModel

      void setModel(long newModel)

    • setOrientation

      void setOrientation(boolean create)
      Overrides:
      setOrientation in class Composite

    • setParentBackground

      void setParentBackground()
      Overrides:
      setParentBackground in class Control

    • setParentGdkResource

      void setParentGdkResource(Control child)
      Overrides:
      setParentGdkResource in class Control

    • setScrollWidth

      void setScrollWidth(long column, TreeItem item)

    • 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, and if necessary the receiver is scrolled to make the new selection visible.

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

      Parameters:
      item - the item to select
      Throws:
      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, and if necessary the receiver is scrolled to make the new selection visible.

      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:
      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:

    • 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:
      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:
      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:

    • 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:
      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

    • showFirstColumn

      boolean showFirstColumn()

    • 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

      void showItem(long path, boolean scroll)

    • 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:
      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:

    • updateScrollBarValue

      void updateScrollBarValue(ScrollBar bar)
      Overrides:
      updateScrollBarValue in class Scrollable

    • windowProc

      long windowProc(long handle, long arg0, long user_data)
      Overrides:
      windowProc in class Control

    • resizeCalculationsGTK3

      Point resizeCalculationsGTK3(long widget, int width, int height)
      Overrides:
      resizeCalculationsGTK3 in class Control

    • checkSetDataInProcessBeforeRemoval

      void checkSetDataInProcessBeforeRemoval()
      Check the tree for items that are in process of sending SWT#SetData event. If such items exist, throw an exception. Does nothing if the given range contains no indices, or if we are below GTK 3.22.0 or are using GTK 4.

    • throwCannotRemoveItem

      private void throwCannotRemoveItem(int i)

    • dispose

      public void dispose()
      Description copied from class: Widget
      Disposes of the operating system resources associated with the receiver and all its descendants. After this method has been invoked, the receiver and all descendants will answer true when sent the message isDisposed(). Any internal connections between the widgets in the tree will have been removed to facilitate garbage collection. This method does nothing if the widget is already disposed.

      NOTE: This method is not called recursively on the descendants of the receiver. This means that, widget implementers can not detect when a widget is being disposed of by re-implementing this method, but should instead listen for the Dispose event.

      Overrides:
      dispose in class Widget
      See Also: