Package org.eclipse.jface.viewers

Interface ICheckStateProvider

public interface ICheckStateProvider

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

Method Summary

Modifier and Type	Method	Description
boolean	isChecked(Object element)	Indicates if an element's representation should appear as checked or gray instead of unchecked.
boolean	isGrayed(Object element)	Indicates whether the check box associated with an element, when checked as indicated by the isChecked(Object) method, should display the gray (boxed) state instead of the check mark.

Method Details

isChecked

boolean isChecked(Object element)

Indicates if an element's representation should appear as checked or gray instead of unchecked. If this method returns true the isGrayed(Object) method will determine whether the check box displays a check mark ("checked") or a box ("grayed").

Parameters:

element - the element to get state for

Returns:

true if the element should be checked or grayed, false if it should be unchecked

isGrayed

boolean isGrayed(Object element)

Indicates whether the check box associated with an element, when checked as indicated by the isChecked(Object) method, should display the gray (boxed) state instead of the check mark.

Parameters:

element - the element to get state for

Returns:

true if the element should be gray