/******************************************************************************* * Copyright (c) 2000, 2003 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.internal.win32.*; import org.eclipse.swt.*; import org.eclipse.swt.graphics.*; import org.eclipse.swt.events.*; /** * Instances of this class represent a selectable user interface object * that represents a button in a tool bar. *
*
Styles:
*
PUSH, CHECK, RADIO, SEPARATOR, DROP_DOWN
*
Events:
*
Selection
*
*

* Note: Only one of the styles CHECK, PUSH, RADIO, SEPARATOR and DROP_DOWN * may be specified. *

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

*/ public class ToolItem extends Item { ToolBar parent; Control control; String toolTipText; Image disabledImage, hotImage; Image disabledImage2; int id; /** * Constructs a new instance of this class given its parent * (which must be a ToolBar) 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#PUSH * @see SWT#CHECK * @see SWT#RADIO * @see SWT#SEPARATOR * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ public ToolItem (ToolBar parent, int style) { super (parent, checkStyle (style)); this.parent = parent; parent.createItem (this, parent.getItemCount ()); } /** * Constructs a new instance of this class given its parent * (which must be a ToolBar), 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 index to store the receiver in its parent * * @exception IllegalArgumentException * @exception SWTException * * @see SWT#PUSH * @see SWT#CHECK * @see SWT#RADIO * @see SWT#SEPARATOR * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ public ToolItem (ToolBar parent, int style, int index) { super (parent, checkStyle (style)); this.parent = parent; parent.createItem (this, index); } /** * Adds the listener to the collection of listeners who will * be notified when the control is selected, by sending * it one of the messages defined in the SelectionListener * interface. *

* When widgetSelected is called when the mouse is over the arrow portion of a drop-down tool, * the event object detail field contains the value SWT.ARROW. * widgetDefaultSelected is not called. *

* * @param listener the listener which should be notified * * @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.PUSH, SWT.CHECK, SWT.RADIO, SWT.SEPARATOR, SWT.DROP_DOWN, 0); } protected void checkSubclass () { if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS); } void click (boolean dropDown) { /* * In order to emulate all the processing that * happens when a mnemonic key is pressed, fake * a mouse press and release. This will ensure * that radio and pull down items are handled * properly. */ int hwnd = parent.handle; if (OS.GetKeyState (OS.VK_LBUTTON) < 0) return; int index = OS.SendMessage (hwnd, OS.TB_COMMANDTOINDEX, id, 0); RECT rect = new RECT (); OS.SendMessage (hwnd, OS.TB_GETITEMRECT, index, rect); int y = rect.top + (rect.bottom - rect.top) / 2; int lParam = (dropDown ? rect.right - 1 : rect.left) | (y << 16); int hotIndex = OS.SendMessage (hwnd, OS.TB_GETHOTITEM, 0, 0); OS.SendMessage (hwnd, OS.WM_LBUTTONDOWN, 0, lParam); OS.SendMessage (hwnd, OS.WM_LBUTTONUP, 0, lParam); if (hotIndex != -1) { OS.SendMessage (hwnd, OS.TB_SETHOTITEM, hotIndex, 0); } } Image createDisabledImage (Image image, Color color) { /* * In order to be consistent with the way that disabled * images appear in other places in the user interface, * use the SWT Graphics to create a disabled image instead * of calling DrawState(). */ return new Image (display, image, SWT.IMAGE_DISABLE); /* * This code is intentionally commented. */ // if (OS.IsWinCE) { // return new Image (display, image, SWT.IMAGE_DISABLE); // } // Rectangle rect = image.getBounds (); // Image disabled = new Image (display, rect); // GC gc = new GC (disabled); // gc.setBackground (color); // gc.fillRectangle (rect); // int hDC = gc.handle; // int hImage = image.handle; // int fuFlags = OS.DSS_DISABLED; // switch (image.type) { // case SWT.BITMAP: fuFlags |= OS.DST_BITMAP; break; // case SWT.ICON: fuFlags |= OS.DST_ICON; break; // } // OS.DrawState (hDC, 0, 0, hImage, 0, 0, 0, rect.width, rect.height, fuFlags); // gc.dispose (); // return disabled; } /** * Returns a rectangle describing the receiver's size and location * relative to its parent. * * @return the receiver's bounding rectangle * * @exception SWTException */ public Rectangle getBounds () { checkWidget(); int hwnd = parent.handle; int index = OS.SendMessage (hwnd, OS.TB_COMMANDTOINDEX, id, 0); RECT rect = new RECT (); OS.SendMessage (hwnd, OS.TB_GETITEMRECT, index, rect); int width = rect.right - rect.left; int height = rect.bottom - rect.top; return new Rectangle (rect.left, rect.top, width, height); } /** * Returns the control that is used to fill the bounds of * the item when the items is a SEPARATOR. * * @return the control * * @exception SWTException */ public Control getControl () { checkWidget(); return control; } /** * Returns the receiver's disabled image if it has one, or null * if it does not. *

* The disabled image is displayed when the receiver is disabled. *

* * @return the receiver's disabled image * * @exception SWTException */ public Image getDisabledImage () { checkWidget(); return disabledImage; } /** * Returns true if the receiver is enabled, and * false otherwise. A disabled control is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * * @return the receiver's enabled state * * @exception SWTException * * @see #isEnabled */ public boolean getEnabled () { checkWidget(); int hwnd = parent.handle; int fsState = OS.SendMessage (hwnd, OS.TB_GETSTATE, id, 0); return (fsState & OS.TBSTATE_ENABLED) != 0; } /** * Returns the receiver's hot image if it has one, or null * if it does not. *

* The hot image is displayed when the mouse enters the receiver. *

* * @return the receiver's hot image * * @exception SWTException */ public Image getHotImage () { checkWidget(); return hotImage; } /** * Returns the receiver's parent, which must be a ToolBar. * * @return the receiver's parent * * @exception SWTException */ public ToolBar getParent () { checkWidget(); return parent; } /** * Returns true if the receiver is selected, * and false otherwise. *

* When the receiver is of type CHECK or RADIO, * it is selected when it is checked (which some platforms draw as a * pushed in button). If the receiver is of any other type, this method * returns false. *

* * @return the selection state * * @exception SWTException */ public boolean getSelection () { checkWidget(); if ((style & (SWT.CHECK | SWT.RADIO)) == 0) return false; int hwnd = parent.handle; int fsState = OS.SendMessage (hwnd, OS.TB_GETSTATE, id, 0); return (fsState & OS.TBSTATE_CHECKED) != 0; } /** * Returns the receiver's tool tip text, or null if it has not been set. * * @return the receiver's tool tip text * * @exception SWTException */ public String getToolTipText () { checkWidget(); return toolTipText; } /** * Gets the width of the receiver. * * @return the width * * @exception SWTException */ public int getWidth () { checkWidget(); int hwnd = parent.handle; int index = OS.SendMessage (hwnd, OS.TB_COMMANDTOINDEX, id, 0); RECT rect = new RECT (); OS.SendMessage (hwnd, OS.TB_GETITEMRECT, index, rect); return rect.right - rect.left; } /** * Returns true if the receiver is enabled and all * of the receiver's ancestors are enabled, and false * otherwise. A disabled control is typically not selectable from the * user interface and draws with an inactive or "grayed" look. * * @return the receiver's enabled state * * @exception SWTException * * @see #getEnabled */ public boolean isEnabled () { checkWidget(); return getEnabled () && parent.isEnabled (); } void releaseChild () { super.releaseChild (); parent.destroyItem (this); } void releaseWidget () { super.releaseWidget (); parent = null; control = null; toolTipText = null; disabledImage = hotImage = null; if (disabledImage2 != null) disabledImage2.dispose (); disabledImage2 = null; } void releaseImages () { TBBUTTONINFO info = new TBBUTTONINFO (); info.cbSize = TBBUTTONINFO.sizeof; info.dwMask = OS.TBIF_IMAGE | OS.TBIF_STYLE; int hwnd = parent.handle; OS.SendMessage (hwnd, OS.TB_GETBUTTONINFO, id, info); /* * Feature in Windows. For some reason, a tool item that has * the style BTNS_SEP does not return I_IMAGENONE when queried * for an image index, despite the fact that no attempt has been * made to assign an image to the item. As a result, operations * on an image list that use the wrong index cause random results. * The fix is to ensure that the tool item is not a separator * before using the image index. Since separators cannot have * an image and one is never assigned, this is not a problem. */ if ((info.fsStyle & OS.BTNS_SEP) == 0 && info.iImage != OS.I_IMAGENONE) { ImageList imageList = parent.getImageList (); ImageList hotImageList = parent.getHotImageList (); ImageList disabledImageList = parent.getDisabledImageList(); if (imageList != null) imageList.put (info.iImage, null); if (hotImageList != null) hotImageList.put (info.iImage, null); if (disabledImageList != null) disabledImageList.put (info.iImage, null); } } /** * Removes the listener from the collection of listeners who will * be notified when the control is selected. * * @param listener the listener which should 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); } void resizeControl () { if (control != null && !control.isDisposed ()) { /* * Set the size and location of the control * separately to minimize flashing in the * case where the control does not resize * to the size that was requested. This * case can occur when the control is a * combo box. */ Rectangle itemRect = getBounds (); control.setSize (itemRect.width, itemRect.height); Rectangle rect = control.getBounds (); rect.x = itemRect.x + (itemRect.width - rect.width) / 2; rect.y = itemRect.y + (itemRect.height - rect.height) / 2; control.setLocation (rect.x, rect.y); } } void selectRadio () { int index = 0; ToolItem [] items = parent.getItems (); while (index < items.length && items [index] != this) index++; int i = index - 1; while (i >= 0 && items [i].setRadioSelection (false)) --i; int j = index + 1; while (j < items.length && items [j].setRadioSelection (false)) j++; setSelection (true); } /** * Sets the control that is used to fill the bounds of * the item when the items is a SEPARATOR. * * @param control the new control * * @exception IllegalArgumentException * @exception SWTException */ 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 ((style & SWT.SEPARATOR) == 0) return; this.control = control; resizeControl (); } /** * Enables the receiver if the argument is true, * and disables it otherwise. *

* A disabled control is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. *

* * @param enabled the new enabled state * * @exception SWTException */ public void setEnabled (boolean enabled) { checkWidget(); int hwnd = parent.handle; int fsState = OS.SendMessage (hwnd, OS.TB_GETSTATE, id, 0); fsState &= ~OS.TBSTATE_ENABLED; if (enabled) fsState |= OS.TBSTATE_ENABLED; OS.SendMessage (hwnd, OS.TB_SETSTATE, id, fsState); if (image != null) updateImages (); } /** * Sets the receiver's disabled image to the argument, which may be * null indicating that no disabled image should be displayed. *

* The disbled image is displayed when the receiver is disabled. *

* * @param image the disabled image to display on the receiver (may be null) * * @exception IllegalArgumentException * @exception SWTException */ public void setDisabledImage (Image image) { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return; if (image != null && image.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT); disabledImage = image; updateImages (); } /** * Sets the receiver's hot image to the argument, which may be * null indicating that no hot image should be displayed. *

* The hot image is displayed when the mouse enters the receiver. *

* * @param image the hot image to display on the receiver (may be null) * * @exception IllegalArgumentException * @exception SWTException */ public void setHotImage (Image image) { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return; if (image != null && image.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT); hotImage = image; updateImages (); } public void setImage (Image image) { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return; if (image != null && image.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT); super.setImage (image); updateImages (); } boolean setRadioSelection (boolean value) { if ((style & SWT.RADIO) == 0) return false; if (getSelection () != value) { setSelection (value); postEvent (SWT.Selection); } return true; } /** * Sets the selection state of the receiver. *

* When the receiver is of type CHECK or RADIO, * it is selected when it is checked (which some platforms draw as a * pushed in button). *

* * @param selected the new selection state * * @exception SWTException */ public void setSelection (boolean selected) { checkWidget(); if ((style & (SWT.CHECK | SWT.RADIO)) == 0) return; int hwnd = parent.handle; int fsState = OS.SendMessage (hwnd, OS.TB_GETSTATE, id, 0); fsState &= ~OS.TBSTATE_CHECKED; if (selected) fsState |= OS.TBSTATE_CHECKED; OS.SendMessage (hwnd, OS.TB_SETSTATE, id, fsState); } /** * Sets the receiver's text. The string may include * the mnemonic character. *

*

* 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. *

* * @param string the new text * * @exception IllegalArgumentException * @exception SWTException */ public void setText (String string) { checkWidget(); if (string == null) error (SWT.ERROR_NULL_ARGUMENT); if ((style & SWT.SEPARATOR) != 0) return; super.setText (string); int hwnd = parent.handle; int hHeap = OS.GetProcessHeap (); TCHAR buffer = new TCHAR (parent.getCodePage (), string, true); int byteCount = buffer.length () * TCHAR.sizeof; int pszText = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount); OS.MoveMemory (pszText, buffer, byteCount); TBBUTTONINFO info = new TBBUTTONINFO (); info.cbSize = TBBUTTONINFO.sizeof; info.dwMask = OS.TBIF_TEXT | OS.TBIF_STYLE; info.pszText = pszText; info.fsStyle = (byte) (widgetStyle () | OS.BTNS_AUTOSIZE); if (string.length () != 0) info.fsStyle |= OS.BTNS_SHOWTEXT; OS.SendMessage (hwnd, OS.TB_SETBUTTONINFO, id, info); OS.HeapFree (hHeap, 0, pszText); /* * Bug in Windows. For some reason, when the font is set * before any tool item has text, the tool items resize to * a very small size. Also, a tool item will only show text * when text has already been set on one item and then a new * item is created. The fix is to use WM_SETFONT to force * the tool bar to redraw and layout. [1G0G7TV, 1G0FUJ5] */ int hFont = OS.SendMessage (hwnd, OS.WM_GETFONT, 0, 0); OS.SendMessage (hwnd, OS.WM_SETFONT, hFont, 0); parent.layoutItems (); } /** * Sets the receiver's tool tip text to the argument, which * may be null indicating that no tool tip text should be shown. * * @param string the new tool tip text (or null) * * @exception SWTException */ public void setToolTipText (String string) { checkWidget(); toolTipText = string; } /** * Sets the width of the receiver. * * @param width the new width * * @exception SWTException */ public void setWidth (int width) { checkWidget(); if ((style & SWT.SEPARATOR) == 0) return; if (width < 0) return; int hwnd = parent.handle; TBBUTTONINFO info = new TBBUTTONINFO (); info.cbSize = TBBUTTONINFO.sizeof; info.dwMask = OS.TBIF_SIZE; info.cx = (short) width; OS.SendMessage (hwnd, OS.TB_SETBUTTONINFO, id, info); parent.layoutItems (); } void updateImages () { int hwnd = parent.handle; TBBUTTONINFO info = new TBBUTTONINFO (); info.cbSize = TBBUTTONINFO.sizeof; info.dwMask = OS.TBIF_IMAGE; OS.SendMessage (hwnd, OS.TB_GETBUTTONINFO, id, info); if (info.iImage == OS.I_IMAGENONE && image == null) return; ImageList imageList = parent.getImageList (); ImageList hotImageList = parent.getHotImageList (); ImageList disabledImageList = parent.getDisabledImageList(); if (info.iImage == OS.I_IMAGENONE) { Rectangle bounds = image.getBounds (); Point size = new Point (bounds.width, bounds.height); if (imageList == null) imageList = display.getToolImageList (size); info.iImage = imageList.add (image); parent.setImageList (imageList); if (disabledImageList == null) disabledImageList = display.getToolDisabledImageList (size); Image disabled = disabledImage; if (disabledImage == null) { if (disabledImage2 != null) disabledImage2.dispose (); disabledImage2 = null; disabled = image; if (!getEnabled ()) { Color color = parent.getBackground (); disabled = disabledImage2 = createDisabledImage (image, color); } } disabledImageList.add (disabled); parent.setDisabledImageList (disabledImageList); // if ((parent.style & SWT.FLAT) != 0) { if (hotImageList == null) hotImageList = display.getToolHotImageList (size); hotImageList.add (hotImage != null ? hotImage : image); parent.setHotImageList (hotImageList); // } } else { if (imageList != null) imageList.put (info.iImage, image); if (disabledImageList != null) { Image disabled = null; if (image != null) { if (disabledImage2 != null) disabledImage2.dispose (); disabledImage2 = null; disabled = disabledImage; if (disabledImage == null) { disabled = image; if (!getEnabled ()) { Color color = parent.getBackground (); disabled = disabledImage2 = createDisabledImage (image, color); } } } disabledImageList.put (info.iImage, disabled); } if (hotImageList != null) { Image hot = null; if (image != null) hot = hotImage != null ? hotImage : image; hotImageList.put (info.iImage, hot); } if (image == null) info.iImage = OS.I_IMAGENONE; } OS.SendMessage (hwnd, OS.TB_SETBUTTONINFO, id, info); parent.layoutItems (); } int widgetStyle () { if ((style & SWT.DROP_DOWN) != 0) return OS.BTNS_DROPDOWN; if ((style & SWT.PUSH) != 0) return OS.BTNS_BUTTON; if ((style & SWT.CHECK) != 0) return OS.BTNS_CHECK; /* * This code is intentionally commented. In order to * consistently support radio tool items across platforms, * the platform radio behavior is not used. */ // if ((style & SWT.RADIO) != 0) return OS.BTNS_CHECKGROUP; if ((style & SWT.RADIO) != 0) return OS.BTNS_CHECK; if ((style & SWT.SEPARATOR) != 0) return OS.BTNS_SEP; return OS.BTNS_BUTTON; } LRESULT wmCommandChild (int wParam, int lParam) { if ((style & SWT.RADIO) != 0) { if ((parent.getStyle () & SWT.NO_RADIO_GROUP) == 0) { selectRadio (); } } postEvent (SWT.Selection); return null; } }