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