org.eclipse.jface.viewers.ICheckStateProvider.java Source code

Introduction

Here is the source code for org.eclipse.jface.viewers.ICheckStateProvider.java

Source

/*******************************************************************************
 * Copyright (c) 2008, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.jface.viewers;

/**
 * Interface to provide checked and grayed state information about data in trees
 * or tables. The following chart determines the checkbox state:
 * <table border="1" style="text-align: center;">
 * <tr>
 * <td></td>
 * <td></td>
 * <td colspan="2"><strong><code>isGrayed()</code></strong></td>
 * </tr>
 * <tr>
 * <td></td>
 * <td></td>
 * <td><code>false</code></td>
 * <td><code>true</code></td>
 * </tr>
 * <tr>
 * <td rowspan="2"><strong><code>isChecked()</code></strong></td>
 * <td><code>false</code></td>
 * <td colspan="2">unchecked</td>
 * </tr>
 * <tr>
 * <td><code>true</code></td>
 * <td>checked</td>
 * <td>grayed</td>
 * </tr>
 * </table>
 *
 * @since 3.5
 */
public interface ICheckStateProvider {

    /**
     * Indicates if an element's representation should appear as checked or
     * gray instead of unchecked. If this method returns <code>true</code>
     * the {@link ICheckStateProvider#isGrayed(Object)} method will determine
     * whether the check box displays a check mark ("checked") or a box
     * ("grayed").
     * @param element the element to get state for
     * @return true if the element should be checked or grayed, false if it
     *       should be unchecked
     */
    public boolean isChecked(Object element);

    /**
     * Indicates whether the check box associated with an element, when checked
     * as indicated by the {@link ICheckStateProvider#isChecked(Object)} method,
     * should display the gray (boxed) state instead of the check mark.
     * @param element the element to get state for
     * @return true if the element should be gray
     */
    public boolean isGrayed(Object element);
}