1 /*
   2  * Copyright (c) 2007, 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 
  26 package org.jemmy.interfaces;
  27 
  28 import java.util.List;
  29 import org.jemmy.control.Property;
  30 import org.jemmy.dock.Shortcut;
  31 
  32 /**
  33  * Interface for a control with one selected state among the number of them.
  34  * @param <STATE>
  35  * @author shura, KAM
  36  */
  37 public interface Selectable<STATE> extends TypeControlInterface<STATE> {
  38 
  39     /**
  40      *
  41      */
  42     public static final String STATES_PROP_NAME = "states";
  43     public static final String STATE_PROP_NAME = "state";
  44 
  45     /**
  46      * Returns all available states.
  47      * @return List of all states.
  48      */
  49     @Property(STATES_PROP_NAME)
  50     public List<STATE> getStates();
  51 
  52     /**
  53      * Returns currently selected state.
  54      * @return Selected state.
  55      */
  56     @Property(STATE_PROP_NAME)
  57     public STATE getState();
  58 
  59     /**
  60      * Returns Selector class instance that has methods to select state.
  61      * @return Selector class instance for the control.
  62      */
  63     @Shortcut
  64     public Selector<STATE> selector();
  65 
  66 }