blob: 33a73dfe14eb9334ecd4d8a050e04001731d6154 [file] [log] [blame]
package org.eclipse.swt.widgets;
/*
* Copyright (c) 2000, 2002 IBM Corp. All rights reserved.
* This file is 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
*/
import org.eclipse.swt.internal.photon.*;
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.
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>BAR, DROP_DOWN, POP_UP</dd>
* <dt><b>Events:</b></dt>
* <dd>Help, Hide, Show </dd>
* </dl>
* <p>
* Note: Only one of BAR, DROP_DOWN and POP_UP may be specified.
* </p><p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
* </p>
*/
public class Menu extends Widget {
int x, y;
boolean hasLocation;
Decorations parent;
MenuItem cascade, defaultItem;
/**
* 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.
*
* @param parent a control which will be the parent of the new instance (cannot be null)
*
* @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#POP_UP
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Menu (Control parent) {
this (checkNull (parent).getShell (), SWT.POP_UP);
}
/**
* Constructs a new instance of this class given its parent
* (which must be a <code>Decorations</code>) and a style value
* describing its behavior and appearance.
* <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 decorations control which will be the parent of the new instance (cannot be null)
* @param style the style of menu 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#BAR
* @see SWT#DROP_DOWN
* @see SWT#POP_UP
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Menu (Decorations parent, int style) {
super (parent, checkStyle (style));
this.parent = parent;
createWidget (0);
}
/**
* Constructs a new instance of this class given its parent
* (which must be a <code>Menu</code>) and sets the style
* for the instance so that the instance will be a drop-down
* menu on the given parent's parent.
*
* @param parent a menu which will be the parent of the new instance (cannot be null)
*
* @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#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 <code>MenuItem</code>) and sets the style
* for the instance so that the instance will be a drop-down
* menu on the given parent's parent menu.
*
* @param parent a menu item which will be the parent of the new instance (cannot be null)
*
* @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#DROP_DOWN
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Menu (MenuItem parentItem) {
this (checkNull (parentItem).parent);
}
static Control checkNull (Control control) {
if (control == null) error (SWT.ERROR_NULL_ARGUMENT);
return control;
}
static Menu checkNull (Menu menu) {
if (menu == null) error (SWT.ERROR_NULL_ARGUMENT);
return menu;
}
static MenuItem checkNull (MenuItem item) {
if (item == null) 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);
}
/**
* 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
* <code>HelpListener</code> interface.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener 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>
*
* @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 <code>MenuListener</code>
* interface.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener 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>
*
* @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);
}
void createHandle (int index) {
state |= HANDLE;
int parentHandle = parent.topHandle ();
if ((style & SWT.BAR) != 0) {
int [] args = {
OS.Pt_ARG_FLAGS, 0, OS.Pt_GETS_FOCUS,
OS.Pt_ARG_FLAGS, OS.Pt_DELAY_REALIZE, OS.Pt_DELAY_REALIZE,
};
handle = OS.PtCreateWidget (OS.PtMenuBar (), parentHandle, args.length / 3, args);
} else {
handle = OS.PtCreateWidget (OS.PtMenu (), parentHandle, 0, null);
}
if (handle == 0) error (SWT.ERROR_NO_HANDLES);
}
void createWidget (int index) {
super.createWidget (index);
parent.add (this);
}
/**
* Returns the default menu item or null if none has
* been previously set.
*
* @return the default menu item.
*
* </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 MenuItem getDefaultItem () {
checkWidget();
return defaultItem;
}
public Display getDisplay () {
Decorations parent = this.parent;
if (parent == null) error (SWT.ERROR_WIDGET_DISPOSED);
return parent.getDisplay ();
}
/**
* Returns <code>true</code> if the receiver is enabled, and
* <code>false</code> 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 <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 boolean getEnabled () {
checkWidget ();
int topHandle = topHandle ();
return (OS.PtWidgetFlags (topHandle) & OS.Pt_BLOCKED) == 0;
}
/**
* Returns the number of items contained in the receiver.
*
* @return the number of items
*
* @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 int getItemCount () {
checkWidget();
int count = 0;
int child = OS.PtWidgetChildBack (handle);
if (child != 0 && (style & SWT.BAR) != 0) child = OS.PtWidgetChildBack (child);
while (child != 0) {
child = OS.PtWidgetBrotherInFront (child);
count++;
}
return count;
}
/**
* 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 <ul>
* <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)</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 MenuItem getItem (int index) {
checkWidget();
if (index < 0) error (SWT.ERROR_INVALID_RANGE);
int i = 0;
int child = OS.PtWidgetChildBack (handle);
if (child != 0 && (style & SWT.BAR) != 0) child = OS.PtWidgetChildBack (child);
while (child != 0) {
Widget widget = WidgetTable.get (child);
if (widget != null && widget instanceof MenuItem) {
if (i++ == index) return (MenuItem) widget;
}
child = OS.PtWidgetBrotherInFront (child);
}
error (SWT.ERROR_INVALID_RANGE);
return null;
}
/**
* Returns an array of <code>MenuItem</code>s which are the items
* in the receiver.
* <p>
* 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.
* </p>
*
* @return the items in the receiver
*
* @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 MenuItem [] getItems () {
checkWidget();
int count = 0;
int child = OS.PtWidgetChildBack (handle);
if (child != 0 && (style & SWT.BAR) != 0) child = OS.PtWidgetChildBack (child);
while (child != 0) {
child = OS.PtWidgetBrotherInFront (child);
count++;
}
MenuItem [] items = new MenuItem [count];
int i = 0, j = 0;
child = OS.PtWidgetChildBack (handle);
if (child != 0 && (style & SWT.BAR) != 0) child = OS.PtWidgetChildBack (child);
while (i < count) {
Widget widget = WidgetTable.get (child);
if (widget != null && widget instanceof MenuItem) {
items [j++] = (MenuItem) widget;
}
i++;
child = OS.PtWidgetBrotherInFront (child);
}
if (i == j) return items;
MenuItem [] newItems = new MenuItem [j];
System.arraycopy (items, 0, newItems, 0, j);
return newItems;
}
String getNameText () {
String result = "";
MenuItem [] items = getItems ();
int length = items.length;
if (length > 0) {
for (int i=0; i<length-1; i++) {
result = result + items [i].getNameText() + ", ";
}
result = result + items [length-1].getNameText ();
}
return result;
}
/**
* Returns the receiver's parent, which must be a <code>Decorations</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 Decorations getParent () {
checkWidget();
return parent;
}
/**
* Returns the receiver's parent item, which must be a
* <code>MenuItem</code> or null when the receiver is a
* root.
*
* @return the receiver's parent item
*
* @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 MenuItem getParentItem () {
checkWidget();
return cascade;
}
/**
* Returns the receiver's parent item, which must be a
* <code>Menu</code> or null when the receiver is a
* root.
*
* @return the receiver's parent item
*
* @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 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 <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>
*
* @see #getParent
*/
public Shell getShell () {
checkWidget();
return parent.getShell ();
}
/**
* Returns <code>true</code> if the receiver is visible, and
* <code>false</code> otherwise.
* <p>
* 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.
* </p>
*
* @return the receiver's visibility state
*
* @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 boolean getVisible () {
checkWidget();
return OS.PtWidgetIsRealized (handle);
}
void hookEvents () {
int windowProc = getDisplay ().windowProc;
OS.PtAddCallback (handle, OS.Pt_CB_REALIZED, windowProc, SWT.Show);
OS.PtAddCallback (handle, OS.Pt_CB_UNREALIZED, windowProc, SWT.Hide);
}
/**
* Searches the receiver's list starting at the first item
* (index 0) until an item is found that is equal to the
* argument, and returns the index of that item. If no item
* is found, returns -1.
*
* @param item the search item
* @return the index of the item
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the string 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>
*/
public int indexOf (MenuItem item) {
checkWidget();
if (item == null) error (SWT.ERROR_NULL_ARGUMENT);
int i = 0;
int child = OS.PtWidgetChildBack (handle);
if (child != 0 && (style & SWT.BAR) != 0) child = OS.PtWidgetChildBack (child);
while (child != 0) {
Widget widget = WidgetTable.get (child);
if (item == widget) return i;
if (widget != null && widget instanceof MenuItem) i++;
child = OS.PtWidgetBrotherInFront (child);
}
return -1;
}
/**
* Returns <code>true</code> if the receiver is enabled and all
* of the receiver's ancestors are enabled, and <code>false</code>
* 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 <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>
*
* @see #getEnabled
*/
public boolean isEnabled () {
checkWidget();
Menu parentMenu = getParentMenu ();
if (parentMenu == null) return getEnabled ();
return getEnabled () && parentMenu.isEnabled ();
}
/**
* Returns <code>true</code> if the receiver is visible and all
* of the receiver's ancestors are visible and <code>false</code>
* otherwise.
*
* @return the receiver's visibility state
*
* @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>
*
* @see #getVisible
*/
public boolean isVisible () {
checkWidget();
return getVisible ();
}
int processHide (int info) {
if (cascade != null) {
OS.PtSetResource (handle, OS.Pt_ARG_MENU_FLAGS, 0, OS.Pt_MENU_CHILD);
int shellHandle = parent.topHandle ();
OS.PtReParentWidget (handle, shellHandle);
}
sendEvent (SWT.Hide);
Shell shell = getShell ();
if (shell.activeMenu == this) {
shell.activeMenu = null;
if (cascade != null) {
Menu parent = cascade.parent;
if (parent != null && (parent.style & SWT.BAR) == 0) {
if (OS.PtWidgetIsRealized (parent.handle)) {
shell.activeMenu = parent;
}
}
}
}
return OS.Pt_CONTINUE;
}
int processShow (int info) {
if ((style & SWT.BAR) == 0) {
Shell shell = getShell ();
shell.activeMenu = this;
}
return OS.Pt_CONTINUE;
}
void releaseChild () {
super.releaseChild ();
if (cascade != null) cascade.setMenu (null);
if ((style & SWT.BAR) != 0 && this == parent.menuBar) {
parent.setMenuBar (null);
}
}
void releaseWidget () {
MenuItem [] items = getItems ();
for (int i=0; i<items.length; i++) {
MenuItem item = items [i];
if (!item.isDisposed ()) {
item.releaseWidget ();
item.releaseHandle ();
}
}
super.releaseWidget ();
if (parent != null) parent.remove (this);
parent = null;
cascade = null;
}
/**
* Removes the listener from the collection of listeners who will
* be notified when the help events are generated for the control.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener 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>
*
* @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 be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener 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>
*
* @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);
}
/**
* Sets the default menu item to the argument or removes
* the default emphasis when the argument is <code>null</code>.
*
* @param item the default menu item or null
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the menu item has been disposed</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 setDefaultItem (MenuItem item) {
checkWidget();
if (item != null && item.isDisposed()) error(SWT.ERROR_INVALID_ARGUMENT);
defaultItem = item;
}
/**
* Enables the receiver if the argument is <code>true</code>,
* 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 <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 setEnabled (boolean enabled) {
checkWidget ();
int topHandle = topHandle ();
int flags = enabled ? 0 : OS.Pt_BLOCKED | OS.Pt_GHOST;
OS.PtSetResource (topHandle, OS.Pt_ARG_FLAGS, flags, OS.Pt_BLOCKED | OS.Pt_GHOST);
}
/**
* Sets the receiver's location to the point specified by
* the arguments which are relative to the display.
* <p>
* Note: This is different from most widgets where the
* location of the widget is relative to the parent.
* </p>
*
* @param x the new x coordinate for the receiver
* @param y the new y coordinate for the receiver
*
* @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 setLocation (int x, int y) {
checkWidget();
this.x = x; this.y = y;
hasLocation = true;
}
/**
* Marks the receiver as visible if the argument is <code>true</code>,
* and marks it invisible otherwise.
* <p>
* 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.
* </p>
*
* @param visible the new visibility state
*
* @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 setVisible (boolean visible) {
checkWidget();
if ((style & SWT.POP_UP) == 0) return;
if (visible == OS.PtWidgetIsRealized (handle)) return;
if (visible) {
sendEvent (SWT.Show);
if (getItemCount () != 0) {
PhPoint_t pt = new PhPoint_t ();
pt.x = (short) x;
pt.y = (short) y;
if (!hasLocation) {
int ig = OS.PhInputGroup (0);
PhCursorInfo_t info = new PhCursorInfo_t ();
OS.PhQueryCursor ((short) ig, info);
pt.x = info.last_press_x;
pt.y = info.last_press_y;
}
int ptr = OS.malloc (PhPoint_t.sizeof);
OS.memmove (ptr, pt, PhPoint_t.sizeof);
OS.PtSetResource (handle, OS.Pt_ARG_POS, ptr, 0);
OS.free (ptr);
OS.PtRealizeWidget (handle);
} else {
sendEvent (SWT.Hide);
}
} else {
OS.PtUnrealizeWidget(handle);
}
}
}