org.dominokit.domino.ui.utils.ParentTreeItem Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2019 Dominokit
 *
 * 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.
 */
package org.dominokit.domino.ui.utils;

import java.util.List;
import java.util.Optional;
import org.dominokit.domino.ui.tree.Tree;
import org.dominokit.domino.ui.tree.TreeItemFilter;

/**
 * An interface representing a parent tree item
 *
 * @param  the type of the object
 */
public interface ParentTreeItem {
  /** @return The current active value */
  T getActiveItem();

  /**
   * Activates the item representing the value
   *
   * @param activeItem the value of the item to activate
   */
  void setActiveItem(T activeItem);

  /**
   * Activates the item representing the value
   *
   * @param activeItem the value of the item to activate
   * @param silent true to not notify listeners
   */
  void setActiveItem(T activeItem, boolean silent);

  /** @return The {@link Tree} */
  Tree getTreeRoot();

  /** @return true if automatic expanding is enabled when finding items in search */
  boolean isAutoExpandFound();

  /**
   * Expands the tree item
   *
   * @return same instance
   */
  ParentTreeItem expand();

  /**
   * Expands the tree item
   *
   * @param expandParent true to expand the parent of the item
   * @return same instance
   */
  ParentTreeItem expand(boolean expandParent);

  /** Activates the item */
  void activate();

  /**
   * Activates the item
   *
   * @param activateParent true to activate parent
   */
  void activate(boolean activateParent);

  /** @return the parent item */
  Optional getParent();

  /**
   * Removes item
   *
   * @param item the item value
   */
  void removeItem(T item);

  /** @return the children of this item */
  List getSubItems();

  /** @return the {@link TreeItemFilter} */
  TreeItemFilter getFilter();
}