org.assertj.swing.fixture.JTreePathFixture 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
Assertj-Swing test framework
The newest version!
/*
 * 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.fixture;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import org.assertj.core.util.VisibleForTesting;
import org.assertj.swing.core.MouseButton;
import org.assertj.swing.core.MouseClickInfo;

/**
 * Supports functional testing of single nodes, referenced by their paths, in {@code JTree}s.
 *
 * @author Alex Ruiz
 * @author Christian Rösch
 */
public class JTreePathFixture implements JTreeNodeFixture {
  private final JTreeFixture tree;
  private final String path;

  /**
   * Creates a new {@link JTreePathFixture}.
   *
   * @param tree handles the {@code JTree} containing the node with the given path.
   * @param path the given path.
   */
  protected JTreePathFixture(@NotNull JTreeFixture tree, @NotNull String path) {
    this.tree = tree;
    this.path = path;
  }

  /**
   * Simulates a user expanding this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   * @throws org.assertj.swing.exception.ActionFailedException if this method fails to expand the path.
   */
  @Override
  @NotNull
  public JTreePathFixture expand() {
    tree.expandPath(path());
    return this;
  }

  /**
   * Simulates a user collapsing this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   * @throws org.assertj.swing.exception.ActionFailedException if this method fails to collapse the path.
   */
  @Override
  @NotNull
  public JTreePathFixture collapse() {
    tree.collapsePath(path());
    return this;
  }

  /**
   * Selects the this fixture's tree node, expanding parent nodes if necessary. This method will not click the node if
   * it is already selected.
   *
   * @return this fixture.
   * @throws IllegalStateException if this fixture's {@code JTree} is disabled.
   * @throws IllegalStateException if this fixture's {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture select() {
    tree.selectPath(path());
    return this;
  }

  /**
   * Unselects the this fixture's tree node, expanding parent nodes if necessary. This method will not click the node if
   * it is not selected.
   *
   * @return this fixture.
   * @throws IllegalStateException if this fixture's {@code JTree} is disabled.
   * @throws IllegalStateException if this fixture's {@code JTree} is not showing on the screen.
   */
  @NotNull
  public JTreePathFixture unselect() {
    tree.unselectPath(path());
    return this;
  }

  /**
   * Simulates a user clicking this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture click() {
    tree.clickPath(path());
    return this;
  }

  /**
   * Simulates a user clicking this fixture's tree node.
   *
   * @param button the button to click.
   * @return this fixture.
   * @throws NullPointerException if the given button is {@code null}.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture click(@NotNull MouseButton button) {
    tree.clickPath(path(), button);
    return this;
  }

  /**
   * Simulates a user clicking this fixture's tree node.
   *
   * @param mouseClickInfo specifies the button to click and the times the button should be clicked.
   * @return this fixture.
   * @throws NullPointerException if the given {@code MouseClickInfo} is {@code null}.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture click(@NotNull MouseClickInfo mouseClickInfo) {
    tree.clickPath(path(), mouseClickInfo);
    return this;
  }

  /**
   * Simulates a user double-clicking this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture doubleClick() {
    tree.doubleClickPath(path());
    return this;
  }

  /**
   * Simulates a user right-clicking this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture rightClick() {
    tree.rightClickPath(path());
    return this;
  }

  /**
   * Simulates a user dragging this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   */
  @Override
  @NotNull
  public JTreePathFixture drag() {
    tree.drag(path());
    return this;
  }

  /**
   * Simulates a user dropping relative to this fixture's tree node.
   *
   * @return this fixture.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   * @throws org.assertj.swing.exception.ActionFailedException if there is no drag action in effect.
   */
  @Override
  @NotNull
  public JTreePathFixture drop() {
    tree.drop(path());
    return this;
  }

  /**
   * Shows a pop-up menu using this fixture's tree node as the invoker of the pop-up menu.
   *
   * @return a fixture that handles functional testing of the displayed pop-up menu.
   * @throws IllegalStateException if the {@code JTree} is disabled.
   * @throws IllegalStateException if the {@code JTree} is not showing on the screen.
   * @throws org.assertj.swing.exception.ComponentLookupException if a pop-up menu cannot be found.
   */
  @Override
  @NotNull
  public JPopupMenuFixture showPopupMenu() {
    return tree.showPopupMenuAt(path());
  }

  /**
   * @return the {@code String} representation of this fixture's tree node.
   */
  @Override
  @Nullable
  public String value() {
    return tree.valueAt(path());
  }

  /**
   * @return the path of this fixture's node.
   */
  @NotNull
  public String path() {
    return path;
  }

  @VisibleForTesting
  @NotNull
  JTreeFixture treeFixture() {
    return tree;
  }
}