1 /*
   2  * Copyright (c) 2007, 2018, 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.swt;
  26 
  27 import org.eclipse.swt.widgets.Scrollable;
  28 import org.jemmy.Rectangle;
  29 import org.jemmy.action.GetAction;
  30 import org.jemmy.control.ControlType;
  31 import org.jemmy.env.Environment;
  32 
  33 /**
  34  * Base wrapper for scrollable controls such as Table and Tree
  35  *
  36  * @author erikgreijus
  37  * @param <T>
  38  */
  39 @ControlType(Scrollable.class)
  40 public class ScrollableWrap<T extends Scrollable> extends ControlWrap<T> {
  41 
  42     public ScrollableWrap(Environment env, T node) {
  43         super(env, node);
  44     }
  45 
  46     /**
  47      * Returns the screen bounds of this Scrollable
  48      *
  49      * @return A Rectangle describing the screen bounds of this Scrollable
  50      */
  51     @Override
  52     public Rectangle getScreenBounds() {
  53         return getScreenBounds(Scrollable.class.cast(getControl()), getEnvironment());
  54     }
  55 
  56     /**
  57      * Returns the screen bounds of this Scrollable
  58      *
  59      * @param scrollable This Scrollable
  60      * @param env The environment
  61      * @return A Rectangle describing the screen bounds of this Scrollable
  62      */
  63     public static Rectangle getScreenBounds(Scrollable scrollable, Environment env) {
  64         Rectangle res = getBounds(scrollable, env);
  65         org.eclipse.swt.graphics.Point loc = getScreenLocation(scrollable, env);
  66         res.x = loc.x;
  67         res.y = loc.y;
  68         return res;
  69     }
  70 
  71     /**
  72      * Returns a rectangle describing the visible part of the supplied
  73      * Scrollable.
  74      *
  75      * @see org.eclipse.swt.widgets.Scrollable#getClientArea()
  76      * @param scrollable The Scrollable for which to get the client area
  77      * @param env The Jemmy Environment
  78      * @return A rectangle describing the visible part of this scrollable
  79      */
  80     public static Rectangle getBounds(final Scrollable scrollable, Environment env) {
  81         GetAction<org.eclipse.swt.graphics.Rectangle> action = new GetAction<org.eclipse.swt.graphics.Rectangle>() {
  82 
  83             @Override
  84             public void run(Object... parameters) {
  85                 setResult(scrollable.getClientArea());
  86             }
  87 
  88             @Override
  89             public String toString() {
  90                 return "Getting bounds (client area) for " + scrollable;
  91             }
  92         };
  93         env.getExecutor().execute(env, true, action);
  94         org.eclipse.swt.graphics.Rectangle res = action.getResult();
  95         return new Rectangle(res.x, res.y, res.width, res.height);
  96     }
  97 }