mmarquee.automation.pattern.Grid 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.platform.win32.COM.COMUtils;
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.IntByReference;
import com.sun.jna.ptr.PointerByReference;
import mmarquee.automation.AutomationException;
import mmarquee.automation.Element;
import mmarquee.automation.PatternID;
import mmarquee.automation.PropertyID;
import mmarquee.uiautomation.IUIAutomationElement;
import mmarquee.uiautomation.IUIAutomationGridPattern;
import mmarquee.uiautomation.IUIAutomationGridPatternConverter;

/**
 * @author Mark Humphreys
 * Date 25/02/2016.
 *
 * Wrapper for the Grid pattern
 */
public class Grid extends BasePattern {

    /**
     * Constructor for the pattern.
     *
     * @param element The automation element for which the pattern is valid
     * @throws AutomationException If something goes wrong
     */
    public Grid(final Element element) throws AutomationException {
    	super(element);
        this.IID = IUIAutomationGridPattern.IID;
        this.patternID = PatternID.Grid;
        this.availabilityPropertyID = PropertyID.IsGridPatternAvailable;
    }

    /**
     * The raw grid pattern.
     */
    IUIAutomationGridPattern rawPattern;

    /**
     * Gets the pattern.
     *
     * @return The grid pattern
     * @throws AutomationException Exception raised by library
     */
    private IUIAutomationGridPattern getPattern() throws AutomationException {
    	return getPattern(rawPattern, this::convertPointerToInterface);
    }

    /**
     * Get the item associated with the given cell.
     *
     * @param x Cell X position
     * @param y Cell Y position
     * @return The item associated with the cell
     * @throws AutomationException Error thrown in automation library
     */
    protected PointerByReference getRawItem(int x, int y) throws AutomationException{
        PointerByReference pbr = new PointerByReference();

        final int res = this.getPattern().getItem(x, y, pbr);
        if (res != 0) {
            throw new AutomationException(res);
        }

        return pbr;
    }

    /**
     * Gets the element associated with the grid cell.
     *
     * @param x X position
     * @param y Y position
     * @return The Element from the grid
     * @throws AutomationException Something amiss with automation
     */
    public Element getItem(int x, int y) throws AutomationException {
        PointerByReference cell = this.getRawItem(x, y);

        Unknown uRoot = makeUnknown(cell.getValue());

        PointerByReference pbr = new PointerByReference();

        WinNT.HRESULT result0 = uRoot.QueryInterface(new Guid.REFIID(IUIAutomationElement.IID), pbr);

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

    /**
     * Gets the row count.
     *
     * @return The tow count
     * @throws AutomationException Error thrown in automation library
     */
    public int rowCount() throws AutomationException {
        IntByReference ibr = new IntByReference();

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

        return ibr.getValue();
    }

    /**
     * Gets the column count.
     *
     * @return The column count
     * @throws AutomationException Error thrown in automation library
     */
    public int columnCount() throws AutomationException {

        IntByReference ibr = new IntByReference();

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

        return ibr.getValue();
    }

    /**
     * Gets the converted pointer.
     *
     * @param pUnknownA The raw pointer
     * @return The converted pointer
     */
    IUIAutomationGridPattern convertPointerToInterface(PointerByReference pUnknownA) {
        return IUIAutomationGridPatternConverter.pointerToInterface(pUnknownA);
    }
}