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

import com.sun.jna.Pointer;
import com.sun.jna.platform.win32.COM.Unknown;
import com.sun.jna.platform.win32.Guid;
import com.sun.jna.platform.win32.WinNT;
import com.sun.jna.ptr.PointerByReference;
import mmarquee.automation.BaseAutomation;
import mmarquee.automation.uiautomation.IUIAutomationElement3;
import mmarquee.automation.uiautomation.IUIAutomationElement3Converter;
import mmarquee.automation.uiautomation.IUIAutomationElementArray;
import mmarquee.automation.uiautomation.IUIAutomationElementArrayConverter;

/**
 * Created by Mark Humphreys on 29/02/2016.
 *
 * Base for the pattern wrappers
 */
public abstract class BasePattern extends BaseAutomation implements Pattern {

    /**
     * The guid of the pattern.
     */
    protected Guid.IID IID;

    /**
     * The underlying automation pattern
     */
    protected Pointer pattern;

    /**
     * Constructs a Pattern
     */
    public BasePattern () {
        this.pattern = null;
    }

    /**
     * Sets the pattern
     * @param pattern The pattern to set
     */
    public void setPattern(Pointer pattern) {
        this.pattern =  pattern;
    }

    /**
     * Is this pattern available?
     * @return True if available.
     */
    public boolean isAvailable () {
        return (pattern == null);
    }

    /**
     * Gets the raw pointer to the pattern
     * @param pbr The raw pointer
     * @return Result of the call from the COM library
     */
    public WinNT.HRESULT getRawPatternPointer(PointerByReference pbr) {
        Unknown uElement = makeUnknown(this.pattern);
        return uElement.QueryInterface(new Guid.REFIID(this.IID), pbr);
    }

    /**
     * Converts the unknown value to a IUIAutomationElement3
     * @param pUnknownA The Unknown pointer
     * @return The pattern
     */
    public IUIAutomationElement3 convertPointerToElementInterface(PointerByReference pUnknownA) {
        return IUIAutomationElement3Converter.PointerToInterface(pUnknownA);
    }

    /**
     * Converts the unknown value to a IUIAutomationElementArray
     * @param pUnknownA The Unknown pointer
     * @return The pattern
     */
    public IUIAutomationElementArray convertPointerToElementArrayInterface(PointerByReference pUnknownA) {
        return IUIAutomationElementArrayConverter.PointerToInterface(pUnknownA);
    }
}