mmarquee.automation.controls.AutomationButton 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.AutomationElement;
import mmarquee.automation.AutomationException;
import mmarquee.automation.ControlType;
import mmarquee.automation.pattern.Invoke;
import mmarquee.automation.pattern.PatternNotFoundException;

import javax.naming.ldap.Control;

/**
 * Created by Mark Humphreys on 02/02/2016.
 *
 * Wrapper around the Button element.
 */
public class AutomationButton extends AutomationBase implements Clickable, Focusable {

    protected Invoke invokePattern = null;

    public static ControlType controlType = ControlType.Button;

    /**
     * Constructor for the AutomationButton
     * @param element The underlying automation element
     * @throws AutomationException Automation library error
     * @throws PatternNotFoundException Expected pattern not found
     */
    public AutomationButton(AutomationElement element)
            throws PatternNotFoundException, AutomationException {
        super(element);
//        this.invokePattern = this.getInvokePattern();
    }

    /**
     * Constructor for the AutomationButton
     * @param element The underlying automation element
     * @param pattern The pattern
     * @throws AutomationException Automation library error
     * @throws PatternNotFoundException Expected pattern not found
     */
    public AutomationButton(AutomationElement element, Invoke pattern)
            throws PatternNotFoundException, AutomationException {
        super(element);
        this.invokePattern = pattern;
    }

    /**
     * 
     * Invokes the click event for this control
     * 
     * @throws AutomationException Error in the automation library
     * @throws PatternNotFoundException Could not find the invoke pattern
     */
    public void click() throws AutomationException, PatternNotFoundException {
        if (this.invokePattern == null) {
            this.invokePattern = this.getInvokePattern();
        }

        if (this.isInvokePatternAvailable()) {
            this.invokePattern.invoke();
        } else {
            throw new PatternNotFoundException();
        }
    }

    /**
     * 
     * Sets the focus to this control
     * 
     */
    public void focus() {
        this.element.setFocus();
    }
}