• Home
• io.spring.javaformat
• spring-javaformat-formatter-eclipse-jdk17
• 0.0.43
• source code
• ICheckStateProvider.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.eclipse.jface.viewers.ICheckStateProvider Maven / Gradle / Ivy

/*******************************************************************************
 * 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:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
isGrayed()
false
true
isChecked()
false
unchecked
true
checked
grayed
 *
 * @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 true
	 * 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);
}