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