org.assertj.swing.driver.JScrollPaneDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation
Fluent interface for functional GUI testing
There is a newer version: 3.17.1
/**
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2015 the original author or authors.
 */
package org.assertj.swing.driver;

import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.edt.GuiActionRunner.execute;

import javax.annotation.Nonnull;
import javax.swing.JScrollBar;
import javax.swing.JScrollPane;

import org.assertj.swing.annotation.RunsInEDT;
import org.assertj.swing.core.Robot;
import org.assertj.swing.edt.GuiQuery;
import org.assertj.swing.internal.annotation.InternalApi;

/**
 * 
 * Supports functional testing of {@code JScrollPane}s.
 * 
 * 
 * 
 * Note: This class is intended for internal use only. Please use the classes in the package
 * {@link org.assertj.swing.fixture} in your tests.
 * 
 * 
 * @author Yvonne Wang
 */
@InternalApi
public class JScrollPaneDriver extends JComponentDriver {
  /**
   * Creates a new {@link JScrollPaneDriver}.
   * 
   * @param robot the robot the robot to use to simulate user input.
   */
  public JScrollPaneDriver(@Nonnull Robot robot) {
    super(robot);
  }

  /**
   * Returns the horizontal {@code JScrollBar} in the given {@code JScrollPane}.
   * 
   * @param scrollPane the given {@code JScrollBar}.
   * @return the horizontal scroll bar in the given {@code JScrollBar}.
   */
  @RunsInEDT
  public @Nonnull JScrollBar horizontalScrollBarIn(@Nonnull JScrollPane scrollPane) {
    return horizontalScrollBar(scrollPane);
  }

  @RunsInEDT
  private static @Nonnull JScrollBar horizontalScrollBar(final @Nonnull JScrollPane scrollPane) {
    JScrollBar result = execute(new GuiQuery() {
      @Override
      protected JScrollBar executeInEDT() {
        return scrollPane.getHorizontalScrollBar();
      }
    });
    return checkNotNull(result);
  }

  /**
   * Returns the vertical {@code JScrollBar} in the given {@code JScrollPane}.
   * 
   * @param scrollPane the given {@code JScrollBar}.
   * @return the vertical scroll bar in the given {@code JScrollBar}.
   */
  @RunsInEDT
  public @Nonnull JScrollBar verticalScrollBarIn(@Nonnull JScrollPane scrollPane) {
    return verticalScrollBar(scrollPane);
  }

  @RunsInEDT
  private static @Nonnull JScrollBar verticalScrollBar(final @Nonnull JScrollPane scrollPane) {
    JScrollBar result = execute(new GuiQuery() {
      @Override
      protected JScrollBar executeInEDT() {
        return scrollPane.getVerticalScrollBar();
      }
    });
    return checkNotNull(result);
  }
}