org.eclipse.swt.widgets.TableItem Maven / Gradle / Ivy
Show all versions of org.eclipse.swt.gtk.linux.ppc64le Show documentation
/*******************************************************************************
* 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.cairo.*;
import org.eclipse.swt.internal.gtk.*;
import org.eclipse.swt.internal.gtk3.*;
import org.eclipse.swt.internal.gtk4.*;
/**
* Instances of this class represent a selectable user interface object
* that represents an item in a table.
*
* - Styles:
* - (none)
* - Events:
* - (none)
*
*
* IMPORTANT: This class is not intended to be subclassed.
*
*
* @see Table, TableItem, TableColumn snippets
* @see Sample code and further information
* @noextend This class is not intended to be subclassed by clients.
*/
public class TableItem extends Item {
Table parent;
Font font;
Font[] cellFont;
String [] strings;
boolean cached, grayed, settingData;
/**
* Constructs a new instance of this class given its parent
* (which must be a Table
), a style value
* describing its behavior and appearance, and the index
* at which to place it in the items maintained by its parent.
*
* 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.
*
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
* @param index the zero-relative index to store the receiver in its parent
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the parent is null
* - ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)
*
* @exception 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 SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public TableItem (Table parent, int style, int index) {
this (parent, style, index, true);
}
/**
* Constructs a new instance of this class given its parent
* (which must be a Table
) and a style value
* describing its behavior and appearance. The item is added
* to the end of the items maintained by its parent.
*
* 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.
*
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the parent is null
*
* @exception 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 SWT
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public TableItem (Table parent, int style) {
this (parent, style, checkNull (parent).getItemCount (), true);
}
TableItem (Table parent, int style, int index, boolean create) {
super (parent, style);
this.parent = parent;
if (create) {
parent.createItem (this, index);
} else {
handle = OS.g_malloc (GTK.GtkTreeIter_sizeof ());
GTK.gtk_tree_model_iter_nth_child (parent.modelHandle, handle, 0, index);
}
}
static Table checkNull (Table control) {
if (control == null) SWT.error (SWT.ERROR_NULL_ARGUMENT);
return control;
}
Color _getBackground () {
long [] ptr = new long [1];
GTK.gtk_tree_model_get (parent.modelHandle, handle, Table.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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Table.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, Table.CHECKED_COLUMN, ptr, -1);
return ptr [0] != 0;
}
Color _getForeground () {
long [] ptr = new long [1];
GTK.gtk_tree_model_get (parent.modelHandle, handle, Table.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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Table.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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Table.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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_tree_model_get (parent.modelHandle, handle, modelIndex + Table.CELL_TEXT, ptr, -1);
if (ptr [0] == 0) return "";
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));
}
@Override
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
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=Table.CHECKED_COLUMN; i 0 && parent.getSelectionCount() == 0) {
tmpParent = parent;
}
super.dispose();
if (tmpParent != null && !tmpParent.isDisposed()) tmpParent.deselectAll();
}
/**
* Returns the receiver's background color.
*
* @return the background color
*
* @exception 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.0
*/
public Color getBackground () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getBackground ();
}
/**
* 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
* - 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
*/
public Rectangle getBounds () {
return DPIUtil.autoScaleDown (getBoundsinPixels ());
}
/**
* 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
* - 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.105
*/
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);
GTK.gtk_tree_path_free (path);
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 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 {
int[] buffer = new int[1];
GTK3.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 the background color at the given column index in the receiver.
*
* @param index the column index
* @return the background color
*
* @exception 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.0
*/
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 table.
*
* @param index the index that specifies the column
* @return the receiver's bounding column rectangle
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public Rectangle getBounds (int index) {
checkWidget ();
return DPIUtil.autoScaleDown (getBoundsInPixels (index));
}
Rectangle getBoundsInPixels (int index) {
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);
GTK.gtk_tree_view_column_cell_set_cell_data (column, parent.modelHandle, handle, false, false);
GdkRectangle rect = new GdkRectangle ();
GTK.gtk_tree_view_get_cell_area (parentHandle, path, column, rect);
GTK.gtk_tree_path_free (path);
int [] columnWidth = new int [1], columnHeight = new int [1];
parent.ignoreSize = true;
if (GTK.GTK4) {
GTK4.gtk_tree_view_column_cell_get_size(column, null, null, columnWidth, columnHeight);
} else {
GTK3.gtk_tree_view_column_cell_get_size(column, null, null, null, columnWidth, columnHeight);
}
parent.ignoreSize = false;
rect.height = columnHeight [0];
if ((parent.getStyle () & SWT.MIRRORED) != 0) rect.x = parent.getClientWidth () - rect.width - rect.x;
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);
/*
* 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 true
if the receiver is checked,
* and false otherwise. When the parent does not have
* the CHECK
style, return false.
*
* @return the checked state of the checkbox
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public boolean getChecked () {
checkWidget();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
if ((parent.style & SWT.CHECK) == 0) return false;
return _getChecked ();
}
/**
* Returns the font that the receiver will use to paint textual information for this item.
*
* @return the receiver's font
*
* @exception 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.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
* - 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.0
*/
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
* - 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.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
* - 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.0
*/
public Color getForeground (int index) {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
return _getForeground (index);
}
/**
* Returns true
if the receiver is grayed,
* and false otherwise. When the parent does not have
* the CHECK
style, return false.
*
* @return the grayed state of the checkbox
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
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
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
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
* table. An empty rectangle is returned if index exceeds
* the index of the table's last column.
*
* @param index the index that specifies the column
* @return the receiver's bounding image rectangle
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public Rectangle getImageBounds (int index) {
checkWidget ();
return DPIUtil.autoScaleDown (getImageBoundsInPixels (index));
}
Rectangle getImageBoundsInPixels (int index) {
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 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);
GTK.gtk_tree_path_free (path);
if ((parent.getStyle () & SWT.MIRRORED) != 0) rect.x = parent.getClientWidth () - rect.width - rect.x;
int [] x = new int [1], w = new int[1];
gtk_tree_view_column_cell_get_position (column, pixbufRenderer, x, w);
/*
* 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.
*/
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 TableItem'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;
return new Rectangle (rect.x, rect.y, width, rect.height + 1);
}
/**
* Gets the image indent.
*
* @return the indent
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public int getImageIndent () {
checkWidget ();
if (!parent.checkData (this)) error (SWT.ERROR_WIDGET_DISPOSED);
/* Image indent is not supported on GTK */
return 0;
}
@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 Table
.
*
* @return the receiver's parent
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public Table getParent () {
checkWidget ();
return parent;
}
@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
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
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
* table. An empty rectangle is returned if index exceeds
* the index of the table's last column.
*
* @param index the index that specifies the column
* @return the receiver's bounding text rectangle
*
* @exception 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.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);
GTK.gtk_tree_path_free (path);
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 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 {
int[] buffer = new int[1];
GTK3.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);
}
@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;
}
/**
* 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
* - ERROR_INVALID_ARGUMENT - if the argument has been disposed
*
* @exception 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.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_list_store_set (parent.modelHandle, handle, Table.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
* - ERROR_INVALID_ARGUMENT - if the argument has been disposed
*
* @exception 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.0
*/
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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GdkRGBA gdkRGBA = color != null ? color.handle : null;
GTK.gtk_list_store_set (parent.modelHandle, handle, modelIndex + Table.CELL_BACKGROUND, gdkRGBA, -1);
cached = 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 checkbox for this item. This state change
* only applies if the Table was created with the SWT.CHECK style.
*
* @param checked the new checked state of the checkbox
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public void setChecked (boolean checked) {
checkWidget();
if ((parent.style & SWT.CHECK) == 0) return;
if (_getChecked () == checked) return;
GTK.gtk_list_store_set (parent.modelHandle, handle, Table.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_list_store_set (parent.modelHandle, handle, Table.GRAYED_COLUMN, !checked ? false : grayed, -1);
cached = true;
}
/**
* 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
* - ERROR_INVALID_ARGUMENT - if the argument has been disposed
*
* @exception 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.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_list_store_set (parent.modelHandle, handle, Table.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
* - ERROR_INVALID_ARGUMENT - if the argument has been disposed
*
* @exception 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.0
*/
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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
long fontHandle = font != null ? font.handle : 0;
GTK.gtk_list_store_set (parent.modelHandle, handle, modelIndex + Table.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
* - ERROR_INVALID_ARGUMENT - if the argument has been disposed
*
* @exception 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.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_list_store_set (parent.modelHandle, handle, Table.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
* - ERROR_INVALID_ARGUMENT - if the argument has been disposed
*
* @exception 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.0
*/
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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GdkRGBA gdkRGBA = color != null ? color.handle : null;
GTK.gtk_list_store_set (parent.modelHandle, handle, modelIndex + Table.CELL_FOREGROUND, gdkRGBA, -1);
cached = 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 Table was created with the SWT.CHECK style.
*
* @param grayed the new grayed state of the checkbox;
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
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, Table.CHECKED_COLUMN, ptr, -1);
GTK.gtk_list_store_set (parent.modelHandle, handle, Table.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
* - ERROR_INVALID_ARGUMENT - if the image has been disposed
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
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
long tempSurface = ImageList.convertSurface(image);
Cairo.cairo_surface_destroy(tempSurface);
if (imageIndex == -1) {
imageIndex = imageList.add(image);
}
surface = imageList.getSurface(imageIndex);
pixbuf = ImageList.createPixbuf(surface);
}
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.pixbufHeight = iHeight;
parent.pixbufWidth = iWidth;
parent.pixbufSizeSet = true;
}
}
} else {
/*
* 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);
}
}
int modelIndex = parent.columnCount == 0 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_list_store_set (parent.modelHandle, handle, modelIndex + Table.CELL_PIXBUF, pixbuf, -1);
/*
* Bug 573633: gtk_list_store_set() will reference the handle. So we unref the pixbuf here,
* and leave the destruction of the handle to be done later on by the GTK+ tree.
*/
if (pixbuf != 0) {
OS.g_object_unref(pixbuf);
}
GTK.gtk_list_store_set (parent.modelHandle, handle, modelIndex + Table.CELL_SURFACE, surface, -1);
cached = true;
/*
* Bug 465056: single column Tables have a very small initial width.
* Fix: when text or an image is set for a Table, compute its
* width and see if it's larger than the maximum of the previous widths.
*/
if (parent.columnCount == 0) {
column = GTK.gtk_tree_view_get_column (parent.handle, index);
parent.maxWidth = Math.max(parent.maxWidth, parent.calculateWidth(column, this.handle));
}
}
@Override
public void setImage (Image image) {
checkWidget ();
setImage (0, image);
}
/**
* Sets the image for multiple columns in the table.
*
* @param images the array of new images
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the array of images is null
* - ERROR_INVALID_ARGUMENT - if one of the images has been disposed
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public void setImage (Image [] images) {
checkWidget ();
if (images == null) error (SWT.ERROR_NULL_ARGUMENT);
for (int i=0; i
* ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*
* @deprecated this functionality is not supported on most platforms
*/
@Deprecated
public void setImageIndent (int indent) {
checkWidget ();
if (indent < 0) return;
/* Image indent is not supported on GTK */
cached = true;
}
/**
* Sets the receiver's text at a column
*
* Note: If control characters like '\n', '\t' etc. are used
* in the string, then the behavior is platform dependent.
*
* @param index the column index
* @param string the new text
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the text is null
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
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 ? Table.FIRST_COLUMN : parent.columns [index].modelIndex;
GTK.gtk_list_store_set (parent.modelHandle, handle, modelIndex + Table.CELL_TEXT, buffer, -1);
cached = true;
/*
* Bug 465056: single column Tables have a very small initial width.
* Fix: when text or an image is set for a Table, compute its
* width and see if it's larger than the maximum of the previous widths.
*/
long column;
if (parent.columnCount == 0) {
column = GTK.gtk_tree_view_get_column (parent.handle, index);
parent.maxWidth = Math.max(parent.maxWidth, parent.calculateWidth(column, this.handle));
}
}
@Override
public void setText (String string) {
checkWidget ();
setText (0, string);
}
/**
* Sets the text for multiple columns in the table.
*
* Note: If control characters like '\n', '\t' etc. are used
* in the string, then the behavior is platform dependent.
*
* @param strings the array of new strings
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the text is null
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public void setText (String [] strings) {
checkWidget ();
if (strings == null) error (SWT.ERROR_NULL_ARGUMENT);
for (int i=0; i