/******************************************************************************* * Copyright (c) 2000, 2017 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.win32.*; /** * 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 { Tree parent; boolean resizable, moveable; String toolTipText; int id; /** * 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 * @exception SWTException * * @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)); resizable = true; this.parent = parent; parent.createItem (this, 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 * @exception SWTException * * @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)); resizable = true; this.parent = parent; parent.createItem (this, 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 * @exception SWTException * * @see ControlListener * @see #removeControlListener */ public void addControlListener(ControlListener listener) { checkWidget (); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (SWT.Resize,typedListener); addListener (SWT.Move,typedListener); } /** * 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 * @exception SWTException * * @see SelectionListener * @see #removeSelectionListener * @see SelectionEvent */ public void addSelectionListener (SelectionListener listener) { checkWidget (); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (SWT.Selection,typedListener); addListener (SWT.DefaultSelection,typedListener); } 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 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 */ 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 * * @see Tree#getColumnOrder() * @see Tree#setColumnOrder(int[]) * @see TreeColumn#setMoveable(boolean) * @see SWT#Move * * @since 3.2 */ public boolean getMoveable () { checkWidget (); return moveable; } @Override String getNameText () { return getText (); } /** * Returns the receiver's parent, which must be a Tree. * * @return the receiver's parent * * @exception SWTException */ 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 */ public boolean getResizable () { checkWidget (); return resizable; } /** * Returns the receiver's tool tip text, or null if it has * not been set. * * @return the receiver's tool tip text * * @exception SWTException * * @since 3.2 */ public String getToolTipText () { checkWidget(); return toolTipText; } /** * Gets the width of the receiver. * * @return the width * * @exception SWTException */ public int getWidth () { checkWidget (); return DPIUtil.autoScaleDown(getWidthInPixels()); } int getWidthInPixels () { int index = parent.indexOf (this); if (index == -1) return 0; long hwndHeader = parent.hwndHeader; if (hwndHeader == 0) return 0; HDITEM hdItem = new HDITEM (); hdItem.mask = OS.HDI_WIDTH; OS.SendMessage (hwndHeader, OS.HDM_GETITEM, index, hdItem); return hdItem.cxy; } /** * 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 * */ public void pack () { checkWidget (); int index = parent.indexOf (this); if (index == -1) return; int columnWidth = 0; long hwnd = parent.handle, hwndHeader = parent.hwndHeader; RECT headerRect = new RECT (); OS.SendMessage (hwndHeader, OS.HDM_GETITEMRECT, index, headerRect); long hDC = OS.GetDC (hwnd); long oldFont = 0, newFont = OS.SendMessage (hwnd, OS.WM_GETFONT, 0, 0); if (newFont != 0) oldFont = OS.SelectObject (hDC, newFont); TVITEM tvItem = new TVITEM (); tvItem.mask = OS.TVIF_HANDLE | OS.TVIF_PARAM | OS.TVIF_STATE; tvItem.hItem = OS.SendMessage (hwnd, OS.TVM_GETNEXTITEM, OS.TVGN_ROOT, 0); while (tvItem.hItem != 0) { OS.SendMessage (hwnd, OS.TVM_GETITEM, 0, tvItem); TreeItem item = tvItem.lParam != -1 ? parent.items [(int)tvItem.lParam] : null; if (item != null) { int itemRight = 0; if (parent.hooks (SWT.MeasureItem)) { int detail = (tvItem.state & OS.TVIS_SELECTED) != 0 ? SWT.SELECTED : 0; Event event = parent.sendMeasureItemEvent (item, index, hDC, detail); if (isDisposed () || parent.isDisposed ()) break; Rectangle bounds = event.getBoundsInPixels(); itemRight = bounds.x + bounds.width; } else { long hFont = item.fontHandle (index); if (hFont != -1) hFont = OS.SelectObject (hDC, hFont); RECT itemRect = item.getBounds (index, true, true, false, false, false, hDC); if (hFont != -1) OS.SelectObject (hDC, hFont); itemRight = itemRect.right; } columnWidth = Math.max (columnWidth, itemRight - headerRect.left); } tvItem.hItem = OS.SendMessage (hwnd, OS.TVM_GETNEXTITEM, OS.TVGN_NEXTVISIBLE, tvItem.hItem); } RECT rect = new RECT (); int flags = OS.DT_CALCRECT | OS.DT_NOPREFIX; char [] buffer = text.toCharArray (); OS.DrawText (hDC, buffer, buffer.length, rect, flags); int headerWidth = rect.right - rect.left + Tree.HEADER_MARGIN; if (OS.IsAppThemed ()) headerWidth += Tree.HEADER_EXTRA; if (image != null || parent.sortColumn == this) { Image headerImage = null; if (parent.sortColumn == this && parent.sortDirection != SWT.NONE) { headerWidth += Tree.SORT_WIDTH; } else { headerImage = image; } if (headerImage != null) { Rectangle bounds = headerImage.getBoundsInPixels (); headerWidth += bounds.width; } int margin = 0; if (hwndHeader != 0) { margin = (int)OS.SendMessage (hwndHeader, OS.HDM_GETBITMAPMARGIN, 0, 0); } else { margin = OS.GetSystemMetrics (OS.SM_CXEDGE) * 3; } headerWidth += margin * 2; } if (newFont != 0) OS.SelectObject (hDC, oldFont); OS.ReleaseDC (hwnd, hDC); int gridWidth = parent.linesVisible ? Tree.GRID_WIDTH : 0; setWidthInPixels (Math.max (headerWidth, columnWidth + gridWidth)); } @Override void releaseHandle () { super.releaseHandle (); parent = null; } @Override void releaseParent () { super.releaseParent (); if (parent.sortColumn == this) { parent.sortColumn = null; } } /** * Removes the listener from the collection of listeners who will * be notified when the control is moved or resized. * * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException * @exception SWTException * * @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 * @exception SWTException * * @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 */ 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); long hwndHeader = parent.hwndHeader; if (hwndHeader == 0) return; HDITEM hdItem = new HDITEM (); hdItem.mask = OS.HDI_FORMAT; OS.SendMessage (hwndHeader, OS.HDM_GETITEM, index, hdItem); hdItem.fmt &= ~OS.HDF_JUSTIFYMASK; if ((style & SWT.LEFT) == SWT.LEFT) hdItem.fmt |= OS.HDF_LEFT; if ((style & SWT.CENTER) == SWT.CENTER) hdItem.fmt |= OS.HDF_CENTER; if ((style & SWT.RIGHT) == SWT.RIGHT) hdItem.fmt |= OS.HDF_RIGHT; OS.SendMessage (hwndHeader, OS.HDM_SETITEM, index, hdItem); if (index != 0) { long hwnd = parent.handle; parent.forceResize (); RECT rect = new RECT (), headerRect = new RECT (); OS.GetClientRect (hwnd, rect); OS.SendMessage (hwndHeader, OS.HDM_GETITEMRECT, index, headerRect); rect.left = headerRect.left; rect.right = headerRect.right; OS.InvalidateRect (hwnd, rect, true); } } @Override public void setImage (Image image) { checkWidget(); if (image != null && image.isDisposed ()) { error (SWT.ERROR_INVALID_ARGUMENT); } super.setImage (image); if (parent.sortColumn != this || parent.sortDirection != SWT.NONE) { setImage (image, false, false); } } void setImage (Image image, boolean sort, boolean right) { int index = parent.indexOf (this); if (index == -1) return; long hwndHeader = parent.hwndHeader; if (hwndHeader == 0) return; HDITEM hdItem = new HDITEM (); hdItem.mask = OS.HDI_FORMAT | OS.HDI_IMAGE | OS.HDI_BITMAP; OS.SendMessage (hwndHeader, OS.HDM_GETITEM, index, hdItem); hdItem.fmt &= ~OS.HDF_BITMAP_ON_RIGHT; if (image != null) { if (sort) { hdItem.mask &= ~OS.HDI_IMAGE; hdItem.fmt &= ~OS.HDF_IMAGE; hdItem.fmt |= OS.HDF_BITMAP; hdItem.hbm = image.handle; } else { hdItem.mask &= ~OS.HDI_BITMAP; hdItem.fmt &= ~OS.HDF_BITMAP; hdItem.fmt |= OS.HDF_IMAGE; hdItem.iImage = parent.imageIndexHeader (image); } if (right) hdItem.fmt |= OS.HDF_BITMAP_ON_RIGHT; } else { hdItem.mask &= ~(OS.HDI_IMAGE | OS.HDI_BITMAP); hdItem.fmt &= ~(OS.HDF_IMAGE | OS.HDF_BITMAP); } OS.SendMessage (hwndHeader, OS.HDM_SETITEM, index, hdItem); } /** * 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 * * @see Tree#setColumnOrder(int[]) * @see Tree#getColumnOrder() * @see TreeColumn#getMoveable() * @see SWT#Move * * @since 3.2 */ public void setMoveable (boolean moveable) { checkWidget (); this.moveable = moveable; } /** * 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 */ public void setResizable (boolean resizable) { checkWidget (); this.resizable = resizable; } void setSortDirection (int direction) { long hwndHeader = parent.hwndHeader; if (hwndHeader != 0) { int index = parent.indexOf (this); if (index == -1) return; HDITEM hdItem = new HDITEM (); hdItem.mask = OS.HDI_FORMAT | OS.HDI_IMAGE; OS.SendMessage (hwndHeader, OS.HDM_GETITEM, index, hdItem); switch (direction) { case SWT.UP: hdItem.fmt &= ~(OS.HDF_IMAGE | OS.HDF_SORTDOWN); hdItem.fmt |= OS.HDF_SORTUP; if (image == null) hdItem.mask &= ~OS.HDI_IMAGE; break; case SWT.DOWN: hdItem.fmt &= ~(OS.HDF_IMAGE | OS.HDF_SORTUP); hdItem.fmt |= OS.HDF_SORTDOWN; if (image == null) hdItem.mask &= ~OS.HDI_IMAGE; break; case SWT.NONE: hdItem.fmt &= ~(OS.HDF_SORTUP | OS.HDF_SORTDOWN); if (image != null) { hdItem.fmt |= OS.HDF_IMAGE; hdItem.iImage = parent.imageIndexHeader (image); } else { hdItem.fmt &= ~OS.HDF_IMAGE; hdItem.mask &= ~OS.HDI_IMAGE; } break; } OS.SendMessage (hwndHeader, OS.HDM_SETITEM, index, hdItem); if (OS.IsAppThemed ()) { long hwnd = parent.handle; parent.forceResize (); RECT rect = new RECT (), headerRect = new RECT (); OS.GetClientRect (hwnd, rect); OS.SendMessage (hwndHeader, OS.HDM_GETITEMRECT, index, headerRect); rect.left = headerRect.left; rect.right = headerRect.right; OS.InvalidateRect (hwnd, rect, true); } } } @Override public void setText (String string) { checkWidget (); if (string == null) error (SWT.ERROR_NULL_ARGUMENT); if (string.equals (text)) return; int index = parent.indexOf (this); if (index == -1) return; super.setText (string); /* * Bug in Windows. When a column header contains a * mnemonic character, Windows does not measure the * text properly. This causes '...' to always appear * at the end of the text. The fix is to remove * mnemonic characters. */ long hHeap = OS.GetProcessHeap (); char [] buffer = fixMnemonic (string); int byteCount = buffer.length * TCHAR.sizeof; long pszText = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount); OS.MoveMemory (pszText, buffer, byteCount); long hwndHeader = parent.hwndHeader; if (hwndHeader == 0) return; HDITEM hdItem = new HDITEM (); hdItem.mask = OS.HDI_TEXT; hdItem.pszText = pszText; long result = OS.SendMessage (hwndHeader, OS.HDM_SETITEM, index, hdItem); if (pszText != 0) OS.HeapFree (hHeap, 0, pszText); if (result == 0) error (SWT.ERROR_CANNOT_SET_TEXT); } /** * 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 * * @since 3.2 */ public void setToolTipText (String string) { checkWidget(); toolTipText = string; long hwndHeaderToolTip = parent.headerToolTipHandle; if (hwndHeaderToolTip == 0) { parent.createHeaderToolTips (); parent.updateHeaderToolTips (); } } /** * Sets the width of the receiver. * * @param width the new width * * @exception SWTException */ public void setWidth (int width) { checkWidget (); setWidthInPixels(DPIUtil.autoScaleUp(width)); } void setWidthInPixels (int width) { if (width < 0) return; int index = parent.indexOf (this); if (index == -1) return; long hwndHeader = parent.hwndHeader; if (hwndHeader == 0) return; HDITEM hdItem = new HDITEM (); hdItem.mask = OS.HDI_WIDTH; hdItem.cxy = width; OS.SendMessage (hwndHeader, OS.HDM_SETITEM, index, hdItem); RECT headerRect = new RECT (); OS.SendMessage (hwndHeader, OS.HDM_GETITEMRECT, index, headerRect); parent.forceResize (); long hwnd = parent.handle; RECT rect = new RECT (); OS.GetClientRect (hwnd, rect); rect.left = headerRect.left; OS.InvalidateRect (hwnd, rect, true); parent.setScrollWidth (); } void updateToolTip (int index) { long hwndHeaderToolTip = parent.headerToolTipHandle; if (hwndHeaderToolTip != 0) { long hwndHeader = parent.hwndHeader; RECT rect = new RECT (); if (OS.SendMessage (hwndHeader, OS.HDM_GETITEMRECT, index, rect) != 0) { TOOLINFO lpti = new TOOLINFO (); lpti.cbSize = TOOLINFO.sizeof; lpti.hwnd = hwndHeader; lpti.uId = id; lpti.left = rect.left; lpti.top = rect.top; lpti.right = rect.right; lpti.bottom = rect.bottom; OS.SendMessage (hwndHeaderToolTip, OS.TTM_NEWTOOLRECT, 0, lpti); } } } }