test/jdk/sanity/client/lib/jemmy/src/org/netbeans/jemmy/drivers/ScrollDriver.java

/*
 * Copyright (c) 1997, 2016, 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.netbeans.jemmy.drivers;

import org.netbeans.jemmy.drivers.scrolling.ScrollAdjuster;
import org.netbeans.jemmy.operators.ComponentOperator;

/**
 * Defines how to work with scrollable components such as
 * {@code javax.swing.JScrollBar}, {@code javax.swing.JScrollPane},
 * {@code javax.swing.JSlider}, ...
 *
 * @author Alexandre Iline (alexandre.iline@oracle.com)
 */
public interface ScrollDriver {

    /**
     * Changes value to a minimum.
     *
     * @param oper Scroller operator.
     * @param orientation {@code java.awt.Adjustable.HORIZONTAL} or
     * {@code java.awt.Adjustable.VERTICAL}
     */
    public void scrollToMinimum(ComponentOperator oper, int orientation);

    /**
     * Changes value to a maximum.
     *
     * @param oper Scroller operator.
     * @param orientation {@code java.awt.Adjustable.HORIZONTAL} or
     * {@code java.awt.Adjustable.VERTICAL}
     */
    public void scrollToMaximum(ComponentOperator oper, int orientation);

    /**
     * Changes value.
     *
     * @param oper Scroller operator.
     * @param adj Object defines scroll position.
     */
    public void scroll(ComponentOperator oper, ScrollAdjuster adj);
}