
org.jemmy.input.StringPopupSelectableOwner Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2016, 2017 Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.jemmy.input;
import org.jemmy.Point;
import org.jemmy.control.Wrap;
import org.jemmy.interfaces.PopupSelectableOwner;
import org.jemmy.lookup.LookupCriteria;
/**
*
* @author erikgreijus
* @param todo document
*/
public abstract class StringPopupSelectableOwner extends StringPopupOwner implements PopupSelectableOwner {
private static final String MENU_PATH_LENGTH_ERROR = "Menu path length should be greater than 0";
public StringPopupSelectableOwner(Wrap> menuOwner) {
super(menuOwner);
}
/**
* Ensures state of a menu item conforming to the criteria. That would mean
* that all intermediate items get expanded and the menus are shown.
* Selection depends on if the desired state matches the current state or
* not. I.e selection of the last criteria happens only if the state differs
* from desiredSelectionState
*
* @param desiredSelectionState The desired selection state of the leaf menu
* item.
* @param p The point where the popup menu is to be opened
* @param criteria used one for one level. In case of a menu bar, for
* example, first criteria is to be used to find a top level menu, second to
* find a menu underneath, etc.
*/
public void push(boolean desiredSelectionState, Point p, LookupCriteria... criteria) {
menu(p).push(desiredSelectionState, criteria);
}
/**
* Ensures state of a menu item conforming to the criteria. That would mean
* that all intermediate items get expanded and the menus are shown.
* Selection depends on if the desired state matches the current state or
* not. I.e selection of the last criteria happens only if the state differs
* from desiredSelectionState
*
* @param desiredSelectionState The desired selection state of the leaf menu
* item.
* @param p The point where the popup menu is to be opened
* @param texts used one for one level. In case of a menu bar, for example,
* first string is to be used to find a top level menu, second to find a
* menu underneath, etc.
*/
public void push(boolean desiredSelectionState, Point p, String... texts) {
if (texts.length == 0) {
throw new IllegalArgumentException(MENU_PATH_LENGTH_ERROR);
}
push(desiredSelectionState, p, createCriteriaList(texts));
}
/**
* Returns the current selection state of the menu item conforming to the
* criteria. That would mean that all intermediate items get expanded and
* the menus are shown.
*
* @param p The point where the popup menu is to be opened
* @param criteria used one for one level. In case of a menu bar, for
* example, first criteria is to be used to find a top level menu, second to
* find a menu underneath, etc.
* @return True if the menu item is selected. Otherwise false.
*/
public boolean getState(Point p, LookupCriteria... criteria) {
return menu(p).getState(criteria);
}
/**
* Returns the current selection state of the menu item conforming to the
* criteria. That would mean that all intermediate items get expanded and
* the menus are shown.
*
* @param p The point where the popup menu is to be opened
* @param texts used one for one level. In case of a menu bar, for example,
* first string is to be used to find a top level menu, second to find a
* menu underneath, etc.
* @return True if the menu item is selected. Otherwise false.
*/
public boolean getState(Point p, String... texts) {
if (texts.length == 0) {
throw new IllegalArgumentException(MENU_PATH_LENGTH_ERROR);
}
return getState(p, createCriteriaList(texts));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy