All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.swt.widgets.TreeColumn Maven / Gradle / Ivy

The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2016 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.events.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.gtk.*;
import org.eclipse.swt.internal.gtk3.*;
import org.eclipse.swt.internal.gtk4.*;

/**
 * Instances of this class represent a column in a tree widget.
 * 
*
Styles:
*
LEFT, RIGHT, CENTER
*
Events:
*
Move, Resize, Selection
*
*

* Note: Only one of the styles LEFT, RIGHT and CENTER may be specified. *

* IMPORTANT: This class is not intended to be subclassed. *

* * @see Tree, TreeItem, TreeColumn snippets * @see Sample code and further information * * @since 3.1 * @noextend This class is not intended to be subclassed by clients. */ public class TreeColumn extends Item { long headerButtonCSSProvider = 0; long labelHandle, imageHandle, buttonHandle; Tree parent; int modelIndex, lastTime, lastX, lastWidth; boolean customDraw; String toolTipText; /** * Constructs a new instance of this class given its parent * (which must be a Tree) 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#LEFT * @see SWT#RIGHT * @see SWT#CENTER * @see Widget#checkSubclass * @see Widget#getStyle */ public TreeColumn (Tree parent, int style) { super (parent, checkStyle (style)); this.parent = parent; createWidget (parent.getColumnCount ()); } /** * Constructs a new instance of this class given its parent * (which must be a Tree), 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. *

*

* Note that due to a restriction on some platforms, the first column * is always left aligned. *

* @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#LEFT * @see SWT#RIGHT * @see SWT#CENTER * @see Widget#checkSubclass * @see Widget#getStyle */ public TreeColumn (Tree parent, int style, int index) { super (parent, checkStyle (style)); this.parent = parent; createWidget (index); } /** * Adds the listener to the collection of listeners who will * be notified when the control is moved or resized, by sending * it one of the messages defined in the ControlListener * interface. * * @param listener the listener which should be notified * * @exception IllegalArgumentException
    *
  • ERROR_NULL_ARGUMENT - if the listener 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
  • *
* * @see ControlListener * @see #removeControlListener */ public void addControlListener(ControlListener listener) { addTypedListener(listener, SWT.Resize, SWT.Move); } /** * Adds the listener to the collection of listeners who will * be notified when the control is selected by the user, by sending * it one of the messages defined in the SelectionListener * interface. *

* widgetSelected is called when the column header is selected. * widgetDefaultSelected is not called. *

* * @param listener the listener which should be notified when the control is selected by the user * * @exception IllegalArgumentException
    *
  • ERROR_NULL_ARGUMENT - if the listener 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
  • *
* * @see SelectionListener * @see #removeSelectionListener * @see SelectionEvent */ public void addSelectionListener (SelectionListener listener) { addTypedListener(listener, SWT.Selection, SWT.DefaultSelection); } static int checkStyle (int style) { return checkBits (style, SWT.LEFT, SWT.CENTER, SWT.RIGHT, 0, 0, 0); } @Override protected void checkSubclass () { if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); } @Override void createWidget (int index) { parent.createItem (this, index); setOrientation (true); hookEvents (); register (); text = ""; } @Override void deregister() { super.deregister (); display.removeWidget (handle); if (buttonHandle != 0) display.removeWidget (buttonHandle); if (labelHandle != 0) display.removeWidget (labelHandle); } @Override void destroyWidget () { parent.destroyItem (this); releaseHandle (); } /** * Returns a value which describes the position of the * text or image in the receiver. The value will be one of * LEFT, RIGHT or CENTER. * * @return the alignment * * @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 getAlignment () { checkWidget(); if ((style & SWT.LEFT) != 0) return SWT.LEFT; if ((style & SWT.CENTER) != 0) return SWT.CENTER; if ((style & SWT.RIGHT) != 0) return SWT.RIGHT; return SWT.LEFT; } /** * Gets the moveable attribute. A column that is * not moveable cannot be reordered by the user * by dragging the header but may be reordered * by the programmer. * * @return the moveable attribute * * @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
  • *
* * @see Tree#getColumnOrder() * @see Tree#setColumnOrder(int[]) * @see TreeColumn#setMoveable(boolean) * @see SWT#Move * * @since 3.2 */ public boolean getMoveable() { checkWidget(); return GTK.gtk_tree_view_column_get_reorderable (handle); } /** * Returns the receiver's parent, which must be a Tree. * * @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 Tree getParent () { checkWidget(); return parent; } /** * Gets the resizable attribute. A column that is * not resizable cannot be dragged by the user but * may be resized by the programmer. * * @return the resizable attribute * * @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 getResizable () { checkWidget(); return GTK.gtk_tree_view_column_get_resizable (handle); } /** * Returns the receiver's tool tip text, or null if it has * not been set. * * @return the receiver's tool tip 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 String getToolTipText () { checkWidget(); return toolTipText; } /** * Gets the width of the receiver. * * @return the width * * @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 getWidth () { checkWidget (); return DPIUtil.autoScaleDown (getWidthInPixels ()); } int getWidthInPixels () { checkWidget(); if (!GTK.gtk_tree_view_column_get_visible (handle)) { return 0; } return GTK.gtk_tree_view_column_get_fixed_width(handle); } @Override long gtk_clicked (long widget) { /* * There is no API to get a double click on a table column. Normally, when * the mouse is double clicked, this is indicated by GDK_2BUTTON_PRESS * but the table column sends the click signal on button release. The fix is to * test for double click by remembering the last click time and mouse button * and testing for the double click interval. */ boolean doubleClick = false; long eventPtr = GTK3.gtk_get_current_event (); if (eventPtr != 0) { int eventType = GDK.gdk_event_get_event_type(eventPtr); int eventTime = GDK.gdk_event_get_time(eventPtr); if (eventType == GDK.GDK_BUTTON_RELEASE) { int clickTime = display.getDoubleClickTime(); if (lastTime != 0 && Math.abs(lastTime - eventTime) <= clickTime) { doubleClick = true; } lastTime = eventTime == 0 ? 1: eventTime; } gdk_event_free(eventPtr); } sendSelectionEvent(doubleClick ? SWT.DefaultSelection : SWT.Selection); return 0; } @Override void gtk_gesture_press_event(long gesture, int n_press, double x, double y, long event) { boolean doubleClick = n_press >= 2 ? true : false; sendSelectionEvent(doubleClick ? SWT.DefaultSelection : SWT.Selection); } @Override long gtk_event_after (long widget, long gdkEvent) { int eventType = GDK.gdk_event_get_event_type(gdkEvent); eventType = Control.fixGdkEventTypeValues(eventType); switch (eventType) { case GDK.GDK_BUTTON_PRESS: { int [] eventButton = new int [1]; if (GTK.GTK4) { eventButton[0] = GDK.gdk_button_event_get_button(gdkEvent); } else { GDK.gdk_event_get_button(gdkEvent, eventButton); } double [] eventRX = new double [1]; double [] eventRY = new double [1]; GDK.gdk_event_get_root_coords(gdkEvent, eventRX, eventRY); if (eventButton[0] == 3) { parent.showMenu ((int) eventRX[0], (int) eventRY[0]); } break; } } return 0; } @Override long gtk_mnemonic_activate (long widget, long arg1) { return parent.gtk_mnemonic_activate (widget, arg1); } @Override long gtk_size_allocate (long widget, long allocation) { GtkAllocation widgetAllocation = new GtkAllocation(); GTK.gtk_widget_get_allocation (widget, widgetAllocation); int x = widgetAllocation.x; int width = widgetAllocation.width; if (x != lastX) { lastX = x; sendEvent (SWT.Move); } if (width != lastWidth) { lastWidth = width; sendEvent (SWT.Resize); } return 0; } @Override void hookEvents () { super.hookEvents(); if (GTK.GTK4) { long clickController = GTK4.gtk_gesture_click_new(); GTK4.gtk_widget_add_controller(buttonHandle, clickController); GTK.gtk_event_controller_set_propagation_phase(clickController, GTK.GTK_PHASE_CAPTURE); OS.g_signal_connect(clickController, OS.pressed, display.gesturePressReleaseProc, GESTURE_PRESSED); } else { OS.g_signal_connect_closure (handle, OS.clicked, display.getClosure (CLICKED), false); } if (buttonHandle != 0) { if (GTK.GTK4) { //TODO: GTK4 event-after, size-allocate signals (if necessary) } else { OS.g_signal_connect_closure_by_id (buttonHandle, display.signalIds [EVENT_AFTER], 0, display.getClosure (EVENT_AFTER), false); OS.g_signal_connect_closure_by_id (buttonHandle, display.signalIds [SIZE_ALLOCATE], 0, display.getClosure (SIZE_ALLOCATE), false); } } if (labelHandle != 0) OS.g_signal_connect_closure_by_id (labelHandle, display.signalIds [MNEMONIC_ACTIVATE], 0, display.getClosure (MNEMONIC_ACTIVATE), false); } /** * Causes the receiver to be resized to its preferred size. * For a composite, this involves computing the preferred size * from its layout, if there is one. * * @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 pack () { checkWidget(); int width = 0; if (buttonHandle != 0) { /* * Bug 546490: Ensure the header button is set to * true before getting preferred size of GtkTreeView */ boolean visible = GTK.gtk_widget_get_visible(buttonHandle); if (!visible) GTK.gtk_widget_set_visible(buttonHandle, true); GtkRequisition requisition = new GtkRequisition (); gtk_widget_get_preferred_size (buttonHandle, requisition); width = requisition.width; } if ((parent.style & SWT.VIRTUAL) != 0) { for (int i=0; i *
  • ERROR_NULL_ARGUMENT - if the listener 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
    • *
    * * @see ControlListener * @see #addControlListener */ public void removeControlListener (ControlListener listener) { checkWidget(); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); if (eventTable == null) return; eventTable.unhook (SWT.Move, listener); eventTable.unhook (SWT.Resize, listener); } /** * Removes the listener from the collection of listeners who will * be notified when the control is selected by the user. * * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException
      *
    • ERROR_NULL_ARGUMENT - if the listener 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
    • *
    * * @see SelectionListener * @see #addSelectionListener */ public void removeSelectionListener(SelectionListener listener) { checkWidget(); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); if (eventTable == null) return; eventTable.unhook (SWT.Selection, listener); eventTable.unhook (SWT.DefaultSelection,listener); } /** * Controls how text and images will be displayed in the receiver. * The argument should be one of LEFT, RIGHT * or CENTER. *

    * Note that due to a restriction on some platforms, the first column * is always left aligned. *

    * @param alignment the new alignment * * @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 setAlignment (int alignment) { checkWidget(); if ((alignment & (SWT.LEFT | SWT.RIGHT | SWT.CENTER)) == 0) return; int index = parent.indexOf (this); if (index == -1 || index == 0) return; style &= ~(SWT.LEFT | SWT.RIGHT | SWT.CENTER); style |= alignment & (SWT.LEFT | SWT.RIGHT | SWT.CENTER); parent.createRenderers (handle, modelIndex, index == 0, style); } void setFontDescription (long font) { setFontDescription (labelHandle, font); } @Override public void setImage (Image image) { checkWidget (); super.setImage (image); if (image != null) { ImageList headerImageList = parent.headerImageList; if (headerImageList == null) { headerImageList = parent.headerImageList = new ImageList (); } int imageIndex = headerImageList.indexOf (image); if (imageIndex == -1) imageIndex = headerImageList.add (image); if (GTK.GTK4) { long pixbuf = ImageList.createPixbuf(image); long texture = GDK.gdk_texture_new_for_pixbuf(pixbuf); OS.g_object_unref(pixbuf); GTK4.gtk_image_set_from_paintable(imageHandle, texture); } else { GTK3.gtk_image_set_from_surface(imageHandle, headerImageList.getSurface(imageIndex)); } GTK.gtk_widget_show(imageHandle); } else { if (GTK.GTK4) { GTK4.gtk_image_clear(imageHandle); } else { GTK3.gtk_image_set_from_surface(imageHandle, 0); } GTK.gtk_widget_hide(imageHandle); } } /** * Sets the moveable attribute. A column that is * moveable can be reordered by the user by dragging * the header. A column that is not moveable cannot be * dragged by the user but may be reordered * by the programmer. * * @param moveable the moveable attribute * * @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
    • *
    * * @see Tree#setColumnOrder(int[]) * @see Tree#getColumnOrder() * @see TreeColumn#getMoveable() * @see SWT#Move * * @since 3.2 */ public void setMoveable (boolean moveable) { checkWidget(); GTK.gtk_tree_view_column_set_reorderable (handle, moveable); } @Override void setOrientation (boolean create) { if ((parent.style & SWT.RIGHT_TO_LEFT) != 0 || !create) { if (buttonHandle != 0) { int dir = (parent.style & SWT.RIGHT_TO_LEFT) != 0 ? GTK.GTK_TEXT_DIR_RTL : GTK.GTK_TEXT_DIR_LTR; GTK.gtk_widget_set_direction (buttonHandle, dir); GTK3.gtk_container_forall (buttonHandle, display.setDirectionProc, dir); } } } /** * Sets the resizable attribute. A column that is * not resizable cannot be dragged by the user but * may be resized by the programmer. * * @param resizable the resize attribute * * @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 setResizable (boolean resizable) { checkWidget(); GTK.gtk_tree_view_column_set_resizable (handle, resizable); } @Override public void setText (String string) { checkWidget(); if (string == null) error (SWT.ERROR_NULL_ARGUMENT); super.setText (string); char [] chars = fixMnemonic (string); byte [] buffer = Converter.wcsToMbcs (chars, true); GTK.gtk_label_set_text_with_mnemonic (labelHandle, buffer); if (string.length () != 0) { GTK.gtk_widget_show (labelHandle); } else { GTK.gtk_widget_hide (labelHandle); } } /** * Sets the receiver's tool tip text to the argument, which * may be null indicating that the default tool tip for the * control will be shown. For a control that has a default * tool tip, such as the Tree control on Windows, setting * the tool tip text to an empty string replaces the default, * causing no tool tip text to be shown. *

    * The mnemonic indicator (character '&') is not displayed in a tool tip. * To display a single '&' in the tool tip, the character '&' can be * escaped by doubling it in the string. *

    *

    * NOTE: This operation is a hint and behavior is platform specific, on Windows * for CJK-style mnemonics of the form " (&C)" at the end of the tooltip text * are not shown in tooltip. *

    * * @param string the new tool tip text (or 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
    • *
    * * @since 3.2 */ public void setToolTipText(String string) { checkWidget(); toolTipText = string; setToolTipText(buttonHandle, string); } /** * Sets the width of the receiver. * * @param width the new width * * @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 setWidth(int width) { checkWidget(); setWidthInPixels(DPIUtil.autoScaleUp(width)); } void setWidthInPixels(int width) { checkWidget(); if (width < 0) return; if (width == lastWidth) return; if (width > 0) { GTK.gtk_tree_view_column_set_fixed_width(handle, width); } /* * Bug in GTK. For some reason, calling gtk_tree_view_column_set_visible() * when the parent is not realized fails to show the column. The fix is to * ensure that the table has been realized. */ if (width != 0) GTK.gtk_widget_realize (parent.handle); GTK.gtk_tree_view_column_set_visible (handle, width != 0); lastWidth = width; /* * Bug in GTK. When the column is made visible the event window of column * header is raised above the gripper window of the previous column. In * some cases, this can cause the previous column to be not resizable by * the mouse. The fix is to find the event window and lower it to bottom to * the z-order stack. */ if (width != 0) { if (buttonHandle != 0) { if (GTK.GTK4) { /* TODO: GTK4 Removed this for time being, as not confirm if this bug still exists. Has to be * removed since the fix requires functions that no longer exist in GTK4. */ } else { long window = GTK.gtk_widget_get_parent_window (buttonHandle); if (window != 0) { long windowList = GDK.gdk_window_get_children (window); if (windowList != 0) { long windows = windowList; long [] userData = new long [1]; while (windows != 0) { long child = OS.g_list_data (windows); GDK.gdk_window_get_user_data (child, userData); if (userData[0] == buttonHandle) { GDK.gdk_window_lower (child); break; } windows = OS.g_list_next (windows); } OS.g_list_free (windowList); } } } } } sendEvent (SWT.Resize); } void setHeaderCSS(String css) { if (headerButtonCSSProvider == 0) { headerButtonCSSProvider = GTK.gtk_css_provider_new(); GTK.gtk_style_context_add_provider(GTK.gtk_widget_get_style_context(buttonHandle), headerButtonCSSProvider, GTK.GTK_STYLE_PROVIDER_PRIORITY_APPLICATION); } if (GTK.GTK4) { GTK4.gtk_css_provider_load_from_data(headerButtonCSSProvider, Converter.javaStringToCString(css), -1); } else { GTK3.gtk_css_provider_load_from_data(headerButtonCSSProvider, Converter.javaStringToCString(css), -1, null); } } @Override public void dispose() { super.dispose(); if (headerButtonCSSProvider != 0) { OS.g_object_unref(headerButtonCSSProvider); headerButtonCSSProvider = 0; } } @Override long dpiChanged(long object, long arg0) { super.dpiChanged(object, arg0); if (image != null) { image.internal_gtk_refreshImageForZoom(); setImage(image); } return 0; } }




    © 2015 - 2024 Weber Informatics LLC | Privacy Policy