mmarquee.automation.controls.TitleBar 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.controls;

import com.sun.jna.ptr.PointerByReference;
import mmarquee.automation.AutomationException;
import mmarquee.automation.ControlType;
import mmarquee.automation.Element;
import mmarquee.uiautomation.TreeScope;

/**
 * Wrapper for the TitleBar element.
 *
 * @author Mark Humphreys
 * Date 04/03/2016.
 *
 */
public final class TitleBar extends Container {
    /**
     * Constructor for the TitleBar.
     * @param builder The builder
     */
    public TitleBar(final ElementBuilder builder){
        super(builder);
    }

    /**
     * Gets the menu bar for this title-bar.
     * @return The Main menu
     * @throws AutomationException Automation library error
     */
    public MainMenu getMenuBar() throws AutomationException {
        PointerByReference condition = this.getAutomation()
                .createControlTypeCondition(ControlType.MenuBar);

        Element element =
                this.getElement().findFirst(
                        new TreeScope(TreeScope.DESCENDANTS),
                        condition);

        return new MainMenu(new ElementBuilder(element).parent(this.getElement()));
    }
}