de.lessvoid.nifty.controls.TreeItem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nifty-default-controls Show documentation
There is a newer version: 1.4.3
Show newest version
/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package de.lessvoid.nifty.controls;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

/**
 * This class represents any element in a tree list.
 *
 * @param  the type that is displayed in the node
 */
public final class TreeItem implements Iterable> {
  /**
   * The children of this tree item.
   */
  @Nonnull
  private final List> children;

  /**
   * The parent of this item.
   */
  @Nullable
  private TreeItem parentItem;

  /**
   * The current state of the item. This only applies in case the node is not the root node and not a leaf.
   */
  private boolean expanded;

  /**
   * The actual value inside this tree node.
   */
  @Nullable
  private T value;

  /**
   * The value how much the tree item is indented. This value is altered by the tree box control.
   */
  private int indent;

  /**
   * Default item for a constructor.
   */
  public TreeItem() {
    children = new ArrayList>();
  }

  /**
   * Default item for a constructor.
   */
  public TreeItem(@Nullable final T itemValue) {
    this();
    value = itemValue;
  }
  
  public void addTreeItem(final TreeItem item) {
      children.add(item);
      item.setParentItem(this);
  }

  public void addTreeItems(@Nonnull final Collection> items) {
      for (TreeItem t : items)
          addTreeItem(t);
  }

  public void removeTreeItem(final TreeItem item) {
      children.remove(item);
      item.setParentItem(null);
  }

  public void removeTreeItems(@Nonnull final Collection> items) {
      for (TreeItem t : items)
          removeTreeItem(t);
  }

  /**
   * Returns an iterator over a set of elements of type T.
   *
   * @return an Iterator.
   */
  @Nonnull
  @Override
  public Iterator> iterator() {
    return children.iterator();
  }

  @Nullable
  public T getValue() {
    return value;
  }

  public void setValue(@Nullable final T value) {
    this.value = value;
  }

  @Nullable
  public TreeItem getParentItem() {
    return parentItem;
  }

  public void setParentItem(@Nullable final TreeItem parentItem) {
    this.parentItem = parentItem;
  }

  public boolean isExpanded() {
    return expanded;
  }

  public void setExpanded(final boolean expanded) {
    this.expanded = expanded;
  }

  /**
   * Check if this tree item is a leaf. So if it does not have any children.
   *
   * @return {@code true} in case this tree item is a leaf
   */
  public boolean isLeaf() {
    return children.isEmpty();
  }

  public int getIndent() {
    return indent;
  }

  public void setIndent(final int indent) {
    this.indent = indent;
  }
}