mmarquee.automation.controls.AutomationToolBar 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.ItemContainer;
import mmarquee.automation.pattern.PatternNotFoundException;

/**
 * Created by Mark Humphreys on 02/03/2016.

 * Wrapper for the Toolbar element.
 * IDockProvider, IExpandCollapse,
 */
public class AutomationToolBar extends AutomationContainer {
    /**
     * Constructor for the AutomationToolBar.
     *
     * @param element The underlying automation element
     * @throws AutomationException Automation library error
     * @throws PatternNotFoundException Could not find pattern
     */
    public AutomationToolBar(AutomationElement element) throws AutomationException, PatternNotFoundException {
        super(element);
    }

    /**
     * Constructor for the AutomationToolBar.
     *
     * @param element The underlying automation element
     * @param container The ItemContainer pattern
     * @throws AutomationException Automation library error
     * @throws PatternNotFoundException Could not find pattern
     */
    public AutomationToolBar(AutomationElement element, ItemContainer container) throws AutomationException, PatternNotFoundException {
        super(element, container);
    }

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