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.input;
  24 
  25 import org.jemmy.Point;
  26 import org.jemmy.control.Wrap;
  27 import org.jemmy.interfaces.PopupSelectableOwner;
  28 import org.jemmy.lookup.LookupCriteria;
  29 
  30 /**
  31  *
  32  * @author erikgreijus
  33  * @param <T>
  34  */
  35 public abstract class StringPopupSelectableOwner<T> extends StringPopupOwner<T> implements PopupSelectableOwner<T> {
  36 
  37     private static final String MENU_PATH_LENGTH_ERROR = "Menu path length should be greater than 0";
  38 
  39     public StringPopupSelectableOwner(Wrap<?> menuOwner) {
  40         super(menuOwner);
  41     }
  42 
  43     /**
  44      * Ensures state of a menu item conforming to the criteria. That would mean
  45      * that all intermediate items get expanded and the menus are shown.
  46      * Selection depends on if the desired state matches the current state or
  47      * not. I.e selection of the last criteria happens only if the state differs
  48      * from desiredSelectionState
  49      *
  50      * @param desiredSelectionState The desired selection state of the leaf menu
  51      * item.
  52      * @param p The point where the popup menu is to be opened
  53      * @param criteria used one for one level. In case of a menu bar, for
  54      * example, first criteria is to be used to find a top level menu, second to
  55      * find a menu underneath, etc.
  56      */
  57     public void push(boolean desiredSelectionState, Point p, LookupCriteria<T>... criteria) {
  58         menu(p).push(desiredSelectionState, criteria);
  59     }
  60 
  61     /**
  62      * Ensures state of a menu item conforming to the criteria. That would mean
  63      * that all intermediate items get expanded and the menus are shown.
  64      * Selection depends on if the desired state matches the current state or
  65      * not. I.e selection of the last criteria happens only if the state differs
  66      * from desiredSelectionState
  67      *
  68      * @param desiredSelectionState The desired selection state of the leaf menu
  69      * item.
  70      * @param p The point where the popup menu is to be opened
  71      * @param texts used one for one level. In case of a menu bar, for example,
  72      * first string is to be used to find a top level menu, second to find a
  73      * menu underneath, etc.
  74      */
  75     public void push(boolean desiredSelectionState, Point p, String... texts) {
  76         if (texts.length == 0) {
  77             throw new IllegalArgumentException(MENU_PATH_LENGTH_ERROR);
  78         }
  79         push(desiredSelectionState, p, createCriteriaList(texts));
  80     }
  81 
  82     /**
  83      * Returns the current selection state of the menu item conforming to the
  84      * criteria. That would mean that all intermediate items get expanded and
  85      * the menus are shown.
  86      *
  87      * @param p The point where the popup menu is to be opened
  88      * @param criteria used one for one level. In case of a menu bar, for
  89      * example, first criteria is to be used to find a top level menu, second to
  90      * find a menu underneath, etc.
  91      * @return True if the menu item is selected. Otherwise false.
  92      */
  93     public boolean getState(Point p, LookupCriteria<T>... criteria) {
  94         return menu(p).getState(criteria);
  95     }
  96 
  97     /**
  98      * Returns the current selection state of the menu item conforming to the
  99      * criteria. That would mean that all intermediate items get expanded and
 100      * the menus are shown.
 101      *
 102      * @param p The point where the popup menu is to be opened
 103      * @param texts used one for one level. In case of a menu bar, for example,
 104      * first string is to be used to find a top level menu, second to find a
 105      * menu underneath, etc.
 106      * @return True if the menu item is selected. Otherwise false.
 107      */
 108     public boolean getState(Point p, String... texts) {
 109         if (texts.length == 0) {
 110             throw new IllegalArgumentException(MENU_PATH_LENGTH_ERROR);
 111         }
 112         return getState(p, createCriteriaList(texts));
 113     }
 114 
 115 }