mmarquee.automation.controls.AutomationCalendar 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.AutomationElement;
import mmarquee.automation.AutomationException;
import mmarquee.automation.UIAutomation;
import mmarquee.automation.pattern.PatternNotFoundException;
import mmarquee.automation.pattern.Value;

/**
 * @author Mark Humphreys
 * Date 16/02/2016.
 *
 * Wrapper for the Calendar element.
 *
 * Implements IGridProvider, IScrollProvider, ITableProvider, IValueProvider
 */
public class AutomationCalendar extends AutomationBase implements Valueable {
    private Value valuePattern;

    /**
     * Constructor for the AutomationCalendar.
     *
     * @param element The underlying automation element.
     * @throws AutomationException Automation library error.
     * @throws PatternNotFoundException Expected pattern not found.
     */
    public AutomationCalendar(final AutomationElement element)
            throws PatternNotFoundException, AutomationException {
        super(element);
        this.valuePattern = this.getValuePattern();
    }

    /**
     * Constructor for the AutomationCalendar.
     *
     * @param element The underlying automation element.
     * @param pattern Value pattern.
     */
    public AutomationCalendar(final AutomationElement element,
                              final Value pattern) {
        super(element);
        this.valuePattern = pattern;
    }

    /**
     * Constructor for the AutomationCalendar.
     *
     * @param element The underlying automation element.
     * @param pattern Value pattern.
     * @param instance the automation instance.
     */
    public AutomationCalendar(final AutomationElement element,
                              final Value pattern,
                              final UIAutomation instance) {
        super(element, instance);
        this.valuePattern = pattern;
    }

    /**
     * Gets the current value of the control.
     *
     * @return The current value.
     * @throws AutomationException Something has gone wrong.
     */
    public String getValue() throws AutomationException {
        return this.valuePattern.value();
    }
}