org.tinymediamanager.ui.components.treetable.TmmTreeTableCheckRenderDataProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 - 2019 Manuel Laggner
 *
 * 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.tinymediamanager.ui.components.treetable;

/**
 * An extension to {@link TmmTreeTableRenderDataProvider} adding a possibility to display a check box in the tree portion of the TreeTable, next to
 * the label.
 *
 * @author Manuel Laggner
 */
interface TmmTreeTableCheckRenderDataProvider extends TmmTreeTableRenderDataProvider {
  /**
   * Tell the renderer to display the check-box.
   *
   * @param tree
   *          the tree
   * @return true/false
   */
  boolean isCheckable(Object tree);

  /**
   * Provide the enabled state of the check-box.
   *
   * @param tree
   *          the tree
   * @return true/false
   */
  boolean isCheckEnabled(Object tree);

  /**
   * Provide the selected state of the check-box.
   * 
   * @param tree
   *          the tree
   * @return true/false
   */
  Boolean isSelected(Object tree);

  /**
   * Called by the renderer when the check-box gets selected/unselected
   * 
   * @param tree
   *          the tree
   * @param selected
   *          true if the check-box was selected, false if the check-box was unselected.
   */
  void setSelected(Object tree, Boolean selected);
}