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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-ui Show documentation

There is a newer version: 2.0.3

/*
 * 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;

/**
 * Components that needs to support selection of items can implement this interface
 *
 * @param  the type of items being selected
 */
public interface HasSelectionSupport {

  /** @return a List of all currently selected items */
  List getSelectedItems();

  /** @deprecated use {@link #getRows()} */
  @Deprecated
  List getItems();

  /** @return a List of all selected and not selected items */
  List getRows();

  /**
   * Called when an item selection is changed, implementation can delegate to a list listeners
   *
   * @param source T item that has its selection changed
   */
  void onSelectionChange(T source);

  /** @return boolean, true if the component allows selection otherwise false. */
  boolean isSelectable();

  /** Select all not selected items */
  default void selectAll() {}

  /** Deselect all currently selected items */
  default void deselectAll() {}
}