blob: 4e2700c1d664ae9b336a514aef9694e85d962119 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2019 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.gtk.*;
/**
* Instances of this class represent a selectable user interface object
* that represents a hierarchy of tree items in a tree widget.
*
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>(none)</dd>
* <dt><b>Events:</b></dt>
* <dd>(none)</dd>
* </dl>
* <p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
* </p>
*
* @see <a href="http://www.eclipse.org/swt/snippets/#tree">Tree, TreeItem, TreeColumn snippets</a>
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
* @noextend This class is not intended to be subclassed by clients.
*/
public class TreeItem extends Item {
Tree parent;
Font font;
Font[] cellFont;
String [] strings;
boolean cached, grayed, isExpanded, updated, settingData;
static final int EXPANDER_EXTRA_PADDING = 4;
/**
* Constructs <code>TreeItem</code> and <em>inserts</em> it into <code>Tree</code>.
* Item is inserted as last direct child of the tree.
* <p>
* For bulk insert scenarios, see TreeItem#TreeItem(Tree,int,int)
*
* @param parent a tree control which will be the parent of the new instance (cannot be null)
* @param style no styles are currently supported, pass SWT.NONE
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public TreeItem (Tree parent, int style) {
this (checkNull (parent), 0, style, -1, true);
}
/**
* Constructs <code>TreeItem</code> and <em>inserts</em> it into <code>Tree</code>.
* Item is inserted as <code>index</code> direct child of the tree.
* <p>
* The fastest way to insert many items is:
* <ol>
* <li>Use {@link Tree#setRedraw} to disable drawing during bulk insert</li>
* <li>Insert every item at index 0 (insert them in reverse to get the same result)</li>
* </ol>
*
* @param parent a tree control which will be the parent of the new instance (cannot be null)
* @param style no styles are currently supported, pass SWT.NONE
* @param index the zero-relative index to store the receiver in its parent
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
* @see Tree#setRedraw
*/
public TreeItem (Tree parent, int style, int index) {
this (checkNull (parent), 0, style, checkIndex (index), true);
}
/**
* Constructs <code>TreeItem</code> and <em>inserts</em> it into <code>Tree</code>.
* Item is inserted as last direct child of the specified <code>TreeItem</code>.
* <p>
* For bulk insert scenarios, see TreeItem#TreeItem(TreeItem,int,int)
*
* @param parentItem a tree control which will be the parent of the new instance (cannot be null)
* @param style no styles are currently supported, pass SWT.NONE
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public TreeItem (TreeItem parentItem, int style) {
this (checkNull (parentItem).parent, parentItem.handle, style, -1, true);
}
/**
* Constructs <code>TreeItem</code> and <em>inserts</em> it into <code>Tree</code>.
* Item is inserted as <code>index</code> direct child of the specified <code>TreeItem</code>.
* <p>
* The fastest way to insert many items is:
* <ol>
* <li>Use {@link Tree#setRedraw} to disable drawing during bulk insert</li>
* <li>Insert child items while parent item is collapsed</li>
* <li>Insert every item at index 0 (insert them in reverse to get the same result)</li>
* </ol>
*
* @param parentItem a tree control which will be the parent of the new instance (cannot be null)
* @param style no styles are currently supported, pass SWT.NONE
* @param index the zero-relative index to store the receiver in its parent
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
* @see Tree#setRedraw
*/
public TreeItem (TreeItem parentItem, int style, int index) {
this (checkNull (parentItem).parent, parentItem.handle, style, checkIndex (index), true);
}
TreeItem (Tree parent, long parentIter, int style, int index, boolean create) {
super (parent, style);
this.parent = parent;
if (create) {
parent.createItem (this, parentIter, index);
} else {
handle = OS.g_malloc (GTK.GtkTreeIter_sizeof ());
GTK.gtk_tree_model_iter_nth_child (parent.modelHandle, handle, parentIter, index);
}
}
static int checkIndex (int index) {
if (index < 0) SWT.error (SWT.ERROR_INVALID_RANGE);
return index;
}
static TreeItem checkNull (TreeItem item) {
if (item == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
return item;
}
static Tree checkNull (Tree control) {
if (control == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
return control;
}
@Override
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
Color _getBackground () {
long [] ptr = new long [1];
GTK.gtk_tree_model_get (parent.modelHandle, handle, Tree.BACKGROUND_COLUMN, ptr, -1);
if (ptr [0] == 0) return parent.getBackground ();
GdkRGBA gdkRGBA = new GdkRGBA ();
OS.memmove(gdkRGBA, ptr [0], GdkRGBA.sizeof);
GDK.gdk_rgba_free (ptr [0]);
return Color.gtk_new(display, gdkRGBA);
}
Color _getBackground (int index) {
int count = Math.max (1, parent.columnCount);
if (0 > index || index > count - 1) return _getBackground ();
long [] ptr = new long [1];
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Tree.CELL_BACKGROUND, ptr, -1);
if (ptr [0] == 0) return _getBackground ();
GdkRGBA gdkRGBA = new GdkRGBA ();
OS.memmove(gdkRGBA, ptr [0], GdkRGBA.sizeof);
GDK.gdk_rgba_free (ptr [0]);
return Color.gtk_new(display, gdkRGBA);
}
boolean _getChecked () {
int [] ptr = new int [1];
GTK.gtk_tree_model_get (parent.modelHandle, handle, Tree.CHECKED_COLUMN, ptr, -1);
return ptr [0] != 0;
}
Color _getForeground () {
long [] ptr = new long [1];
GTK.gtk_tree_model_get (parent.modelHandle, handle, Tree.FOREGROUND_COLUMN, ptr, -1);
if (ptr [0] == 0) return parent.getForeground ();
GdkRGBA gdkRGBA = new GdkRGBA ();
OS.memmove(gdkRGBA, ptr [0], GdkRGBA.sizeof);
GDK.gdk_rgba_free (ptr [0]);
return Color.gtk_new(display, gdkRGBA);
}
Color _getForeground (int index) {
int count = Math.max (1, parent.columnCount);
if (0 > index || index > count - 1) return _getForeground ();
long [] ptr = new long [1];
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Tree.CELL_FOREGROUND, ptr, -1);
if (ptr [0] == 0) return _getForeground ();
GdkRGBA gdkRGBA = new GdkRGBA ();
OS.memmove(gdkRGBA, ptr [0], GdkRGBA.sizeof);
GDK.gdk_rgba_free (ptr [0]);
return Color.gtk_new(display, gdkRGBA);
}
Image _getImage(int index) {
int count = Math.max(1, parent.getColumnCount());
if (0 > index || index > count - 1) return null;
long[] surfaceHandle = new long[1];
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns[index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Tree.CELL_SURFACE, surfaceHandle, -1);
if (surfaceHandle[0] == 0) return null;
int imageIndex = parent.imageList.indexOf(surfaceHandle[0]);
if (imageIndex == -1) {
return null;
} else {
return parent.imageList.get(imageIndex);
}
}
String _getText (int index) {
int count = Math.max (1, parent.getColumnCount ());
if (0 > index || index > count - 1) return "";
long [] ptr = new long [1];
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Tree.CELL_TEXT, ptr, -1);
if (ptr [0] == 0) return ""; //$NON-NLS-1$
int length = C.strlen (ptr [0]);
byte[] buffer = new byte [length];
C.memmove (buffer, ptr [0], length);
OS.g_free (ptr [0]);
return new String (Converter.mbcsToWcs (buffer));
}
void clear () {
if (parent.currentItem == this) return;
if (cached || (parent.style & SWT.VIRTUAL) == 0) {
int columnCount = GTK.gtk_tree_model_get_n_columns (parent.modelHandle);
/* the columns before FOREGROUND_COLUMN contain int values, subsequent columns contain pointers */
for (int i=Tree.CHECKED_COLUMN; i<Tree.FOREGROUND_COLUMN; i++) {
GTK.gtk_tree_store_set (parent.modelHandle, handle, i, 0, -1);
}
for (int i=Tree.FOREGROUND_COLUMN; i<columnCount; i++) {
GTK.gtk_tree_store_set (parent.modelHandle, handle, i, (long )0, -1);
}
}
cached = false;
font = null;
strings = null;
cellFont = null;
}
/**
* 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 <code>SWT.VIRTUAL</code> style,
* these attributes are requested again as needed.
*
* @param index the index of the item to clear
* @param all <code>true</code> if all child items of the indexed item should be
* cleared recursively, and <code>false</code> otherwise
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see SWT#VIRTUAL
* @see SWT#SetData
*
* @since 3.2
*/
public void clear (int index, boolean all) {
checkWidget ();
parent.clear (handle, index, 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 <code>SWT.VIRTUAL</code> style, these
* attributes are requested again as needed.
*
* @param all <code>true</code> if all child items should be cleared
* recursively, and <code>false</code> otherwise
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see SWT#VIRTUAL
* @see SWT#SetData
*
* @since 3.2
*/
public void clearAll (boolean all) {
checkWidget ();
parent.clearAll (all, handle);
}
@Override
void destroyWidget () {
parent.releaseItem (this, false);
parent.destroyItem (this);
releaseHandle ();
}
/**
* Returns the receiver's background color.
*
* @return the background color
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 2.0
*
*/
public Color getBackground () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getBackground ();
}
/**
* Returns the background color at the given column index in the receiver.
*
* @param index the column index
* @return the background color
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public Color getBackground (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getBackground (index);
}
/**
* Returns a rectangle describing the receiver's size and location
* relative to its parent at a column in the tree.
*
* @param index the index that specifies the column
* @return the receiver's bounding column rectangle
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public Rectangle getBounds (int index) {
checkWidget ();
return DPIUtil.autoScaleDown (getBoundsInPixels (index));
}
Rectangle getBoundsInPixels (int index) {
// TODO fully test on early and later versions of GTK
checkWidget();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
long parentHandle = parent.handle;
long column = 0;
if (index >= 0 && index < parent.columnCount) {
column = parent.columns [index].handle;
} else {
column = GTK.gtk_tree_view_get_column (parentHandle, index);
}
if (column == 0) return new Rectangle (0, 0, 0, 0);
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
GTK.gtk_widget_realize (parentHandle);
GdkRectangle rect = new GdkRectangle ();
GTK.gtk_tree_view_get_cell_area (parentHandle, path, column, rect);
if ((parent.getStyle () & SWT.MIRRORED) != 0) rect.x = parent.getClientWidth () - rect.width - rect.x;
GTK.gtk_tree_path_free (path);
if (index == 0 && (parent.style & SWT.CHECK) != 0) {
int [] x = new int [1], w = new int [1];
gtk_tree_view_column_cell_get_position (column, parent.checkRenderer, x, w);
rect.x += x [0] + w [0];
rect.width -= x [0] + w [0];
}
int width = GTK.gtk_tree_view_column_get_visible (column) ? rect.width + 1 : 0;
Rectangle r = new Rectangle (rect.x, rect.y, width, rect.height + 1);
return r;
}
/**
* Returns a rectangle describing the size and location of the receiver's
* text relative to its parent.
*
* @return the bounding rectangle of the receiver's text
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Rectangle getBounds () {
checkWidget ();
return DPIUtil.autoScaleDown (getBoundsInPixels ());
}
Rectangle getBoundsInPixels () {
// TODO fully test on early and later versions of GTK
// shifted a bit too far right on later versions of GTK - however, old Tree also had this problem
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
long parentHandle = parent.handle;
long column = GTK.gtk_tree_view_get_column (parentHandle, 0);
if (column == 0) return new Rectangle (0, 0, 0, 0);
long textRenderer = parent.getTextRenderer (column);
long pixbufRenderer = parent.getPixbufRenderer (column);
if (textRenderer == 0 || pixbufRenderer == 0) return new Rectangle (0, 0, 0, 0);
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
GTK.gtk_widget_realize (parentHandle);
boolean isExpander = GTK.gtk_tree_model_iter_n_children (parent.modelHandle, handle) > 0;
boolean isExpanded = GTK.gtk_tree_view_row_expanded (parentHandle, path);
GTK.gtk_tree_view_column_cell_set_cell_data (column, parent.modelHandle, handle, isExpander, isExpanded);
GdkRectangle rect = new GdkRectangle ();
GTK.gtk_tree_view_get_cell_area (parentHandle, path, column, rect);
if ((parent.getStyle () & SWT.MIRRORED) != 0) rect.x = parent.getClientWidth () - rect.width - rect.x;
int right = rect.x + rect.width;
int [] x = new int [1], w = new int [1];
parent.ignoreSize = true;
gtk_cell_renderer_get_preferred_size (textRenderer, parentHandle, w, null);
parent.ignoreSize = false;
rect.width = w [0];
int [] buffer = new int [1];
GTK.gtk_tree_path_free (path);
int horizontalSeparator;
if (GTK.GTK4) {
long separator = GTK.gtk_separator_new(GTK.GTK_ORIENTATION_HORIZONTAL);
GtkAllocation allocation = new GtkAllocation ();
GTK.gtk_widget_get_allocation(separator, allocation);
horizontalSeparator = allocation.height;
} else {
GTK.gtk_widget_style_get (parentHandle, OS.horizontal_separator, buffer, 0);
horizontalSeparator = buffer[0];
}
rect.x += horizontalSeparator;
gtk_tree_view_column_cell_get_position (column, textRenderer, x, null);
rect.x += x [0];
if (parent.columnCount > 0) {
if (rect.x + rect.width > right) {
rect.width = Math.max (0, right - rect.x);
}
}
int width = GTK.gtk_tree_view_column_get_visible (column) ? rect.width + 1 : 0;
Rectangle r = new Rectangle (rect.x, rect.y, width, rect.height + 1);
return r;
}
/**
* Returns <code>true</code> if the receiver is checked,
* and false otherwise. When the parent does not have
* the <code>CHECK</code> style, return false.
*
* @return the checked state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public boolean getChecked () {
checkWidget();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
if ((parent.style & SWT.CHECK) == 0) return false;
return _getChecked ();
}
/**
* Returns <code>true</code> if the receiver is expanded,
* and false otherwise.
* <p>
*
* @return the expanded state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public boolean getExpanded () {
checkWidget();
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
boolean answer = GTK.gtk_tree_view_row_expanded (parent.handle, path);
GTK.gtk_tree_path_free (path);
return answer;
}
/**
* Returns the font that the receiver will use to paint textual information for this item.
*
* @return the receiver's font
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.0
*/
public Font getFont () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return font != null ? font : parent.getFont ();
}
/**
* Returns the font that the receiver will use to paint textual information
* for the specified cell in this item.
*
* @param index the column index
* @return the receiver's font
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public Font getFont (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
int count = Math.max (1, parent.columnCount);
if (0 > index || index > count - 1) return getFont ();
if (cellFont == null || cellFont [index] == null) return getFont ();
return cellFont [index];
}
/**
* Returns the foreground color that the receiver will use to draw.
*
* @return the receiver's foreground color
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 2.0
*
*/
public Color getForeground () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getForeground ();
}
/**
*
* Returns the foreground color at the given column index in the receiver.
*
* @param index the column index
* @return the foreground color
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public Color getForeground (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getForeground (index);
}
/**
* Returns <code>true</code> if the receiver is grayed,
* and false otherwise. When the parent does not have
* the <code>CHECK</code> style, return false.
*
* @return the grayed state of the checkbox
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public boolean getGrayed () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
if ((parent.style & SWT.CHECK) == 0) return false;
return grayed;
}
@Override
public Image getImage () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return getImage (0);
}
/**
* Returns the image stored at the given column index in the receiver,
* or null if the image has not been set or if the column does not exist.
*
* @param index the column index
* @return the image stored at the given column index in the receiver
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public Image getImage (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getImage (index);
}
/**
* Returns a rectangle describing the size and location
* relative to its parent of an image at a column in the
* tree.
*
* @param index the index that specifies the column
* @return the receiver's bounding image rectangle
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public Rectangle getImageBounds (int index) {
checkWidget ();
return DPIUtil.autoScaleDown(getImageBoundsInPixels(index));
}
Rectangle getImageBoundsInPixels (int index) {
// TODO fully test on early and later versions of GTK
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
long parentHandle = parent.handle;
long column = 0;
if (index >= 0 && index < parent.getColumnCount ()) {
column = parent.columns [index].handle;
} else {
column = GTK.gtk_tree_view_get_column (parentHandle, index);
}
if (column == 0) return new Rectangle (0, 0, 0, 0);
long pixbufRenderer = parent.getPixbufRenderer (column);
if (pixbufRenderer == 0) return new Rectangle (0, 0, 0, 0);
GdkRectangle rect = new GdkRectangle ();
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
GTK.gtk_widget_realize (parentHandle);
GTK.gtk_tree_view_get_cell_area (parentHandle, path, column, rect);
if ((parent.getStyle () & SWT.MIRRORED) != 0) rect.x = parent.getClientWidth () - rect.width - rect.x;
GTK.gtk_tree_path_free (path);
/*
* Feature in GTK. When a pixbufRenderer has size of 0x0, gtk_tree_view_column_cell_get_position
* returns a position of 0 as well. This causes offset issues meaning that images/widgets/etc.
* can be placed over the text. We need to account for the base case of a pixbufRenderer that has
* yet to be sized, as per Bug 469277 & 476419. NOTE: this change has been ported to Tables since Tables/Trees both
* use the same underlying GTK structure.
*/
int [] x = new int [1], w = new int [1];
gtk_tree_view_column_cell_get_position (column, pixbufRenderer, x, w);
if (parent.pixbufSizeSet) {
if (x [0] > 0) {
rect.x += x [0];
}
} else {
/*
* If the size of the pixbufRenderer hasn't been set, we need to take into account the
* position of the textRenderer, to ensure images/widgets/etc. aren't placed over the TreeItem's
* text.
*/
long textRenderer = parent.getTextRenderer (column);
if (textRenderer == 0) return new Rectangle (0, 0, 0, 0);
int [] xText = new int [1], wText = new int [1];
gtk_tree_view_column_cell_get_position (column, textRenderer, xText, wText);
rect.x += xText [0];
}
rect.width = w [0];
int width = GTK.gtk_tree_view_column_get_visible (column) ? rect.width : 0;
Rectangle r = new Rectangle (rect.x, rect.y, width, rect.height + 1);
/*
* On GTK4 the header is included in the entire widget's surface, so we must subtract
* its size from the y-coordinate. This does not apply on GTK3 as the header and
* "main-widget" have separate GdkWindows.
*/
if (parent!= null && parent.getHeaderVisible () && GTK.GTK4) {
r.y += parent.getHeaderHeight();
}
return r;
}
/**
* Returns the number of items contained in the receiver
* that are direct item children of the receiver.
*
* @return the number of items
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public int getItemCount () {
checkWidget();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return GTK.gtk_tree_model_iter_n_children (parent.modelHandle, handle);
}
/**
* Returns the item at the given, zero-relative index in the
* receiver. Throws an exception if the index is out of range.
*
* @param index the index of the item to return
* @return the item at the given index
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public TreeItem getItem (int index) {
checkWidget();
if (index < 0) error (SWT.ERROR_INVALID_RANGE);
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
int itemCount = GTK.gtk_tree_model_iter_n_children (parent.modelHandle, handle);
if (index >= itemCount) error (SWT.ERROR_INVALID_RANGE);
return parent._getItem (handle, index);
}
/**
* Returns a (possibly empty) array of <code>TreeItem</code>s which
* are the direct item children of the receiver.
* <p>
* 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.
* </p>
*
* @return the receiver's items
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public TreeItem [] getItems () {
checkWidget();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return parent.getItems (handle);
}
@Override
String getNameText () {
if ((parent.style & SWT.VIRTUAL) != 0) {
if (!cached) return "*virtual*"; //$NON-NLS-1$
}
return super.getNameText ();
}
/**
* Returns the receiver's parent, which must be a <code>Tree</code>.
*
* @return the receiver's parent
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Tree getParent () {
checkWidget ();
return parent;
}
/**
* Returns the receiver's parent item, which must be a
* <code>TreeItem</code> or null when the receiver is a
* root.
*
* @return the receiver's parent item
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public TreeItem getParentItem () {
checkWidget();
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
TreeItem item = null;
int depth = GTK.gtk_tree_path_get_depth (path);
if (depth > 1) {
GTK.gtk_tree_path_up (path);
long iter = OS.g_malloc (GTK.GtkTreeIter_sizeof ());
if (GTK.gtk_tree_model_get_iter (parent.modelHandle, iter, path)) {
item = parent._getItem (iter);
}
OS.g_free (iter);
}
GTK.gtk_tree_path_free (path);
return item;
}
@Override
public String getText () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return getText (0);
}
/**
* Returns the text stored at the given column index in the receiver,
* or empty string if the text has not been set.
*
* @param index the column index
* @return the text stored at the given column index in the receiver
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public String getText (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
if (strings != null) {
if (0 <= index && index < strings.length) {
String string = strings [index];
return string != null ? string : "";
}
}
return _getText (index);
}
/**
* Returns a rectangle describing the size and location
* relative to its parent of the text at a column in the
* tree.
*
* @param index the index that specifies the column
* @return the receiver's bounding text rectangle
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.3
*/
public Rectangle getTextBounds (int index) {
checkWidget ();
return DPIUtil.autoScaleDown(getTextBoundsInPixels(index));
}
Rectangle getTextBoundsInPixels (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
int count = Math.max (1, parent.getColumnCount ());
if (0 > index || index > count - 1) return new Rectangle (0, 0, 0, 0);
// TODO fully test on early and later versions of GTK
// shifted a bit too far right on later versions of GTK - however, old Tree also had this problem
long parentHandle = parent.handle;
long column = 0;
if (index >= 0 && index < parent.columnCount) {
column = parent.columns [index].handle;
} else {
column = GTK.gtk_tree_view_get_column (parentHandle, index);
}
if (column == 0) return new Rectangle (0, 0, 0, 0);
long textRenderer = parent.getTextRenderer (column);
long pixbufRenderer = parent.getPixbufRenderer (column);
if (textRenderer == 0 || pixbufRenderer == 0) return new Rectangle (0, 0, 0, 0);
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
GTK.gtk_widget_realize (parentHandle);
boolean isExpander = GTK.gtk_tree_model_iter_n_children (parent.modelHandle, handle) > 0;
boolean isExpanded = GTK.gtk_tree_view_row_expanded (parentHandle, path);
GTK.gtk_tree_view_column_cell_set_cell_data (column, parent.modelHandle, handle, isExpander, isExpanded);
GdkRectangle rect = new GdkRectangle ();
GTK.gtk_tree_view_get_cell_area (parentHandle, path, column, rect);
if ((parent.getStyle () & SWT.MIRRORED) != 0) rect.x = parent.getClientWidth () - rect.width - rect.x;
int right = rect.x + rect.width;
int [] x = new int [1], w = new int [1];
parent.ignoreSize = true;
gtk_cell_renderer_get_preferred_size (textRenderer, parentHandle, w, null);
parent.ignoreSize = false;
int [] buffer = new int [1];
GTK.gtk_tree_path_free (path);
int horizontalSeparator;
if (GTK.GTK4) {
long separator = GTK.gtk_separator_new(GTK.GTK_ORIENTATION_HORIZONTAL);
GtkAllocation allocation = new GtkAllocation ();
GTK.gtk_widget_get_allocation(separator, allocation);
horizontalSeparator = allocation.height;
} else {
GTK.gtk_widget_style_get (parentHandle, OS.horizontal_separator, buffer, 0);
horizontalSeparator = buffer[0];
}
rect.x += horizontalSeparator;
gtk_tree_view_column_cell_get_position (column, textRenderer, x, null);
/*
* Fix for Eclipse bug 476562, we need to re-adjust the bounds for the text
* when the separator value is less than the width of the image. Previously
* images larger than 16px in width would be cut off on the right side.
* NOTE: this change has been ported to Tables since Tables/Trees both use the
* same underlying GTK structure.
*/
Image image = _getImage(index);
int imageWidth = 0;
if (image != null) {
if (DPIUtil.useCairoAutoScale()) {
imageWidth = image.getBounds ().width;
} else {
imageWidth = image.getBoundsInPixels ().width;
}
}
if (x [0] < imageWidth) {
rect.x += imageWidth;
} else {
rect.x += x [0];
}
if (parent.columnCount > 0) {
if (rect.x + rect.width > right) {
rect.width = Math.max (0, right - rect.x);
}
}
int width = GTK.gtk_tree_view_column_get_visible (column) ? rect.width + 1 : 0;
return new Rectangle (rect.x, rect.y, width, rect.height + 1);
}
/**
* 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.
*
* @param item the search item
* @return the index of the item
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the item is null</li>
* <li>ERROR_INVALID_ARGUMENT - if the item has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public int indexOf (TreeItem item) {
checkWidget();
if (item == null) error (SWT.ERROR_NULL_ARGUMENT);
if (item.isDisposed()) error (SWT.ERROR_INVALID_ARGUMENT);
int index = -1;
boolean isParent = false;
long currentPath = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
long parentPath = GTK.gtk_tree_model_get_path (parent.modelHandle, item.handle);
int depth = GTK.gtk_tree_path_get_depth (parentPath);
if (depth > 1 && GTK.gtk_tree_path_up(parentPath)) {
if (GTK.gtk_tree_path_compare(currentPath, parentPath) == 0) isParent = true;
}
GTK.gtk_tree_path_free (currentPath);
GTK.gtk_tree_path_free (parentPath);
if (!isParent) return index;
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, item.handle);
if (depth > 1) {
long indices = GTK.gtk_tree_path_get_indices (path);
if (indices != 0) {
int[] temp = new int[depth];
C.memmove (temp, indices, 4 * temp.length);
index = temp[temp.length - 1];
}
}
GTK.gtk_tree_path_free (path);
return index;
}
@Override
void releaseChildren (boolean destroy) {
if (destroy) {
parent.releaseItems (handle);
}
super.releaseChildren (destroy);
}
@Override
void releaseHandle () {
if (handle != 0) OS.g_free (handle);
handle = 0;
super.releaseHandle ();
parent = null;
}
@Override
void releaseWidget () {
super.releaseWidget ();
font = null;
cellFont = null;
strings = null;
}
@Override
public void dispose () {
// Workaround to Bug489751, avoid selecting next node when selected node is disposed.
Tree tmpParent = null;
if (parent != null && parent.getItemCount() > 0 && parent.getSelectionCount() == 0) {
tmpParent = parent;
}
super.dispose();
if (tmpParent != null && !tmpParent.isDisposed()) tmpParent.deselectAll();
}
/**
* Removes all of the items from the receiver.
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public void removeAll () {
checkWidget ();
long modelHandle = parent.modelHandle;
int length = GTK.gtk_tree_model_iter_n_children (modelHandle, handle);
if (length == 0) return;
long iter = OS.g_malloc (GTK.GtkTreeIter_sizeof ());
if (iter == 0) error (SWT.ERROR_NO_HANDLES);
if (parent.fixAccessibility ()) {
parent.ignoreAccessibility = true;
}
long selection = GTK.gtk_tree_view_get_selection (parent.handle);
int [] value = new int [1];
while (GTK.gtk_tree_model_iter_children (modelHandle, iter, handle)) {
GTK.gtk_tree_model_get (modelHandle, iter, Tree.ID_COLUMN, value, -1);
TreeItem item = value [0] != -1 ? parent.items [value [0]] : null;
if (item != null && !item.isDisposed ()) {
item.dispose ();
} else {
OS.g_signal_handlers_block_matched (selection, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, CHANGED);
GTK.gtk_tree_store_remove (modelHandle, iter);
OS.g_signal_handlers_unblock_matched (selection, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, CHANGED);
}
}
if (parent.fixAccessibility ()) {
parent.ignoreAccessibility = false;
OS.g_object_notify (parent.handle, OS.model);
}
OS.g_free (iter);
}
/**
* Sets the receiver's background color to the color specified
* by the argument, or to the default system color for the item
* if the argument is null.
*
* @param color the new color (or null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 2.0
*
*/
public void setBackground (Color color) {
checkWidget ();
if (color != null && color.isDisposed ()) {
error (SWT.ERROR_INVALID_ARGUMENT);
}
if (_getBackground ().equals (color)) return;
GdkRGBA gdkRGBA = color != null ? color.handle : null;
GTK.gtk_tree_store_set (parent.modelHandle, handle, Tree.BACKGROUND_COLUMN, gdkRGBA, -1);
cached = true;
}
/**
* Sets the background color at the given column index in the receiver
* to the color specified by the argument, or to the default system color for the item
* if the argument is null.
*
* @param index the column index
* @param color the new color (or null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*
*/
public void setBackground (int index, Color color) {
checkWidget ();
if (color != null && color.isDisposed ()) {
error (SWT.ERROR_INVALID_ARGUMENT);
}
if (_getBackground (index).equals (color)) return;
int count = Math.max (1, parent.getColumnCount ());
if (0 > index || index > count - 1) return;
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
GdkRGBA gdkRGBA = color != null ? color.handle : null;
GTK.gtk_tree_store_set (parent.modelHandle, handle, modelIndex + Tree.CELL_BACKGROUND, gdkRGBA, -1);
cached = true;
updated = true;
if (color != null) {
boolean customDraw = (parent.columnCount == 0) ? parent.firstCustomDraw : parent.columns [index].customDraw;
if (!customDraw) {
if ((parent.style & SWT.VIRTUAL) == 0) {
long parentHandle = parent.handle;
long column = 0;
if (parent.columnCount > 0) {
column = parent.columns [index].handle;
} else {
column = GTK.gtk_tree_view_get_column (parentHandle, index);
}
if (column == 0) return;
long textRenderer = parent.getTextRenderer (column);
long imageRenderer = parent.getPixbufRenderer (column);
GTK.gtk_tree_view_column_set_cell_data_func (column, textRenderer, display.cellDataProc, parentHandle, 0);
GTK.gtk_tree_view_column_set_cell_data_func (column, imageRenderer, display.cellDataProc, parentHandle, 0);
}
if (parent.columnCount == 0) {
parent.firstCustomDraw = true;
} else {
parent.columns [index].customDraw = true;
}
}
}
}
/**
* Sets the checked state of the receiver.
* <p>
*
* @param checked the new checked state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setChecked (boolean checked) {
checkWidget();
if ((parent.style & SWT.CHECK) == 0) return;
if (_getChecked () == checked) return;
GTK.gtk_tree_store_set (parent.modelHandle, handle, Tree.CHECKED_COLUMN, checked, -1);
/*
* GTK+'s "inconsistent" state does not match SWT's concept of grayed. To
* show checked+grayed differently from unchecked+grayed, we must toggle the
* grayed state on check and uncheck.
*/
GTK.gtk_tree_store_set (parent.modelHandle, handle, Tree.GRAYED_COLUMN, !checked ? false : grayed, -1);
cached = true;
}
/**
* Sets the expanded state of the receiver.
* <p>
*
* @param expanded the new expanded state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setExpanded (boolean expanded) {
checkWidget();
long path = GTK.gtk_tree_model_get_path (parent.modelHandle, handle);
if (expanded != GTK.gtk_tree_view_row_expanded (parent.handle, path)) {
if (expanded) {
OS.g_signal_handlers_block_matched (parent.handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, TEST_EXPAND_ROW);
GTK.gtk_tree_view_expand_row (parent.handle, path, false);
OS.g_signal_handlers_unblock_matched (parent.handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, TEST_EXPAND_ROW);
} else {
OS.g_signal_handlers_block_matched (parent.handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, TEST_COLLAPSE_ROW);
GTK.gtk_widget_realize (parent.handle);
GTK.gtk_tree_view_collapse_row (parent.handle, path);
OS.g_signal_handlers_unblock_matched (parent.handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, TEST_COLLAPSE_ROW);
}
}
GTK.gtk_tree_path_free (path);
isExpanded = expanded;
}
/**
* Sets the font that the receiver will use to paint textual information
* for this item to the font specified by the argument, or to the default font
* for that kind of control if the argument is null.
*
* @param font the new font (or null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.0
*/
public void setFont (Font font){
checkWidget ();
if (font != null && font.isDisposed ()) {
error (SWT.ERROR_INVALID_ARGUMENT);
}
Font oldFont = this.font;
if (oldFont == font) return;
this.font = font;
if (oldFont != null && oldFont.equals (font)) return;
long fontHandle = font != null ? font.handle : 0;
GTK.gtk_tree_store_set (parent.modelHandle, handle, Tree.FONT_COLUMN, fontHandle, -1);
cached = true;
}
/**
* Sets the font that the receiver will use to paint textual information
* for the specified cell in this item to the font specified by the
* argument, or to the default font for that kind of control if the
* argument is null.
*
* @param index the column index
* @param font the new font (or null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public void setFont (int index, Font font) {
checkWidget ();
if (font != null && font.isDisposed ()) {
error (SWT.ERROR_INVALID_ARGUMENT);
}
int count = Math.max (1, parent.getColumnCount ());
if (0 > index || index > count - 1) return;
if (cellFont == null) {
if (font == null) return;
cellFont = new Font [count];
}
Font oldFont = cellFont [index];
if (oldFont == font) return;
cellFont [index] = font;
if (oldFont != null && oldFont.equals (font)) return;
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
long fontHandle = font != null ? font.handle : 0;
GTK.gtk_tree_store_set (parent.modelHandle, handle, modelIndex + Tree.CELL_FONT, fontHandle, -1);
cached = true;
if (font != null) {
boolean customDraw = (parent.columnCount == 0) ? parent.firstCustomDraw : parent.columns [index].customDraw;
if (!customDraw) {
if ((parent.style & SWT.VIRTUAL) == 0) {
long parentHandle = parent.handle;
long column = 0;
if (parent.columnCount > 0) {
column = parent.columns [index].handle;
} else {
column = GTK.gtk_tree_view_get_column (parentHandle, index);
}
if (column == 0) return;
long textRenderer = parent.getTextRenderer (column);
long imageRenderer = parent.getPixbufRenderer (column);
GTK.gtk_tree_view_column_set_cell_data_func (column, textRenderer, display.cellDataProc, parentHandle, 0);
GTK.gtk_tree_view_column_set_cell_data_func (column, imageRenderer, display.cellDataProc, parentHandle, 0);
}
if (parent.columnCount == 0) {
parent.firstCustomDraw = true;
} else {
parent.columns [index].customDraw = true;
}
}
}
}
/**
* Sets the receiver's foreground color to the color specified
* by the argument, or to the default system color for the item
* if the argument is null.
*
* @param color the new color (or null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 2.0
*
*/
public void setForeground (Color color){
checkWidget ();
if (color != null && color.isDisposed ()) {
error (SWT.ERROR_INVALID_ARGUMENT);
}
if (_getForeground ().equals (color)) return;
GdkRGBA gdkRGBA = color != null ? color.handle : null;
GTK.gtk_tree_store_set (parent.modelHandle, handle, Tree.FOREGROUND_COLUMN, gdkRGBA, -1);
cached = true;
}
/**
* Sets the foreground color at the given column index in the receiver
* to the color specified by the argument, or to the default system color for the item
* if the argument is null.
*
* @param index the column index
* @param color the new color (or null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*
*/
public void setForeground (int index, Color color){
checkWidget ();
if (color != null && color.isDisposed ()) {
error (SWT.ERROR_INVALID_ARGUMENT);
}
if (_getForeground (index).equals (color)) return;
int count = Math.max (1, parent.getColumnCount ());
if (0 > index || index > count - 1) return;
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
GdkRGBA gdkRGBA = color != null ? color.handle : null;
GTK.gtk_tree_store_set (parent.modelHandle, handle, modelIndex + Tree.CELL_FOREGROUND, gdkRGBA, -1);
cached = true;
updated = true;
if (color != null) {
boolean customDraw = (parent.columnCount == 0) ? parent.firstCustomDraw : parent.columns [index].customDraw;
if (!customDraw) {
if ((parent.style & SWT.VIRTUAL) == 0) {
long parentHandle = parent.handle;
long column = 0;
if (parent.columnCount > 0) {
column = parent.columns [index].handle;
} else {
column = GTK.gtk_tree_view_get_column (parentHandle, index);
}
if (column == 0) return;
long textRenderer = parent.getTextRenderer (column);
long imageRenderer = parent.getPixbufRenderer (column);
GTK.gtk_tree_view_column_set_cell_data_func (column, textRenderer, display.cellDataProc, parentHandle, 0);
GTK.gtk_tree_view_column_set_cell_data_func (column, imageRenderer, display.cellDataProc, parentHandle, 0);
}
if (parent.columnCount == 0) {
parent.firstCustomDraw = true;
} else {
parent.columns [index].customDraw = true;
}
}
}
}
/**
* Sets the grayed state of the checkbox for this item. This state change
* only applies if the Tree was created with the SWT.CHECK style.
*
* @param grayed the new grayed state of the checkbox
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setGrayed (boolean grayed) {
checkWidget();
if ((parent.style & SWT.CHECK) == 0) return;
if (this.grayed == grayed) return;
this.grayed = grayed;
/*
* GTK+'s "inconsistent" state does not match SWT's concept of grayed.
* Render checked+grayed as "inconsistent", unchecked+grayed as blank.
*/
int [] ptr = new int [1];
GTK.gtk_tree_model_get (parent.modelHandle, handle, Tree.CHECKED_COLUMN, ptr, -1);
GTK.gtk_tree_store_set (parent.modelHandle, handle, Tree.GRAYED_COLUMN, ptr [0] == 0 ? false : grayed, -1);
cached = true;
}
/**
* Sets the receiver's image at a column.
*
* @param index the column index
* @param image the new image
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public void setImage(int index, Image image) {
checkWidget ();
if (image != null && image.isDisposed()) {
error(SWT.ERROR_INVALID_ARGUMENT);
}
if (image != null && image.type == SWT.ICON) {
if (image.equals(_getImage(index))) return;
}
int count = Math.max(1, parent.getColumnCount());
if (0 > index || index > count - 1) return;
long pixbuf = 0, surface = 0;
if (image != null) {
ImageList imageList = parent.imageList;
if (imageList == null) imageList = parent.imageList = new ImageList();
int imageIndex = imageList.indexOf(image);
// When we create a blank image surface gets created with dimensions 0, 0.
// This call recreates the surface with correct dimensions
surface = ImageList.convertSurface(image);
if (imageIndex == -1) {
imageIndex = imageList.add(image);
}
surface = imageList.getSurface(imageIndex);
pixbuf = ImageList.createPixbuf(surface);
}
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
long parentHandle = parent.handle;
long column = GTK.gtk_tree_view_get_column (parentHandle, index);
long pixbufRenderer = parent.getPixbufRenderer (column);
int [] currentWidth = new int [1];
int [] currentHeight= new int [1];
GTK.gtk_cell_renderer_get_fixed_size (pixbufRenderer, currentWidth, currentHeight);
if (!parent.pixbufSizeSet) {
if (image != null) {
int iWidth, iHeight;
if (DPIUtil.useCairoAutoScale()) {
iWidth = image.getBounds ().width;
iHeight = image.getBounds ().height;
} else {
iWidth = image.getBoundsInPixels ().width;
iHeight = image.getBoundsInPixels ().height;
}
if (iWidth > currentWidth [0] || iHeight > currentHeight [0]) {
GTK.gtk_cell_renderer_set_fixed_size (pixbufRenderer, iWidth, iHeight);
parent.pixbufSizeSet = true;
parent.pixbufHeight = iHeight;
parent.pixbufWidth = iWidth;
/*
* Feature in GTK: a Tree with the style SWT.VIRTUAL has
* fixed-height-mode enabled. This will limit the size of
* any cells, including renderers. In order to prevent
* images from disappearing/being cropped, we re-create
* the renderers when the first image is set. Fix for
* bug 480261.
*/
if ((parent.style & SWT.VIRTUAL) != 0) {
/*
* Only re-create SWT.CHECK renderers if this is the first column.
* Otherwise check-boxes will be rendered in columns they are not
* supposed to be rendered in. See bug 513761.
*/
boolean check = modelIndex == Tree.FIRST_COLUMN && (parent.style & SWT.CHECK) != 0;
parent.createRenderers(column, modelIndex, check, parent.style);
}
}
}
} else {
/*
* Bug 483112: We check to see if the cached value is greater than the size of the pixbufRenderer.
* If it is, then we change the size of the pixbufRenderer accordingly.
* Bug 489025: There is a corner case where the below is triggered when current(Width|Height) is -1,
* which results in icons being set to 0. Fix is to compare only positive sizes.
*/
if (parent.pixbufWidth > Math.max(currentWidth [0], 0) || parent.pixbufHeight > Math.max(currentHeight [0], 0)) {
GTK.gtk_cell_renderer_set_fixed_size (pixbufRenderer, parent.pixbufWidth, parent.pixbufHeight);
}
}
GTK.gtk_tree_store_set(parent.modelHandle, handle, modelIndex + Tree.CELL_PIXBUF, pixbuf, -1);
GTK.gtk_tree_store_set(parent.modelHandle, handle, modelIndex + Tree.CELL_SURFACE, surface, -1);
cached = true;
updated = true;
}
@Override
public void setImage (Image image) {
checkWidget ();
setImage (0, image);
}
/**
* Sets the image for multiple columns in the tree.
*
* @param images the array of new images
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the array of images is null</li>
* <li>ERROR_INVALID_ARGUMENT - if one of the images has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public void setImage (Image [] images) {
checkWidget ();
if (images == null) error (SWT.ERROR_NULL_ARGUMENT);
for (int i=0; i<images.length; i++) {
setImage (i, images [i]);
}
}
/**
* Sets the number of child items contained in the receiver.
*
* @param count the number of items
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.2
*/
public void setItemCount (int count) {
checkWidget ();
count = Math.max (0, count);
parent.setItemCount (handle, count);
}
/**
* Sets the receiver's text at a column
* <p>
* Note: If control characters like '\n', '\t' etc. are used
* in the string, then the behavior is platform dependent.
* </p>
* @param index the column index
* @param string the new text
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the text is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public void setText (int index, String string) {
checkWidget ();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
if (strings == null) {
if (_getText (index).equals (string)) return;
}
else if ( getText (index).equals (string)) return;
int count = Math.max (1, parent.getColumnCount ());
if (0 > index || index > count - 1) return;
if (0 <= index && index < count) {
if (strings == null) strings = new String [count];
if (string.equals (strings [index])) return;
strings [index] = string;
}
if ((string != null) && (string.length() > TEXT_LIMIT)) {
string = string.substring(0, TEXT_LIMIT - ELLIPSIS.length()) + ELLIPSIS;
}
byte[] buffer = Converter.wcsToMbcs (string, true);
int modelIndex = parent.columnCount == 0 ? Tree.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_store_set (parent.modelHandle, handle, modelIndex + Tree.CELL_TEXT, buffer, -1);
cached = true;
updated = true;
}
@Override
public void setText (String string) {
checkWidget ();
setText (0, string);
}
/**
* Sets the text for multiple columns in the tree.
* <p>
* Note: If control characters like '\n', '\t' etc. are used
* in the string, then the behavior is platform dependent.
* </p>
* @param strings the array of new strings
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the text is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @since 3.1
*/
public void setText (String [] strings) {
checkWidget ();
if (strings == null) error (SWT.ERROR_NULL_ARGUMENT);
for (int i=0; i<strings.length; i++) {
String string = strings [i];
if (string != null) setText (i, string);
}
}
}