/*******************************************************************************

  * Copyright (c) 2008 Ketan Padegaonkar 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:

  *     Ketan Padegaonkar - initial API and implementation

  *******************************************************************************/

 package org.eclipse.swtbot.swt.finder.widgets;

 import static org.eclipse.swtbot.swt.finder.matchers.WidgetMatcherFactory.withMnemonic;

 import java.util.List;

 import org.eclipse.swt.SWT;

 import org.eclipse.swt.widgets.Menu;

 import org.eclipse.swt.widgets.MenuItem;

 import org.eclipse.swt.widgets.Widget;

 import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;

 import org.eclipse.swtbot.swt.finder.finders.MenuFinder;

 import org.eclipse.swtbot.swt.finder.results.BoolResult;

 import org.eclipse.swtbot.swt.finder.results.VoidResult;

 import org.eclipse.swtbot.swt.finder.results.WidgetResult;

 import org.eclipse.swtbot.swt.finder.utils.MessageFormat;

 import org.hamcrest.Matcher;

 import org.hamcrest.SelfDescribing;

 /**

  * @author Ketan Padegaonkar <KetanPadegaonkar [at] gmail [dot] com>

  * @version $Id$

  */

 public class SWTBotMenu extends AbstractSWTBot<MenuItem> {

         /**

          * @param w the widget.

          * @param description the description of the widget, this will be reported by {@link #toString()}

          * @throws WidgetNotFoundException if the widget is <code>null</code> or widget has been disposed.

          */

         public SWTBotMenu(MenuItem w, SelfDescribing description) throws WidgetNotFoundException {

                 super(w, description);

         }

         /**

          * @param w the widget.

          * @throws WidgetNotFoundException if the widget is <code>null</code> or widget has been disposed.

          */

         public SWTBotMenu(MenuItem w) throws WidgetNotFoundException {

                 this(w, null);

         }

         /**

          * Clicks on the menu item

          */

         public SWTBotMenu click() {

                 log.debug(MessageFormat.format("Clicking on {0}", this)); //$NON-NLS-1$

                 waitForEnabled();

                 toggleSelection();

                 notify(SWT.Selection);

                 log.debug(MessageFormat.format("Clicked on {0}", this)); //$NON-NLS-1$

                 return this;

         }

         /**

          * Toggle the selection of the checkbox if applicable.

          */

         private void toggleSelection() {

                 syncExec(new VoidResult() {

                         public void run() {

                                 if (hasStyle(widget, SWT.CHECK) | hasStyle(widget, SWT.RADIO))

                                         widget.setSelection(!widget.getSelection());

                         }

                 });

         }

         /**

          * Gets the menu matching the given name.

          *

          * @param menuName the name of the menu item that is to be found

          * @return the first menu that matches the menuName

          * @throws WidgetNotFoundException if the widget is not found.

          */

         public SWTBotMenu menu(final String menuName) throws WidgetNotFoundException {

                 final Matcher<? extends Widget> matcher = withMnemonic(menuName);

                 MenuItem menuItem = syncExec(new WidgetResult<MenuItem>() {

                         public MenuItem run() {

                                 Menu bar = widget.getMenu();

                                 Matcher<MenuItem> withMnemonic = withMnemonic(menuName);

                                 List<MenuItem> menus = new MenuFinder().findMenus(bar, withMnemonic, true);

                                 if (!menus.isEmpty())

                                         return menus.get(0);

                                 return null;

                         }

                 });

                 return new SWTBotMenu(menuItem, matcher);

         }

         @Override

         public boolean isEnabled() {

                 return syncExec(new BoolResult() {

                         public Boolean run() {

                                 return widget.isEnabled();

                         }

                 });

         }

         /**

          * Gets if this menu item is checked.

          *

          * @return <code>true</code> if the menu is checked, <code>false</code> otherwise.

          * @see MenuItem#getSelection()

          * @since 1.2

          */

         public boolean isChecked() {

                 return syncExec(new BoolResult() {

                         public Boolean run() {

                                 return widget.getSelection();

                         }

                 });

         }

 }