UNPKG

@redhat-developer/page-objects

Version:

Page Object API implementation for a VS Code editor used by ExTester framework.

55 lines (54 loc) 2.29 kB
/** * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License", destination); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * https://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. */ import { AbstractElement } from '../AbstractElement'; import { MenuItem } from './MenuItem'; /** * Abstract element representing a menu */ export declare abstract class Menu extends AbstractElement { /** * Find whether the menu has an item of a given name * @param name name of the item to search for * @returns true if menu has an item with the given name, false otherwise */ hasItem(name: string): Promise<boolean>; /** * Return a menu item of a given name, undefined if not found * @param name name of the item to search for */ abstract getItem(name: string): Promise<MenuItem | undefined>; /** * Get all items of a menu * @returns array of MenuItem object representing the menu items */ abstract getItems(): Promise<MenuItem[]>; /** * Recursively select an item with a given path. * * E.g. calling select('File', 'Preferences', 'Settings') will * open the 'File' -> 'Preferences' submenus and then click on 'Settings'. * * Selection happens in order of the arguments, if one of the items in the middle * of the path has no children, the consequent path arguments will be ignored. * * * @param path path to the item to select, represented by a sequence of strings * @returns void if the last clicked item is a leaf, Menu item representing * its submenu otherwise */ select(...path: string[]): Promise<Menu | undefined>; }