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.
   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.lookup;
  24 
  25 import org.jemmy.Rectangle;
  26 
  27 /**
  28  * Lookup that matches all the controls with the bounds that lay inside 
  29  * the given rectangle. The way to determine bounds of any control is 
  30  * implemented by the child class in @{@linkplain #getBounds(java.lang.Object)} 
  31  * method.
  32  * @param <CONTROL> 
  33  * @author shura
  34  */
  35 public abstract class CoordinateLookup<CONTROL> implements LookupCriteria<CONTROL>{
  36 
  37     private Rectangle area;
  38 
  39     /**
  40      *
  41      * @param area Rectangle area to lookup up for controls that reside inside it
  42      */
  43     public CoordinateLookup(Rectangle area) {
  44         this.area = area;
  45     }
  46 
  47     /**
  48      *
  49      * @return Rectangle area to lookup up for controls that reside inside it
  50      */
  51     protected Rectangle getArea() {
  52         return area;
  53     }
  54 
  55     /**
  56      *
  57      * @param control
  58      * @return logical bounds for the control that has to be inside the given
  59      * rectangle to match the lookup
  60      */
  61     protected abstract Rectangle getBounds(CONTROL control);
  62 
  63     public boolean check(CONTROL control) {
  64         Rectangle a = getArea();
  65         Rectangle bounds = getBounds(control);
  66         return bounds.x >= a.x && bounds.y >= a.y &&
  67                 (bounds.x + bounds.width) <= (a.x + a.width) &&
  68                 (bounds.y + bounds.height) <= (a.y + a.height);
  69     }
  70 
  71     @Override
  72     public String toString() {
  73         return "CoordinateLookup[area=" + area + "]";
  74     }
  75 }