mmarquee.automation.controls.MenuItem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ui-automation Show documentation
A Java library that wraps the MS UIAutomation library.
There is a newer version: 0.7.0
/*
 * Copyright 2016-17 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package mmarquee.automation.controls;

import mmarquee.automation.AutomationException;
import mmarquee.automation.ControlType;
import mmarquee.automation.Element;
import mmarquee.automation.ElementNotFoundException;
import mmarquee.automation.pattern.PatternNotFoundException;
import mmarquee.uiautomation.TreeScope;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;

/**
 * Wrapper for the MenuItem element.
 * @author Mark Humphreys
 * Date 10/02/2016.
 */
public class MenuItem
        extends AutomationBase
        implements ImplementsClick, ImplementsExpand {

    /** The parent element. */
    public Element mainMenuParentElement;

    /** Name of the parent. */
    public String parentMenuName;

    /**
     * Construct the MenuItem.
     * @param builder The builder
     */
    public MenuItem(final ElementBuilder builder){
        super(builder);
    }

    /**
     * The Control type.
     */
    public static ControlType controlType = ControlType.MenuItem;

    /**
     * Invoke the click pattern for the menu item.
     * @throws AutomationException Something has gone wrong
     * @throws PatternNotFoundException Expected pattern not found
     */
    public void click() throws AutomationException, PatternNotFoundException {
    	this.invoke();
    }

    /**
     * Gets the list of items associated with this menu item.
     * If the current item is known as member of an MainMenu,
     * the request is automatically redirected to the correspondent
     * Menu, when such a menu can be found
     * (i.e. this item is expanded)
     * 
     * @return List of menu items
     * @throws AutomationException Something has gone wrong
     */
    public List getItems() throws AutomationException {

    	Menu realMenu = getRealMenu();
    	if (realMenu != null) {
    		return realMenu.getItems();
    	}
    	
        List items =
                this.findAll(new TreeScope(TreeScope.DESCENDANTS),
                        this.createControlTypeCondition(ControlType.MenuItem));

        List list = new ArrayList<>();

        for (Element item : items) {
            list.add(new MenuItem(new ElementBuilder(item)));
        }

        return list;
    }

    /**
     * Gets the subItem associated with the index.
     * If the current item is known as member of an MainMenu,
     * the request is automatically redirected to the correspondent
     * Menu, when such a menu can be found
     * (i.e. this item is expanded)
     * 
     * @param index The index
     * @return The found item
     * @throws AutomationException Something went wrong
     */
    public MenuItem getMenuItem (int index) throws AutomationException {

    	Menu realMenu = getRealMenu();
    	if (realMenu != null) {
    		return realMenu.getMenuItem(index);
    	}
    	
        List items =
                this.findAll(new TreeScope(TreeScope.CHILDREN));

        return new MenuItem(new ElementBuilder(items.get(index)));
    }
    
    /**
     * Get the menu item associated with the name.
     * If the current item is known as member of an MainMenu,
     * the request is automatically redirected to the correspondent
     * Menu, when such a menu can be found
     * (i.e. this item is expanded)
     * 
     * @param name First Name
     * @return The menu item that matches the name
     * @throws AutomationException Something has gone wrong
     * @throws PatternNotFoundException Expected pattern not found
     */
    public MenuItem getMenuItem (String name)
            throws PatternNotFoundException, AutomationException {
    	
    	Menu realMenu = getRealMenu();
    	if (realMenu != null) {
    		return realMenu.getMenuItem(name);
    	}

        Element item = this.findFirst(new TreeScope(TreeScope.CHILDREN),
                this.createAndCondition(
                        this.createNamePropertyCondition(name),
                        this.createControlTypeCondition(ControlType.MenuItem)));

        return new MenuItem(new ElementBuilder(item));
    }

    /**
     * Get the menu item matching the name.
     * If the current item is known as member of an MainMenu,
     * the request is automatically redirected to the correspondent
     * Menu, when such a menu can be found
     * (i.e. this item is expanded)
     * 
     * @param namePattern a pattern matching the menu item name
     * @return The menu item that matches the name
     * @throws AutomationException Something has gone wrong
     */
    public MenuItem getMenuItem (Pattern namePattern)
            throws AutomationException {
    	
    	Menu realMenu = getRealMenu();
    	if (realMenu != null) {
    		return realMenu.getMenuItem(namePattern);
    	}

    	List collection;

        Element item = null;

        collection = this.findAll(new TreeScope(TreeScope.CHILDREN),
        		this.createControlTypeCondition(ControlType.MenuItem));

        for (Element element : collection) {
            String name = element.getName();

            if (name != null && namePattern.matcher(name).matches()) {
                item = element;
                break;
            }
        }

        if (item == null) {
            throw new ElementNotFoundException("Failed to find element matching " + namePattern);
        }
        
        return new MenuItem(new ElementBuilder(item));
    }
    
    /**
     * Get the menu item associated with the automationID.
     *
     * If the current item is known as member of an MainMenu,
     * the request is automatically redirected to the correspondent
     * Menu, when such a menu can be found
     * (i.e. this item is expanded)
     * 
     * @param automationId The automation ID to look for
     * @return The menu item that matches the name
     * @throws AutomationException Something has gone wrong
     */
    public MenuItem getMenuItemByAutomationId (String automationId)
            throws AutomationException {
    	
    	Menu realMenu = getRealMenu();
    	if (realMenu != null) {
    		return realMenu.getMenuItemByAutomationId(automationId);
    	}

        Element item =
                this.findFirst(new TreeScope(TreeScope.DESCENDANTS),
                this.createAndCondition(
                        this.createAutomationIdPropertyCondition(automationId),
                        this.createControlTypeCondition(ControlType.MenuItem)));

        return new MenuItem(new ElementBuilder(item));
    }

    /**
     * Gets the real menu.
     * @return The menu item
     * @throws AutomationException Something has gone wrong
     *
     * For MainMenus, the dropdown is disconnected from the MenuItem here
     */
    private Menu getRealMenu() throws AutomationException {
    	if (parentMenuName == null || mainMenuParentElement == null) {
    		return null;
    	}
    	try {
	    	Element item = mainMenuParentElement.findFirst(
	    	        new TreeScope(TreeScope.DESCENDANTS),
                    this.createAndCondition(
	                        this.createNamePropertyCondition(parentMenuName),
	                        this.createControlTypeCondition(ControlType.Menu)));

            if (item == null) {
                return null;
            }

	    	return new Menu(new ElementBuilder(item));
    	} catch (ElementNotFoundException ex) {
    		return null;
    	}
    }
}