mmarquee.automation.pattern.Range 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.
The newest version!
/*
 * 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.ptr.DoubleByReference;
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.IUIAutomationRangeValuePattern;
import mmarquee.uiautomation.IUIAutomationRangeValuePatternConverter;

/**
 * Wrapper for the range valuepattern.
 *
 * @author Mark Humphreys
 * Date 01/03/2016.
 */
public class Range extends BasePattern {

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

    /**
     * The raw pattern.
     */
    IUIAutomationRangeValuePattern rawPattern;

    /**
     * Converts the pointer.
     * @param pUnknownA The raw pointer
     * @return The RangeValue pattern
     */
    IUIAutomationRangeValuePattern convertPointerToInterface(PointerByReference pUnknownA) {
        return IUIAutomationRangeValuePatternConverter.pointerToInterface(pUnknownA);
    }

    /**
     * Gets the pattern.
     *
     * @return The pattern
     * @throws AutomationException Error in automation library
     */
    private IUIAutomationRangeValuePattern getPattern() throws AutomationException {
    	return getPattern(rawPattern, this::convertPointerToInterface);
    }

    /**
     * Sets the value.
     *
     * @param value The value to set
     * @throws AutomationException Something has gone wrong
     */
    public void setValue (double value) throws AutomationException {
        final int res = this.getPattern().setValue(value);
        if (res != 0) {
            throw new AutomationException(res);
        }
    }

    /**
     * Gets the value.
     *
     * @return The value
     * @throws AutomationException Something has gone wrong
     */
    public double getValue () throws AutomationException {
        DoubleByReference dbr = new DoubleByReference();

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

        return dbr.getValue();
    }

    /**
     * Whether the control range value is read only.
     *
     * @return True if read only
     * @throws AutomationException Something is wrong
     */
    public boolean getIsReadOnly () throws AutomationException {
        IntByReference ibr = new IntByReference();

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

        return (ibr.getValue() == 1);
    }
}