mmarquee.automation.pattern.Toggle 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

package mmarquee.automation.pattern;

import com.sun.jna.platform.win32.COM.COMUtils;
import com.sun.jna.platform.win32.WinNT;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;
import mmarquee.automation.AutomationException;
import mmarquee.automation.uiautomation.IUIAutomationTogglePattern;
import mmarquee.automation.uiautomation.IUIAutomationTogglePatternConverter;
import mmarquee.automation.uiautomation.ToggleState;

/**
 * Created by Mark Humphreys on 25/02/2016.
 *
 * Wrapper for the toggle pattern.
 */
public class Toggle extends BasePattern {
    /**
     * Constructor for the value pattern
     */
    public Toggle() {
        this.IID = IUIAutomationTogglePattern.IID;
    }

    private IUIAutomationTogglePattern rawPattern;

    public Toggle(IUIAutomationTogglePattern rawPattern) {
        this.IID = IUIAutomationTogglePattern.IID;
        this.rawPattern = rawPattern;
    }

    private IUIAutomationTogglePattern getPattern() throws AutomationException {
        if (this.rawPattern != null) {
            return this.rawPattern;
        } else {
            PointerByReference pbr = new PointerByReference();

            WinNT.HRESULT result0 = this.getRawPatternPointer(pbr);

            if (COMUtils.SUCCEEDED(result0)) {
                return this.convertPointerToInterface(pbr);
            } else {
                throw new AutomationException(result0.intValue());
            }
        }
    }

    /**
     * Toggles the control
     * @throws AutomationException Something has gone wrong
     */
    public void toggle () throws AutomationException {
        final int res = this.getPattern().toggle();
        if (res != 0) {
            throw new AutomationException(res);
        }
    }

    /**
     * Gets the toggled state of the control
     * @return The toggled state
     * @throws AutomationException Something has gone wrong
     */
    public ToggleState currentToggleState() throws AutomationException {
        IntByReference ibr = new IntByReference();

        final int res = this.getPattern().getCurrentToggleState(ibr);
        if (res != 0) {
            throw new AutomationException(res);
        }

        return ToggleState.fromInt(ibr.getValue());
    }

    public IUIAutomationTogglePattern convertPointerToInterface(PointerByReference pUnknown) {
        return IUIAutomationTogglePatternConverter.PointerToInterface(pUnknown);
    }
}