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