/******************************************************************************* * Copyright (c) 2000, 2011 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.internal.*; import org.eclipse.swt.internal.win32.*; import org.eclipse.swt.*; import org.eclipse.swt.graphics.*; import org.eclipse.swt.events.*; /** * Instances of this class are user interface objects that contain * menu items. *
*
Styles:
*
BAR, DROP_DOWN, POP_UP, NO_RADIO_GROUP
*
LEFT_TO_RIGHT, RIGHT_TO_LEFT
*
Events:
*
Help, Hide, Show
*
*

* Note: Only one of BAR, DROP_DOWN and POP_UP may be specified. * Only one of LEFT_TO_RIGHT or RIGHT_TO_LEFT may be specified. *

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

* * @see Menu snippets * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class Menu extends Widget { /** * the handle to the OS resource * (Warning: This field is platform dependent) *

* IMPORTANT: This field is not part of the SWT * public API. It is marked public only so that it can be shared * within the packages provided by SWT. It is not available on all * platforms and should never be accessed from application code. *

* * @noreference This field is not intended to be referenced by clients. */ public int /*long*/ handle; int x, y; int /*long*/ hBrush, hwndCB; int id0, id1; int foreground = -1, background = -1; Image backgroundImage; boolean hasLocation; MenuItem cascade; Decorations parent; ImageList imageList; /* Resource ID for SHMENUBARINFO */ static final int ID_PPC = 100; /* SmartPhone SoftKeyBar resource ids */ static final int ID_SPMM = 102; static final int ID_SPBM = 103; static final int ID_SPMB = 104; static final int ID_SPBB = 105; static final int ID_SPSOFTKEY0 = 106; static final int ID_SPSOFTKEY1 = 107; /** * Constructs a new instance of this class given its parent, * and sets the style for the instance so that the instance * will be a popup menu on the given parent's shell. *

* After constructing a menu, it can be set into its parent * using parent.setMenu(menu). In this case, the parent may * be any control in the same widget tree as the parent. *

* * @param parent a control which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentException * @exception SWTException * * @see SWT#POP_UP * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (Control parent) { this (checkNull (parent).menuShell (), SWT.POP_UP); } /** * Constructs a new instance of this class given its parent * (which must be a Decorations) and a style value * describing its behavior and appearance. *

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

* After constructing a menu or menuBar, it can be set into its parent * using parent.setMenu(menu) or parent.setMenuBar(menuBar). *

* * @param parent a decorations control which will be the parent of the new instance (cannot be null) * @param style the style of menu to construct * * @exception IllegalArgumentException * @exception SWTException * * @see SWT#BAR * @see SWT#DROP_DOWN * @see SWT#POP_UP * @see SWT#NO_RADIO_GROUP * @see SWT#LEFT_TO_RIGHT * @see SWT#RIGHT_TO_LEFT * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (Decorations parent, int style) { this (parent, checkStyle (style), 0); } /** * Constructs a new instance of this class given its parent * (which must be a Menu) and sets the style * for the instance so that the instance will be a drop-down * menu on the given parent's parent. *

* After constructing a drop-down menu, it can be set into its parentMenu * using parentMenu.setMenu(menu). *

* * @param parentMenu a menu which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentException * @exception SWTException * * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (Menu parentMenu) { this (checkNull (parentMenu).parent, SWT.DROP_DOWN); } /** * Constructs a new instance of this class given its parent * (which must be a MenuItem) and sets the style * for the instance so that the instance will be a drop-down * menu on the given parent's parent menu. *

* After constructing a drop-down menu, it can be set into its parentItem * using parentItem.setMenu(menu). *

* * @param parentItem a menu item which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentException * @exception SWTException * * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (MenuItem parentItem) { this (checkNull (parentItem).parent); } Menu (Decorations parent, int style, int /*long*/ handle) { super (parent, checkStyle (style)); this.parent = parent; this.handle = handle; /* * Bug in IBM JVM 1.3.1. For some reason, when the checkOrientation() is * called from createWidget(), the JVM issues this error: * * JVM Exception 0x2 (subcode 0x0) occurred in thread "main" (TID:0x9F19D8) * * In addition, on Windows XP, a dialog appears with following error message, * indicating that the problem may be in the JIT: * * AppName: java.exe AppVer: 0.0.0.0 ModName: jitc.dll * ModVer: 0.0.0.0 Offset: 000b6912 * * The fix is to call checkOrientation() from here. */ checkOrientation (parent); createWidget (); } void _setVisible (boolean visible) { if ((style & (SWT.BAR | SWT.DROP_DOWN)) != 0) return; int /*long*/ hwndParent = parent.handle; if (visible) { int flags = OS.TPM_LEFTBUTTON; if (OS.GetKeyState (OS.VK_LBUTTON) >= 0) flags |= OS.TPM_RIGHTBUTTON; if ((style & SWT.RIGHT_TO_LEFT) != 0) flags |= OS.TPM_RIGHTALIGN; if ((parent.style & SWT.MIRRORED) != 0) { flags &= ~OS.TPM_RIGHTALIGN; if ((style & SWT.LEFT_TO_RIGHT) != 0) flags |= OS.TPM_RIGHTALIGN; } int nX = x, nY = y; if (!hasLocation) { int pos = OS.GetMessagePos (); nX = OS.GET_X_LPARAM (pos); nY = OS.GET_Y_LPARAM (pos); } /* * Feature in Windows. It is legal use TrackPopupMenu() * to display an empty menu as long as menu items are added * inside of WM_INITPOPUPMENU. If no items are added, then * TrackPopupMenu() fails and does not send an indication * that the menu has been closed. This is not strictly a * bug but leads to unwanted behavior when application code * assumes that every WM_INITPOPUPMENU will eventually result * in a WM_MENUSELECT, wParam=MAKEWPARAM (0, 0xFFFF), lParam=0 to * indicate that the menu has been closed. The fix is to detect * the case when TrackPopupMenu() fails and the number of items in * the menu is zero and issue a fake WM_MENUSELECT. */ boolean success = OS.TrackPopupMenu (handle, flags, nX, nY, 0, hwndParent, null); if (!success && GetMenuItemCount (handle) == 0) { OS.SendMessage (hwndParent, OS.WM_MENUSELECT, OS.MAKEWPARAM (0, 0xFFFF), 0); } } else { OS.SendMessage (hwndParent, OS.WM_CANCELMODE, 0, 0); } } /** * Adds the listener to the collection of listeners who will * be notified when help events are generated for the control, * by sending it one of the messages defined in the * HelpListener interface. * * @param listener the listener which should be notified * * @exception IllegalArgumentException * @exception SWTException * * @see HelpListener * @see #removeHelpListener */ public void addHelpListener (HelpListener listener) { checkWidget (); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (SWT.Help, typedListener); } /** * Adds the listener to the collection of listeners who will * be notified when menus are hidden or shown, by sending it * one of the messages defined in the MenuListener * interface. * * @param listener the listener which should be notified * * @exception IllegalArgumentException * @exception SWTException * * @see MenuListener * @see #removeMenuListener */ public void addMenuListener (MenuListener listener) { checkWidget (); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (SWT.Hide,typedListener); addListener (SWT.Show,typedListener); } static Control checkNull (Control control) { if (control == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); return control; } static Menu checkNull (Menu menu) { if (menu == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); return menu; } static MenuItem checkNull (MenuItem item) { if (item == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); return item; } static int checkStyle (int style) { return checkBits (style, SWT.POP_UP, SWT.BAR, SWT.DROP_DOWN, 0, 0, 0); } void createHandle () { if (handle != 0) return; if ((style & SWT.BAR) != 0) { if (OS.IsPPC) { int /*long*/ hwndShell = parent.handle; SHMENUBARINFO mbi = new SHMENUBARINFO (); mbi.cbSize = SHMENUBARINFO.sizeof; mbi.hwndParent = hwndShell; mbi.dwFlags = OS.SHCMBF_HIDDEN; mbi.nToolBarId = ID_PPC; mbi.hInstRes = OS.GetLibraryHandle (); boolean success = OS.SHCreateMenuBar (mbi); hwndCB = mbi.hwndMB; if (!success) error (SWT.ERROR_NO_HANDLES); /* Remove the item from the resource file */ OS.SendMessage (hwndCB, OS.TB_DELETEBUTTON, 0, 0); return; } /* * Note in WinCE SmartPhone. The SoftBar contains only 2 items. * An item can either be a menu or a button. * SWT.BAR: creates a SoftBar with 2 menus * SWT.BAR | SWT.BUTTON1: creates a SoftBar with 1 button * for button1, and a menu for button2 * SWT.BAR | SWT.BUTTON1 | SWT.BUTTON2: creates a SoftBar with * 2 buttons */ if (OS.IsSP) { /* Determine type of menubar */ int nToolBarId; if ((style & SWT.BUTTON1) != 0) { nToolBarId = ((style & SWT.BUTTON2) != 0) ? ID_SPBB : ID_SPBM; } else { nToolBarId = ((style & SWT.BUTTON2) != 0) ? ID_SPMB : ID_SPMM; } /* Create SHMENUBAR */ SHMENUBARINFO mbi = new SHMENUBARINFO (); mbi.cbSize = SHMENUBARINFO.sizeof; mbi.hwndParent = parent.handle; mbi.dwFlags = OS.SHCMBF_HIDDEN; mbi.nToolBarId = nToolBarId; /* as defined in .rc file */ mbi.hInstRes = OS.GetLibraryHandle (); if (!OS.SHCreateMenuBar (mbi)) error (SWT.ERROR_NO_HANDLES); hwndCB = mbi.hwndMB; /* * Feature on WinCE SmartPhone. The SHCMBF_HIDDEN flag causes the * SHMENUBAR to not be drawn. However the keyboard events still go * through it. The workaround is to also hide the SHMENUBAR with * ShowWindow (). */ OS.ShowWindow (hwndCB, OS.SW_HIDE); TBBUTTONINFO info = new TBBUTTONINFO (); info.cbSize = TBBUTTONINFO.sizeof; info.dwMask = OS.TBIF_COMMAND; MenuItem item; /* Set first item */ if (nToolBarId == ID_SPMM || nToolBarId == ID_SPMB) { int /*long*/ hMenu = OS.SendMessage (hwndCB, OS.SHCMBM_GETSUBMENU, 0, ID_SPSOFTKEY0); /* Remove the item from the resource file */ OS.RemoveMenu (hMenu, 0, OS.MF_BYPOSITION); Menu menu = new Menu (parent, SWT.DROP_DOWN, hMenu); item = new MenuItem (this, menu, SWT.CASCADE, 0); } else { item = new MenuItem (this, null, SWT.PUSH, 0); } info.idCommand = id0 = item.id; OS.SendMessage (hwndCB, OS.TB_SETBUTTONINFO, ID_SPSOFTKEY0, info); /* Set second item */ if (nToolBarId == ID_SPMM || nToolBarId == ID_SPBM) { int /*long*/ hMenu = OS.SendMessage (hwndCB, OS.SHCMBM_GETSUBMENU, 0, ID_SPSOFTKEY1); OS.RemoveMenu (hMenu, 0, OS.MF_BYPOSITION); Menu menu = new Menu (parent, SWT.DROP_DOWN, hMenu); item = new MenuItem (this, menu, SWT.CASCADE, 1); } else { item = new MenuItem (this, null, SWT.PUSH, 1); } info.idCommand = id1 = item.id; OS.SendMessage (hwndCB, OS.TB_SETBUTTONINFO, ID_SPSOFTKEY1, info); /* * Override the Back key. For some reason, the owner of the menubar * must be a Dialog or it won't receive the WM_HOTKEY message. As * a result, Shell on WinCE SP must use the class Dialog. */ int dwMask = OS.SHMBOF_NODEFAULT | OS.SHMBOF_NOTIFY; int /*long*/ lParam = OS.MAKELPARAM (dwMask, dwMask); OS.SendMessage (hwndCB, OS.SHCMBM_OVERRIDEKEY, OS.VK_ESCAPE, lParam); return; } handle = OS.CreateMenu (); if (handle == 0) error (SWT.ERROR_NO_HANDLES); if (OS.IsHPC) { int /*long*/ hwndShell = parent.handle; hwndCB = OS.CommandBar_Create (OS.GetModuleHandle (null), hwndShell, 1); if (hwndCB == 0) error (SWT.ERROR_NO_HANDLES); OS.CommandBar_Show (hwndCB, false); OS.CommandBar_InsertMenubarEx (hwndCB, 0, handle, 0); /* * The command bar hosts the 'close' button when the window does not * have a caption. */ if ((parent.style & SWT.CLOSE) != 0 && (parent.style & SWT.TITLE) == 0) { OS.CommandBar_AddAdornments (hwndCB, 0, 0); } } } else { handle = OS.CreatePopupMenu (); if (handle == 0) error (SWT.ERROR_NO_HANDLES); } } void createItem (MenuItem item, int index) { int count = GetMenuItemCount (handle); if (!(0 <= index && index <= count)) error (SWT.ERROR_INVALID_RANGE); display.addMenuItem (item); boolean success = false; if ((OS.IsPPC || OS.IsSP) && hwndCB != 0) { if (OS.IsSP) return; TBBUTTON lpButton = new TBBUTTON (); lpButton.idCommand = item.id; lpButton.fsStyle = (byte) OS.TBSTYLE_AUTOSIZE; if ((item.style & SWT.CASCADE) != 0) lpButton.fsStyle |= OS.TBSTYLE_DROPDOWN | 0x80; if ((item.style & SWT.SEPARATOR) != 0) lpButton.fsStyle = (byte) OS.BTNS_SEP; lpButton.fsState = (byte) OS.TBSTATE_ENABLED; lpButton.iBitmap = OS.I_IMAGENONE; success = OS.SendMessage (hwndCB, OS.TB_INSERTBUTTON, index, lpButton) != 0; } else { if (OS.IsWinCE) { int uFlags = OS.MF_BYPOSITION; TCHAR lpNewItem = null; if ((item.style & SWT.SEPARATOR) != 0) { uFlags |= OS.MF_SEPARATOR; } else { lpNewItem = new TCHAR (0, " ", true); } success = OS.InsertMenu (handle, index, uFlags, item.id, lpNewItem); if (success) { MENUITEMINFO info = new MENUITEMINFO (); info.cbSize = MENUITEMINFO.sizeof; info.fMask = OS.MIIM_DATA; info.dwItemData = item.id; success = OS.SetMenuItemInfo (handle, index, true, info); } } else { /* * Bug in Windows. For some reason, when InsertMenuItem() * is used to insert an item without text, it is not possible * to use SetMenuItemInfo() to set the text at a later time. * The fix is to insert the item with some text. * * Feature in Windows. When an empty string is used instead * of a space and InsertMenuItem() is used to set a submenu * before setting text to a non-empty string, the menu item * becomes unexpectedly disabled. The fix is to insert a * space. */ int /*long*/ hHeap = OS.GetProcessHeap (); TCHAR buffer = new TCHAR (0, " ", true); int byteCount = buffer.length () * TCHAR.sizeof; int /*long*/ pszText = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount); OS.MoveMemory (pszText, buffer, byteCount); MENUITEMINFO info = new MENUITEMINFO (); info.cbSize = MENUITEMINFO.sizeof; info.fMask = OS.MIIM_ID | OS.MIIM_TYPE | OS.MIIM_DATA; info.wID = item.id; info.dwItemData = item.id; info.fType = item.widgetStyle (); info.dwTypeData = pszText; success = OS.InsertMenuItem (handle, index, true, info); if (pszText != 0) OS.HeapFree (hHeap, 0, pszText); } } if (!success) { display.removeMenuItem (item); error (SWT.ERROR_ITEM_NOT_ADDED); } redraw (); } void createWidget () { /* * Bug in IBM JVM 1.3.1. For some reason, when the following code is called * from this method, the JVM issues this error: * * JVM Exception 0x2 (subcode 0x0) occurred in thread "main" (TID:0x9F19D8) * * In addition, on Windows XP, a dialog appears with following error message, * indicating that the problem may be in the JIT: * * AppName: java.exe AppVer: 0.0.0.0 ModName: jitc.dll * ModVer: 0.0.0.0 Offset: 000b6912 * * The fix is to move the code to the caller of this method. */ // checkOrientation (parent); createHandle (); parent.addMenu (this); } int defaultBackground () { return OS.GetSysColor (OS.COLOR_MENU); } int defaultForeground () { return OS.GetSysColor (OS.COLOR_MENUTEXT); } void destroyAccelerators () { parent.destroyAccelerators (); } void destroyItem (MenuItem item) { if (OS.IsWinCE) { if ((OS.IsPPC || OS.IsSP) && hwndCB != 0) { if (OS.IsSP) { redraw(); return; } int index = (int)/*64*/OS.SendMessage (hwndCB, OS.TB_COMMANDTOINDEX, item.id, 0); if (OS.SendMessage (hwndCB, OS.TB_DELETEBUTTON, index, 0) == 0) { error (SWT.ERROR_ITEM_NOT_REMOVED); } int count = (int)/*64*/OS.SendMessage (hwndCB, OS.TB_BUTTONCOUNT, 0, 0); if (count == 0) { if (imageList != null) { OS.SendMessage (handle, OS.TB_SETIMAGELIST, 0, 0); display.releaseImageList (imageList); imageList = null; } } } else { int index = 0; MENUITEMINFO info = new MENUITEMINFO (); info.cbSize = MENUITEMINFO.sizeof; info.fMask = OS.MIIM_DATA; while (OS.GetMenuItemInfo (handle, index, true, info)) { if (info.dwItemData == item.id) break; index++; } if (info.dwItemData != item.id) { error (SWT.ERROR_ITEM_NOT_REMOVED); } if (!OS.DeleteMenu (handle, index, OS.MF_BYPOSITION)) { error (SWT.ERROR_ITEM_NOT_REMOVED); } } } else { if (!OS.DeleteMenu (handle, item.id, OS.MF_BYCOMMAND)) { error (SWT.ERROR_ITEM_NOT_REMOVED); } } redraw (); } void destroyWidget () { MenuItem cascade = this.cascade; int /*long*/ hMenu = handle, hCB = hwndCB; releaseHandle (); if (OS.IsWinCE && hCB != 0) { OS.CommandBar_Destroy (hCB); } else { if (cascade != null) { if (!OS.IsSP) cascade.setMenu (null, true); } else { if (hMenu != 0) OS.DestroyMenu (hMenu); } } } void fixMenus (Decorations newParent) { MenuItem [] items = getItems (); 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
  • * * * @since 3.3 */ /*public*/ Color getBackground () { checkWidget (); return Color.win32_new (display, background != -1 ? background : defaultBackground ()); } /** * Returns the receiver's background image. * * @return the background image * * @exception SWTException * * @since 3.3 */ /*public*/ Image getBackgroundImage () { checkWidget (); return backgroundImage; } /** * Returns a rectangle describing the receiver's size and location * relative to its parent (or its display if its parent is null), * unless the receiver is a menu or a shell. In this case, the * location is relative to the display. *

    * Note that the bounds of a menu or menu item are undefined when * the menu is not visible. This is because most platforms compute * the bounds of a menu dynamically just before it is displayed. *

    * * @return the receiver's bounding rectangle * * @exception SWTException * * @since 3.1 */ /*public*/ Rectangle getBounds () { checkWidget (); if (OS.IsWinCE) return new Rectangle (0, 0, 0, 0); if ((style & SWT.BAR) != 0) { if (parent.menuBar != this) { return new Rectangle (0, 0, 0, 0); } int /*long*/ hwndShell = parent.handle; MENUBARINFO info = new MENUBARINFO (); info.cbSize = MENUBARINFO.sizeof; if (OS.GetMenuBarInfo (hwndShell, OS.OBJID_MENU, 0, info)) { int width = info.right - info.left; int height = info.bottom - info.top; return new Rectangle (info.left, info.top, width, height); } } else { int count = GetMenuItemCount (handle); if (count != 0) { RECT rect1 = new RECT (); if (OS.GetMenuItemRect (0, handle, 0, rect1)) { RECT rect2 = new RECT (); if (OS.GetMenuItemRect (0, handle, count - 1, rect2)) { int x = rect1.left - 2, y = rect1.top - 2; int width = (rect2.right - rect2.left) + 4; int height = (rect2.bottom - rect1.top) + 4; return new Rectangle (x, y, width, height); } } } } return new Rectangle (0, 0, 0, 0); } /** * Returns the default menu item or null if none has * been previously set. * * @return the default menu item. * * * @exception SWTException */ public MenuItem getDefaultItem () { checkWidget (); if (OS.IsWinCE) return null; int id = OS.GetMenuDefaultItem (handle, OS.MF_BYCOMMAND, OS.GMDI_USEDISABLED); if (id == -1) return null; MENUITEMINFO info = new MENUITEMINFO (); info.cbSize = MENUITEMINFO.sizeof; info.fMask = OS.MIIM_ID; if (OS.GetMenuItemInfo (handle, id, false, info)) { return display.getMenuItem (info.wID); } return null; } /** * Returns true if the receiver is enabled, and * false otherwise. A disabled menu 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 (); return (state & DISABLED) == 0; } /** * Returns the foreground color that the receiver will use to draw. * * @return the receiver's foreground color * * @exception SWTException */ /*public*/ Color getForeground () { checkWidget (); return Color.win32_new (display, foreground != -1 ? foreground : defaultForeground ()); } /** * Returns the item at the given, zero-relative index in the * receiver. Throws an exception if the index is out of range. * * @param index the index of the item to return * @return the item at the given index * * @exception IllegalArgumentException * @exception SWTException */ public MenuItem getItem (int index) { checkWidget (); int id = 0; if ((OS.IsPPC || OS.IsSP) && hwndCB != 0) { if (OS.IsPPC) { TBBUTTON lpButton = new TBBUTTON (); int /*long*/ result = OS.SendMessage (hwndCB, OS.TB_GETBUTTON, index, lpButton); if (result == 0) error (SWT.ERROR_CANNOT_GET_ITEM); id = lpButton.idCommand; } if (OS.IsSP) { if (!(0 <= index && index <= 1)) error (SWT.ERROR_CANNOT_GET_ITEM); id = index == 0 ? id0 : id1; } } else { MENUITEMINFO info = new MENUITEMINFO (); info.cbSize = MENUITEMINFO.sizeof; info.fMask = OS.MIIM_DATA; if (!OS.GetMenuItemInfo (handle, index, true, info)) { error (SWT.ERROR_INVALID_RANGE); } id = (int)/*64*/info.dwItemData; } return display.getMenuItem (id); } /** * Returns the number of items contained in the receiver. * * @return the number of items * * @exception SWTException */ public int getItemCount () { checkWidget (); return GetMenuItemCount (handle); } /** * Returns a (possibly empty) array of MenuItems which * are the items in the receiver. *

    * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will * not affect the receiver. *

    * * @return the items in the receiver * * @exception SWTException */ public MenuItem [] getItems () { checkWidget (); if ((OS.IsPPC || OS.IsSP) && hwndCB != 0) { if (OS.IsSP) { MenuItem [] result = new MenuItem [2]; result[0] = display.getMenuItem (id0); result[1] = display.getMenuItem (id1); return result; } int count = (int)/*64*/OS.SendMessage (hwndCB, OS.TB_BUTTONCOUNT, 0, 0); TBBUTTON lpButton = new TBBUTTON (); MenuItem [] result = new MenuItem [count]; for (int i=0; i 0) { for (int i=0; iSWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT. * * @return the orientation style * * @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.7 */ public int getOrientation () { checkWidget (); return style & (SWT.LEFT_TO_RIGHT | SWT.RIGHT_TO_LEFT); } /** * Returns the receiver's parent, which must be a Decorations. * * @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 Decorations getParent () { checkWidget (); return parent; } /** * Returns the receiver's parent item, which must be a * MenuItem or null when the receiver is a * root. * * @return the receiver's parent item * * @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 MenuItem getParentItem () { checkWidget (); return cascade; } /** * Returns the receiver's parent item, which must be a * Menu or null when the receiver is a * root. * * @return the receiver's parent item * * @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 Menu getParentMenu () { checkWidget (); if (cascade != null) return cascade.parent; return null; } /** * Returns the receiver's shell. For all controls other than * shells, this simply returns the control's nearest ancestor * shell. Shells return themselves, even if they are children * of other shells. * * @return the receiver's shell * * @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 #getParent */ public Shell getShell () { checkWidget (); return parent.getShell (); } /** * Returns true if the receiver is visible, and * false otherwise. *

    * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, this method * may still indicate that it is considered visible even though * it may not actually be showing. *

    * * @return the receiver's visibility state * * @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 getVisible () { checkWidget (); if ((style & SWT.BAR) != 0) { return this == parent.menuShell ().menuBar; } if ((style & SWT.POP_UP) != 0) { Menu [] popups = display.popups; if (popups == null) return false; for (int i=0; i *
  • ERROR_NULL_ARGUMENT - if the item 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 int indexOf (MenuItem item) { checkWidget (); if (item == null) error (SWT.ERROR_NULL_ARGUMENT); if (item.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT); if (item.parent != this) return -1; if ((OS.IsPPC || OS.IsSP) && hwndCB != 0) { if (OS.IsPPC) { return (int)/*64*/OS.SendMessage (hwndCB, OS.TB_COMMANDTOINDEX, item.id, 0); } if (OS.IsSP) { if (item.id == id0) return 0; if (item.id == id1) return 1; return -1; } } int index = 0; MENUITEMINFO info = new MENUITEMINFO (); info.cbSize = MENUITEMINFO.sizeof; info.fMask = OS.MIIM_DATA; while (OS.GetMenuItemInfo (handle, index, true, info)) { if (info.dwItemData == item.id) return index; index++; } return -1; } /** * Returns true if the receiver is enabled and all * of the receiver's ancestors are enabled, and false * otherwise. A disabled menu is typically not selectable from the * user interface and draws with an inactive or "grayed" look. * * @return the receiver's enabled state * * @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 #getEnabled */ public boolean isEnabled () { checkWidget (); Menu parentMenu = getParentMenu (); if (parentMenu == null) { return getEnabled () && parent.isEnabled (); } return getEnabled () && parentMenu.isEnabled (); } /** * Returns true if the receiver is visible and all * of the receiver's ancestors are visible and false * otherwise. * * @return the receiver's visibility state * * @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 #getVisible */ public boolean isVisible () { checkWidget (); return getVisible (); } void redraw () { if (!isVisible ()) return; if ((style & SWT.BAR) != 0) { display.addBar (this); } else { update (); } } void releaseHandle () { super.releaseHandle (); handle = hwndCB = 0; cascade = null; } void releaseChildren (boolean destroy) { MenuItem [] items = getItems (); 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 HelpListener * @see #addHelpListener */ public void removeHelpListener (HelpListener listener) { checkWidget (); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); if (eventTable == null) return; eventTable.unhook (SWT.Help, listener); } /** * Removes the listener from the collection of listeners who will * be notified when the menu events are generated for the control. * * @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 MenuListener * @see #addMenuListener */ public void removeMenuListener (MenuListener listener) { checkWidget (); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); if (eventTable == null) return; eventTable.unhook (SWT.Hide, listener); eventTable.unhook (SWT.Show, listener); } void reskinChildren (int flags) { MenuItem [] items = getItems (); for (int i=0; i *
  • 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.3 */ /*public*/ void setBackground (Color color) { checkWidget (); int pixel = -1; if (color != null) { if (color.isDisposed()) SWT.error(SWT.ERROR_INVALID_ARGUMENT); pixel = color.handle; } if (pixel == background) return; background = pixel; updateBackground (); } /** * Sets the receiver's background image to the image specified * by the argument, or to the default system color for the control * if the argument is null. The background image is tiled to fill * the available space. * * @param image the new image (or null) * * @exception IllegalArgumentException
      *
    • ERROR_INVALID_ARGUMENT - if the argument has been disposed
    • *
    • ERROR_INVALID_ARGUMENT - if the argument is not a bitmap
    • *
    * @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*/ void setBackgroundImage (Image image) { checkWidget (); if (image != null) { if (image.isDisposed ()) error (SWT.ERROR_INVALID_ARGUMENT); if (image.type != SWT.BITMAP) error (SWT.ERROR_INVALID_ARGUMENT); } if (backgroundImage == image) return; backgroundImage = image; updateBackground (); } /** * Sets the receiver's foreground color to the color specified * by the argument, or to the default system color for the control * 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 3.3 */ /*public*/ void setForeground (Color color) { checkWidget (); int pixel = -1; if (color != null) { if (color.isDisposed()) SWT.error(SWT.ERROR_INVALID_ARGUMENT); pixel = color.handle; } if (pixel == foreground) return; foreground = pixel; updateForeground (); } /** * Sets the default menu item to the argument or removes * the default emphasis when the argument is null. * * @param item the default menu item or null * * @exception IllegalArgumentException
      *
    • ERROR_INVALID_ARGUMENT - if the menu item 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 setDefaultItem (MenuItem item) { checkWidget (); int newID = -1; if (item != null) { if (item.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT); if (item.parent != this) return; newID = item.id; } if (OS.IsWinCE) return; int oldID = OS.GetMenuDefaultItem (handle, OS.MF_BYCOMMAND, OS.GMDI_USEDISABLED); if (newID == oldID) return; OS.SetMenuDefaultItem (handle, newID, OS.MF_BYCOMMAND); redraw (); } /** * Enables the receiver if the argument is true, * and disables it otherwise. A disabled menu is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * * @param enabled the new enabled state * * @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 setEnabled (boolean enabled) { checkWidget (); state &= ~DISABLED; if (!enabled) state |= DISABLED; } /** * Sets the location of the receiver, which must be a popup, * to the point specified by the arguments which are relative * to the display. *

    * Note that this is different from most widgets where the * location of the widget is relative to the parent. *

    * Note that the platform window manager ultimately has control * over the location of popup menus. *

    * * @param x the new x coordinate for the receiver * @param y the new y coordinate for 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 void setLocation (int x, int y) { checkWidget (); if ((style & (SWT.BAR | SWT.DROP_DOWN)) != 0) return; this.x = x; this.y = y; hasLocation = true; } /** * Sets the location of the receiver, which must be a popup, * to the point specified by the argument which is relative * to the display. *

    * Note that this is different from most widgets where the * location of the widget is relative to the parent. *

    * Note that the platform window manager ultimately has control * over the location of popup menus. *

    * * @param location the new location for the receiver * * @exception IllegalArgumentException
      *
    • ERROR_NULL_ARGUMENT - if the point 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
    • *
    * * @since 2.1 */ public void setLocation (Point location) { checkWidget (); if (location == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); setLocation (location.x, location.y); } /** * Sets the orientation of the receiver, which must be one * of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT. *

    * * @param orientation new orientation style * * @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.7 */ public void setOrientation (int orientation) { checkWidget (); if ((style & (SWT.BAR | SWT.DROP_DOWN)) != 0) return; _setOrientation (orientation); } void _setOrientation (int orientation) { if (OS.IsWinCE) return; if (OS.WIN32_VERSION < OS.VERSION (4, 10)) return; int flags = SWT.RIGHT_TO_LEFT | SWT.LEFT_TO_RIGHT; if ((orientation & flags) == 0 || (orientation & flags) == flags) return; style &= ~flags; style |= orientation & flags; MenuItem [] itms = getItems (); for (int i=0; itrue, * and marks it invisible otherwise. *

    * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, marking * it visible may not actually cause it to be displayed. *

    * * @param visible the new visibility state * * @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 setVisible (boolean visible) { checkWidget (); if ((style & (SWT.BAR | SWT.DROP_DOWN)) != 0) return; if (visible) { display.addPopup (this); } else { display.removePopup (this); _setVisible (false); } } void update () { if (OS.IsPPC || OS.IsSP) return; if (OS.IsHPC) { /* * Each time a menu has been modified, the command menu bar * must be redrawn or it won't update properly. For example, * a submenu will not drop down. */ Menu menuBar = parent.menuBar; if (menuBar != null) { Menu menu = this; while (menu != null && menu != menuBar) { menu = menu.getParentMenu (); } if (menu == menuBar) { OS.CommandBar_DrawMenuBar (menuBar.hwndCB, 0); OS.CommandBar_Show (menuBar.hwndCB, true); } } return; } if (OS.IsWinCE) return; if ((style & SWT.BAR) != 0) { if (this == parent.menuBar) OS.DrawMenuBar (parent.handle); return; } if (OS.WIN32_VERSION < OS.VERSION (4, 10)) { return; } boolean hasCheck = false, hasImage = false; MenuItem [] items = getItems (); for (int i=0; i