mmarquee.automation.controls.ToolBarButton 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 com.sun.jna.platform.win32.WinDef;
import mmarquee.automation.AutomationException;
import mmarquee.automation.Element;
import mmarquee.automation.controls.mouse.AutomationMouse;
import mmarquee.automation.pattern.Invoke;

/**
 * Wrapper for the ToolBarButton.
 *
 * @author Mark Humphreys
 * Date 20/07/2016
 *
 * For some reason the invoke pattern doesn't work for these buttons, even via
 * Object Inspector - no error, just doesn't work, so have to manufacture the click.
 */
public final class ToolBarButton extends AutomationBase
        implements ImplementsClick {

    /**
     * Constructor for the ToolBarButton.
     * @param element The underlying automation element.
     */
    public ToolBarButton(final Element element) {
        super(new ElementBuilder(element));
    }

    /**
     * Constructor for the ToolBarButton.
     * @param element The underlying automation element.
     * @param invoke The Invoke pattern.
     */
    ToolBarButton(final Element element,
                  final Invoke invoke) {
        super(new ElementBuilder(element).addPattern(invoke));
    }

    /**
     * 
     * Invokes the click event for this control.
     * 
     * 
     * Actually manufactures the click, as the toolbar buttons do
     * not seem behave properly
     * 
     * @throws AutomationException Automation library error.
     */
    public void click() throws AutomationException {
        WinDef.POINT point = this.getElement().getClickablePoint();

        AutomationMouse mouse = AutomationMouse.getInstance();
        mouse.setLocation(point.x, point.y);
        mouse.leftClick();
    }

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