1 /* 2 * Copyright (c) 2016, 2017 Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package org.jemmy.interfaces; 26 27 import org.jemmy.lookup.LookupCriteria; 28 29 /** 30 * Represents a hierarchical structure in which elements not only could be 31 * selected but also "pushes", which is an action typically performed with 32 * menu. 33 * 34 * @author erikgreijus 35 */ 36 public interface MenuSelectable<T> extends Menu<T> { 37 38 /** 39 * Ensures state of a menu item conforming to the criteria. That would mean 40 * that all intermediate items get expanded and the menus are shown. 41 * Selection depends on if the desired state matches the current state or 42 * not. I.e selection of the last criteria happens only if the state differs 43 * from desiredSelectionState 44 * 45 * @param desiredSelectionState The desired selection state of the leaf menu 46 * item. 47 * @param criteria used one for one level. In case of a menu bar, for 48 * example, first criteria is to be used to find a top level menu, second to 49 * - find a menu underneath, etc. 50 */ 51 public void push(boolean desiredSelectionState, LookupCriteria<T>... criteria); 52 53 /** 54 * Returns the current selection state of the menu item conforming to the 55 * criteria. That would mean that all intermediate items get expanded and 56 * the menus are shown. 57 * 58 * @param criteria used one for one level. In case of a menu bar, for 59 * example, first criteria is to be used to find a top level menu, second to 60 * - find a menu underneath, etc. 61 * @return True if the menu item is selected. Otherwise false. 62 */ 63 public boolean getState(LookupCriteria<T>... criteria); 64 }