Eclipse Platform
Release 3.6

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
 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 Detail

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 -
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 -
Returns:
true if the element should be gray

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.