de.lessvoid.nifty.controls.listbox.ListBoxView 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

package de.lessvoid.nifty.controls.listbox;

import de.lessvoid.nifty.controls.ListBoxSelectionChangedEvent;

import javax.annotation.Nonnull;
import java.util.List;

/**
 * The representation of a ListBoxView from the world of a ListBox.
 *
 * @param  The Item this class is a view for.
 * @author void
 */
public interface ListBoxView {
  /**
   * Display the given descriptions.
   */
  void display(@Nonnull List captions, int focusElementIndex, @Nonnull List selectionElements);

  /**
   * Updates the view with the total count of elements currently in the ListBox.
   * This can be used to update the scrollbar.
   *
   * @param newCount the new count to display
   */
  void updateTotalCount(int newCount);

  /**
   * Update the ListBox view with the given width. This is used to update the horizontal
   * scrollbar to a new maximum value.
   *
   * @param newWidth new maximum width of all items in the ListBox
   */
  void updateTotalWidth(int newWidth);

  /**
   * Scroll the view to the given position.
   *
   * @param newPosition the new index to scroll to
   */
  void scrollTo(int newPosition);

  /**
   * Publish this event.
   *
   * @param event the event to publish
   */
  void publish(@Nonnull ListBoxSelectionChangedEvent event);

  /**
   * Return the width of the given item. This is used to keep track of the maximum width of
   * all items in the ListBox to update the horizontal Scrollbar correctly.
   *
   * @param item the item to get the width for
   * @return the width of the item
   */
  int getWidth(T item);
}