mmarquee.automation.controls.TextBox 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.AutomationException;
import mmarquee.automation.pattern.LegacyIAccessible;
import mmarquee.automation.pattern.PatternNotFoundException;

/**
 * Wrapper for the TextBox element.
 *
 * @author Mark Humphreys
 * Date 01/02/2016.
 */
public final class TextBox
        extends AutomationBase
        implements ImplementsValue, ImplementsLegacyIAccessible {

    /**
     * Construct the TextBox.
     *
     * @param builder The builder.
     */
    public TextBox(final ElementBuilder builder) {
        super(builder);
    }

    /**
     * The legacy IAccessible pattern.
     */
    private LegacyIAccessible accessiblePattern;

    /**
     * Gets the value from the Legacy IAccessible interface.
     * @return The string value
     * @throws PatternNotFoundException Failed to find pattern
     * @throws AutomationException Issue with automation library
     */
    public String getValueFromIAccessible()
            throws PatternNotFoundException, AutomationException {
        if (this.accessiblePattern == null) {
            try {
                this.accessiblePattern = this.requestAutomationPattern(LegacyIAccessible.class);
            } catch (NullPointerException ex) {
                getLogger().info("No value pattern available");
            }
        }

        try {
            return accessiblePattern.getCurrentValue();
        } catch (NullPointerException ex) {
            return "";
        }
    }

    /**
     * Sets the value from the legacy IAccessible interface.
     *
     * @param value The value to set
     * @throws AutomationException Issue with automation library
     */
    public void setValueFromIAccessible(final String value)
            throws AutomationException {
        if (this.accessiblePattern == null)  {
            try {
                this.accessiblePattern = this.requestAutomationPattern(LegacyIAccessible.class);
                this.accessiblePattern.setCurrentValue(value);
            } catch (NullPointerException ex) {
                getLogger().info("No value pattern available");
            }
        }
    }
}