mmarquee.automation.controls.AutomationCheckBox 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.PatternNotFoundException;
import mmarquee.automation.pattern.Toggle;
import mmarquee.automation.uiautomation.ToggleState;

/**
 * Created by Mark Humphreys on 31/01/2016.
 *
 * Wrapper for the CheckBox element.
 */
public class AutomationCheckBox
        extends AutomationBase
        implements Toggleable, Focusable {

    private Toggle togglePattern;

    /**
     * 
     * Invokes the toggle event for this control
     * 
     * @throws AutomationException Something has gone wrong
     * @throws PatternNotFoundException Failed to find pattern
     */
    public void toggle () throws AutomationException, PatternNotFoundException {
        if (this.togglePattern == null) {
            togglePattern = this.getTogglePattern();
        }

        this.togglePattern.toggle();
    }

    /**
     * 
     * Gets the toggle state of this control
     * 
     * @return The toggle state
     * @throws AutomationException Something has gone wrong
     * @throws PatternNotFoundException Failed to find pattern
     */
    public ToggleState getToggleState () throws AutomationException, PatternNotFoundException {
        if (this.togglePattern == null) {
            togglePattern = this.getTogglePattern();
        }

        return this.togglePattern.currentToggleState();
    }

    /**
     * Constructor for the AutomationCheckBox
     * @param element The element
     * @throws AutomationException Automation exception
     * @throws PatternNotFoundException Pattern not found
     */
    public AutomationCheckBox (AutomationElement element) throws PatternNotFoundException, AutomationException {
        super(element);
    }


    /**
     * Constructor for the AutomationCheckBox
     * @param element The element
     * @param pattern The pattern
     * @param instance Automation instance
     */
    public AutomationCheckBox(AutomationElement element, Toggle pattern, UIAutomation instance) {
        super(element, instance);
        togglePattern = pattern;
    }

    /**
     * Constructor for the AutomationCheckBox
     * @param element The element
     * @param pattern The pattern
     */
    public AutomationCheckBox(AutomationElement element, Toggle pattern) {
        super(element);
        togglePattern = pattern;
    }

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