org.assertj.swing.driver.JScrollBarLocation 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-2018 the original author or authors.
 */
package org.assertj.swing.driver;

import static java.awt.Adjustable.HORIZONTAL;
import static java.awt.Adjustable.VERTICAL;
import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.util.Maps.newHashMap;

import java.awt.Point;
import java.util.Map;

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

import org.assertj.swing.annotation.RunsInCurrentThread;

/**
 * A location in a {@code JScrollBar}.
 *
 * @author Yvonne Wang
 * @author Alex Ruiz
 */
public final class JScrollBarLocation {
  // TODO Test horizontal scroll bar

  private static final int BLOCK_OFFSET = 4;

  private static final Map LOCATIONS = newHashMap();

  static {
    LOCATIONS.put(HORIZONTAL, new HorizontalJScrollBarLocation());
    LOCATIONS.put(VERTICAL, new VerticalJScrollBarLocation());
  }

  /**
   * 
   * Returns the location where to move the mouse pointer to scroll to the given position.
   * 
   *
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   *
   * @param scrollBar the target {@code JScrollBar}.
   * @param position the position to scroll to.
   * @return the location where to move the mouse pointer to scroll to the given position.
   */
  @RunsInCurrentThread
  @Nonnull public Point thumbLocation(@Nonnull JScrollBar scrollBar, int position) {
    double fraction = (double) position / maximumMinusMinimum(scrollBar);
    return locationStrategyFor(scrollBar).thumbLocation(scrollBar, fraction);
  }

  @RunsInCurrentThread
  private int maximumMinusMinimum(@Nonnull JScrollBar scrollBar) {
    return scrollBar.getMaximum() - scrollBar.getMinimum();
  }

  /**
   * 
   * Returns the location where to move the mouse pointer to scroll one block up (or right).
   * 
   *
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   *
   * @param scrollBar the target {@code JScrollBar}.
   * @return the location where to move the mouse pointer to scroll one block up (or right).
   */
  @RunsInCurrentThread
  @Nonnull public Point blockLocationToScrollUp(@Nonnull JScrollBar scrollBar) {
    Point p = unitLocationToScrollUp(scrollBar);
    int offset = BLOCK_OFFSET;
    return blockLocation(scrollBar, p, offset);
  }

  /**
   * 
   * Returns the location where to move the mouse pointer to scroll one block down (or left).
   * 
   *
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   *
   * @param scrollBar the target {@code JScrollBar}.
   * @return the location where to move the mouse pointer to scroll one block down (or left).
   */
  @RunsInCurrentThread
  @Nonnull public Point blockLocationToScrollDown(@Nonnull JScrollBar scrollBar) {
    Point p = unitLocationToScrollDown(scrollBar);
    int offset = -BLOCK_OFFSET;
    return blockLocation(scrollBar, p, offset);
  }

  @RunsInCurrentThread
  @Nonnull private Point blockLocation(@Nonnull JScrollBar scrollBar, @Nonnull Point unitLocation, int offset) {
    return locationStrategyFor(scrollBar).blockLocation(scrollBar, unitLocation, offset);
  }

  /**
   * 
   * Returns the location where to move the mouse pointer to scroll one unit up (or right).
   * 
   *
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   *
   * @param scrollBar the target {@code JScrollBar}.
   * @return the location where to move the mouse pointer to scroll one unit up (or right).
   */
  @RunsInCurrentThread
  @Nonnull public Point unitLocationToScrollUp(@Nonnull JScrollBar scrollBar) {
    int arrow = locationStrategyFor(scrollBar).arrow(scrollBar);
    return new Point(arrow / 2, arrow / 2);
  }

  /**
   * 
   * Returns the location where to move the mouse pointer to scroll one unit down (or left).
   * 
   *
   * 
   * Note: This method is accessed in the current executing thread. Such thread may or may not be the event
   * dispatch thread (EDT). Client code must call this method from the EDT.
   * 
   *
   * @param scrollBar the target {@code JScrollBar}.
   * @return the location where to move the mouse pointer to scroll one unit down (or left).
   */
  @RunsInCurrentThread
  @Nonnull public Point unitLocationToScrollDown(@Nonnull JScrollBar scrollBar) {
    return locationStrategyFor(scrollBar).unitLocationToScrollDown(scrollBar);
  }

  @RunsInCurrentThread
  @Nonnull private JScrollBarLocationStrategy locationStrategyFor(JScrollBar scrollBar) {
    JScrollBarLocationStrategy strategy = LOCATIONS.get(scrollBar.getOrientation());
    return checkNotNull(strategy);
  }
}