| /******************************************************************************* |
| * 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.graphics.*; |
| import org.eclipse.swt.internal.*; |
| import org.eclipse.swt.internal.win32.*; |
| |
| /** |
| * Instances of this class represent a selectable user interface object |
| * corresponding to a tab for a page in a tab folder. |
| * <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/#tabfolder">TabFolder, TabItem 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 TabItem extends Item { |
| TabFolder parent; |
| Control control; |
| String toolTipText; |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * (which must be a <code>TabFolder</code>) and a style value |
| * describing its behavior and appearance. The item is added |
| * to the end of the items maintained by its parent. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p> |
| * |
| * @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 <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 TabItem (TabFolder parent, int style) { |
| super (parent, style); |
| this.parent = parent; |
| parent.createItem (this, parent.getItemCount ()); |
| } |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * (which must be a <code>TabFolder</code>), a style value |
| * describing its behavior and appearance, and the index |
| * at which to place it in the items maintained by its parent. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p> |
| * |
| * @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 <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 |
| */ |
| public TabItem (TabFolder parent, int style, int index) { |
| super (parent, style); |
| this.parent = parent; |
| parent.createItem (this, index); |
| } |
| |
| void _setText (int index, String string) { |
| /* |
| * Bug in Windows. In version 6.00 of COMCTL32.DLL, tab |
| * items with an image and a label that includes '&' cause |
| * the tab to draw incorrectly (even when doubled '&&'). |
| * The image overlaps the label. The fix is to remove |
| * all '&' characters from the string. |
| */ |
| if (image != null) { |
| if (string.indexOf ('&') != -1) { |
| int length = string.length (); |
| char[] text = new char [length]; |
| string.getChars ( 0, length, text, 0); |
| int i = 0, j = 0; |
| for (i=0; i<length; i++) { |
| if (text[i] != '&') text [j++] = text [i]; |
| } |
| if (j < i) string = new String (text, 0, j); |
| } |
| } |
| long hwnd = parent.handle; |
| long hHeap = OS.GetProcessHeap (); |
| TCHAR buffer = new TCHAR (parent.getCodePage (), string, true); |
| int byteCount = buffer.length () * TCHAR.sizeof; |
| long pszText = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount); |
| OS.MoveMemory (pszText, buffer, byteCount); |
| TCITEM tcItem = new TCITEM (); |
| tcItem.mask = OS.TCIF_TEXT; |
| tcItem.pszText = pszText; |
| OS.SendMessage (hwnd, OS.TCM_SETITEM, index, tcItem); |
| OS.HeapFree (hHeap, 0, pszText); |
| } |
| |
| @Override |
| protected void checkSubclass () { |
| if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); |
| } |
| |
| @Override |
| void destroyWidget () { |
| parent.destroyItem (this); |
| releaseHandle (); |
| } |
| |
| /** |
| * Returns the control that is used to fill the client area of |
| * the tab folder when the user selects the tab item. If no |
| * control has been set, return <code>null</code>. |
| * <p> |
| * @return the control |
| * |
| * @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 Control getControl () { |
| checkWidget(); |
| return control; |
| } |
| |
| /** |
| * Returns a rectangle describing the receiver's size and location |
| * relative to its parent. |
| * |
| * @return the receiver's bounding 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.4 |
| */ |
| public Rectangle getBounds () { |
| checkWidget(); |
| return DPIUtil.autoScaleDown(getBoundsInPixels()); |
| } |
| |
| Rectangle getBoundsInPixels() { |
| int index = parent.indexOf(this); |
| if (index == -1) return new Rectangle (0, 0, 0, 0); |
| RECT itemRect = new RECT (); |
| OS.SendMessage (parent.handle, OS.TCM_GETITEMRECT, index, itemRect); |
| return new Rectangle(itemRect.left, itemRect.top, itemRect.right - itemRect.left, itemRect.bottom - itemRect.top); |
| } |
| |
| /** |
| * Returns the receiver's parent, which must be a <code>TabFolder</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 TabFolder getParent () { |
| checkWidget(); |
| return parent; |
| } |
| |
| /** |
| * Returns the receiver's tool tip text, or null if it has |
| * not been set. |
| * |
| * @return the receiver's tool tip 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 String getToolTipText () { |
| checkWidget(); |
| return toolTipText; |
| } |
| |
| @Override |
| void releaseHandle () { |
| super.releaseHandle (); |
| parent = null; |
| } |
| |
| @Override |
| void releaseParent () { |
| super.releaseParent (); |
| int index = parent.indexOf (this); |
| if (index == parent.getSelectionIndex ()) { |
| if (control != null) control.setVisible (false); |
| } |
| } |
| |
| @Override |
| void releaseWidget () { |
| super.releaseWidget (); |
| control = null; |
| } |
| |
| /** |
| * Sets the control that is used to fill the client area of |
| * the tab folder when the user selects the tab item. |
| * <p> |
| * @param control the new control (or null) |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_INVALID_ARGUMENT - if the control has been disposed</li> |
| * <li>ERROR_INVALID_PARENT - if the control is not in the same widget tree</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> |
| */ |
| public void setControl (Control control) { |
| checkWidget(); |
| if (control != null) { |
| if (control.isDisposed()) error (SWT.ERROR_INVALID_ARGUMENT); |
| if (control.parent != parent) error (SWT.ERROR_INVALID_PARENT); |
| } |
| if (this.control != null && this.control.isDisposed ()) { |
| this.control = null; |
| } |
| Control oldControl = this.control, newControl = control; |
| this.control = control; |
| int index = parent.indexOf (this), selectionIndex = parent.getSelectionIndex(); |
| if (index != selectionIndex) { |
| if (newControl != null) { |
| if (selectionIndex != -1) { |
| Control selectedControl = parent.getItem(selectionIndex).getControl(); |
| if (selectedControl == newControl) return; |
| } |
| newControl.setVisible(false); |
| return; |
| } |
| } |
| if (newControl != null) { |
| newControl.setBounds (parent.getClientAreaInPixels ()); |
| newControl.setVisible (true); |
| } |
| if (oldControl != null && newControl != null && oldControl != newControl) |
| oldControl.setVisible (false); |
| } |
| |
| @Override |
| public void setImage (Image image) { |
| checkWidget(); |
| int index = parent.indexOf (this); |
| if (index == -1) return; |
| super.setImage (image); |
| /* |
| * Bug in Windows. In version 6.00 of COMCTL32.DLL, tab |
| * items with an image and a label that includes '&' cause |
| * the tab to draw incorrectly (even when doubled '&&'). |
| * The image overlaps the label. The fix is to remove |
| * all '&' characters from the string and set the text |
| * whenever the image or text is changed. |
| */ |
| if (text.indexOf ('&') != -1) _setText (index, text); |
| long hwnd = parent.handle; |
| TCITEM tcItem = new TCITEM (); |
| tcItem.mask = OS.TCIF_IMAGE; |
| tcItem.iImage = parent.imageIndex (image); |
| OS.SendMessage (hwnd, OS.TCM_SETITEM, index, tcItem); |
| } |
| /** |
| * Sets the receiver's text. The string may include |
| * the mnemonic character. |
| * <p> |
| * Mnemonics are indicated by an '&' that causes the next |
| * character to be the mnemonic. When the user presses a |
| * key sequence that matches the mnemonic, a selection |
| * event occurs. On most platforms, the mnemonic appears |
| * underlined but may be emphasised in a platform specific |
| * manner. The mnemonic indicator character '&' can be |
| * escaped by doubling it in the string, causing a single |
| * '&' to be displayed. |
| * </p> |
| * |
| * @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> |
| * |
| */ |
| @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); |
| /* |
| * Need to update direction since it is set via UCC which the new text |
| * overrides |
| */ |
| int textDirection = (state & HAS_AUTO_DIRECTION) != 0 ? AUTO_TEXT_DIRECTION : style & SWT.FLIP_TEXT_DIRECTION; |
| if (!updateTextDirection (textDirection)) { |
| _setText (index, string); |
| } |
| } |
| |
| @Override |
| boolean updateTextDirection(int textDirection) { |
| /* AUTO is handled by super */ |
| if (super.updateTextDirection(textDirection)) { |
| int index = parent.indexOf (this); |
| if (index != -1) { |
| if ((textDirection & SWT.RIGHT_TO_LEFT) != 0) { |
| _setText(index, RLE + text); |
| return true; |
| } else if ((textDirection & SWT.LEFT_TO_RIGHT) != 0) { |
| _setText(index, LRE + text); |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * 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. |
| * <p> |
| * 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. |
| * </p> |
| * <p> |
| * 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. |
| * </p> |
| * |
| * @param string the new tool tip text (or null) |
| * |
| * @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 setToolTipText (String string) { |
| checkWidget(); |
| toolTipText = string; |
| } |
| |
| } |