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

/**
 * @author Mark Humphreys
 * Date 26/02/2016.
 *
 * Wrapper for the Panel element.
 */
public class AutomationPanel extends AutomationContainer {
    /**
     * Construct the AutomationPanel.
     *
     * @param element The element.
     * @throws AutomationException Something is wrong in automation.
     * @throws PatternNotFoundException Could not find pattern.
     */
    public AutomationPanel(final AutomationElement element)
            throws AutomationException, PatternNotFoundException {
        super(element);
    }

    /**
     * Construct the AutomationPanel.
     *
     * @param element The element.
     * @param containerPattern The itemContainer pattern.
     * @param instance Automation instance.
     * @throws AutomationException Something is wrong in automation.
     * @throws PatternNotFoundException Could not find pattern.
     */
    AutomationPanel(final AutomationElement element,
                    final ItemContainer containerPattern,
                    final UIAutomation instance)
            throws AutomationException, PatternNotFoundException {
        super(element, containerPattern, instance);
    }

    /**
     * Construct the AutomationPanel.
     *
     * @param element The element.
     * @param containerPattern The itemContainer pattern.
     * @throws AutomationException Something is wrong in automation.
     * @throws PatternNotFoundException Could not find pattern.
     */
    AutomationPanel(final AutomationElement element,
                    final ItemContainer containerPattern)
            throws AutomationException, PatternNotFoundException {
        super(element, containerPattern);
    }

    /**
     * Gets an MDI window from the panel.
     *
     * Yes, panels can have windows - in this case the window is assumed to be extant.
     *
     * @param index The nth element.
     * @return The found window.
     * @throws PatternNotFoundException Failed to find the right pattern.
     * @throws AutomationException Something went really wrong.
     * @deprecated Use getWindow(int) instead.
     */
    public AutomationWindow getMDIWindow(final int index)
            throws PatternNotFoundException, AutomationException {
        return getWindow(index);
    }

    /**
     * Gets a window from the panel.
     *
     * @param index The nth element.
     * @return The found window.
     * @throws PatternNotFoundException Failed to find the right pattern.
     * @throws AutomationException Something went really wrong.
     */
    public AutomationWindow getWindow(final int index)
            throws PatternNotFoundException, AutomationException {
    	return new AutomationWindow(this.getElementByControlType(index, ControlType.Window));
    }

    /**
     * Gets a window from the panel.
     *
     * @param name Name of the control.
     * @return The found window.
     * @throws PatternNotFoundException Failed to find the right pattern.
     * @throws AutomationException Something went really wrong.
     */
    public AutomationWindow getWindow(final String name)
            throws PatternNotFoundException, AutomationException {
        return new AutomationWindow(this.getElementByControlType(name, ControlType.Window));
    }

    /**
     * Gets the window associated with the given automation id.
     *
     * @param id The id to use.
     * @return The found window.
     * @throws AutomationException Something has gone wrong.
     * @throws PatternNotFoundException Expected pattern not found.
      */
    public AutomationWindow getWindowByAutomationId(final String id)
            throws PatternNotFoundException, AutomationException {
        return new AutomationWindow(this.getElementByAutomationId(id, ControlType.Window));
    }
}