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