Repeater

Controller for repeating child components based on a list of items.

A controller for multiple repeated items in a container. The repeater maintains a list of components in a container based on a corresponding list of data items.

When given an updated list, it takes care of adding, removing and reordering the components efficiently without the help of fine-grained information about the changes in the list.

Sample code

// Callbacks for creating a new panel for an item and to update an existing one
Repeater<Person> repeater = new Repeater<>(container,
    PersonPanel::new,
    PersonPanel::setPerson);

ListDataProvider<Person> dataProvider = DataProvider.ofCollection(persons);
repeater.setDataProvider(dataProvider);

new Button("Sort by title", event -> {
  // Repeater automatically re-renders when the data provider changes
  dataProvider.setSortOrder(Person::getTitle, SortDirection.ASCENDING);
}

List<Peson> persons = loadPersons();

// Callbacks for creating a new panel for an item and to update an existing one
Repeater<Person> repeater = new Repeater<>(container,
    PersonPanel::new,
    PersonPanel::setPerson);
repeater.showItems(persons);

new Button("Remove first person", event -> {
  persons.remove(0);
  // Call showItems with a new or an updated list to update the UI
  repeater.showItems(persons);
});

Links

• View on GitHub

Compatibility