org.assertj.swing.driver.JTableLocation 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 java.awt.Point;
import java.awt.Rectangle;

import javax.annotation.Nonnull;
import javax.swing.JTable;

import org.assertj.swing.annotation.RunsInCurrentThread;
import org.assertj.swing.data.TableCell;

/**
 * A visible location on a {@code JTable}.
 * 
 * @author Yvonne Wang
 * @author Alex Ruiz
 */
public final class JTableLocation {
  /**
   * 
   * Converts the given row and column into a coordinate pair. It is assumed that the row and column indices are in the
   * {@code JTable}'s bounds.
   * 
   * 
   * 
   * 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 table the target {@code JTable}.
   * @param row the given row.
   * @param column the given column.
   * @return the coordinates of the given row and column.
   */
  @RunsInCurrentThread
  public @Nonnull Point pointAt(@Nonnull JTable table, int row, int column) {
    Rectangle cellBounds = cellBounds(table, row, column);
    return new Point(cellBounds.x + cellBounds.width / 2, cellBounds.y + cellBounds.height / 2);
  }

  /**
   * 
   * Returns the bounds of the given cell.
   * 
   * 
   * 
   * 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 table the target {@code JTable}.
   * @param cell the given cell.
   * @return the bounds of the given cell.
   */
  @RunsInCurrentThread
  public @Nonnull Rectangle cellBounds(@Nonnull JTable table, @Nonnull TableCell cell) {
    return cellBounds(table, cell.row, cell.column);
  }

  /**
   * 
   * Returns the bounds of the given row and column.
   * 
   * 
   * 
   * 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 table the target {@code JTable}.
   * @param row the given row.
   * @param column the given column.
   * @return the bounds of the given row and column.
   */
  @RunsInCurrentThread
  public @Nonnull Rectangle cellBounds(JTable table, int row, int column) {
    return checkNotNull(table.getCellRect(row, column, false));
  }
}