mmarquee.automation.controls.ToolBar 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 java.util.regex.Pattern;

/**
 * Wrapper for the Toolbar element.
 * IDockProvider, IExpandCollapse,
 *
 * @author Mark Humphreys
 * Date 02/03/2016
 */
public final class ToolBar extends Container {
    /**
     * Constructor for the ToolBar.
     *
     * @param builder The builder
     */
    public ToolBar(final ElementBuilder builder) {
        super(builder);
    }

    /**
     * Gets the button control associated with the given index.
     * @param index The index of the button.
     * @return The Button.
     * @throws AutomationException Something has gone wrong.
     */
    private ToolBarButton getToolbarButton(final int index)
            throws AutomationException {
        return new ToolBarButton(this.getElementByControlType(index, ControlType.Button));
    }

    /**
     * Gets the button control associated with the given name.
     * @param name The name of the button.
     * @return The Button.
     * @throws AutomationException Something has gone wrong.
     */
    private ToolBarButton getToolbarButton(final String name)
            throws AutomationException {
        return new ToolBarButton(this.getElementByControlType(name, ControlType.Button));
    }

    /**
     * Gets the button control matching the given name.
     * @param namePattern The namePattern of the button.
     * @return The Button.
     * @throws AutomationException Something has gone wrong.
     */
    private ToolBarButton getToolbarButton(final Pattern namePattern)
            throws AutomationException {
        return new ToolBarButton(this.getElementByControlType(namePattern, ControlType.Button));
    }

    /**
     * Gets the button control associated with the given automationId.
     * @param automationId The index of the button.
     * @return The Button.
     * @throws AutomationException Something has gone wrong.
     */
    private ToolBarButton getToolbarButtonByAutomationId(final String automationId)
            throws AutomationException {
        return new ToolBarButton(this.getElementByAutomationId(automationId));
    }

    /**
     * Get the toolbar button, using the search criteria.
     * @param search The search criteria
     * @return The found control
     * @throws AutomationException Something has gone wrong
     */
    public ToolBarButton getToolbarButton(final Search search)
            throws AutomationException {
        if (search.getHasNamePattern()) {
            return getToolbarButton(search.getNamePattern());
        } else if (search.getHasAutomationId()) {
            return getToolbarButtonByAutomationId(search.getAutomationId());
        } else if (search.getHasIndex()) {
            return getToolbarButton(search.getIndex());
        } else if (search.getHasName()) {
            return getToolbarButton(search.getName());
        } else {
            throw new AutomationException("Search type not found");
        }
    }
}