Eclipse Platform
Release 3.1

org.eclipse.ui.dialogs
Class ContainerCheckedTreeViewer

java.lang.Object
  extended byorg.eclipse.jface.viewers.Viewer
      extended byorg.eclipse.jface.viewers.ContentViewer
          extended byorg.eclipse.jface.viewers.StructuredViewer
              extended byorg.eclipse.jface.viewers.AbstractTreeViewer
                  extended byorg.eclipse.jface.viewers.TreeViewer
                      extended byorg.eclipse.jface.viewers.CheckboxTreeViewer
                          extended byorg.eclipse.ui.dialogs.ContainerCheckedTreeViewer
All Implemented Interfaces:
ICheckable, IInputProvider, IInputSelectionProvider, IPostSelectionProvider, ISelectionProvider

public class ContainerCheckedTreeViewer
extends CheckboxTreeViewer

CheckboxTreeViewer with special behaviour of the checked / gray state on container (non-leaf) nodes: The grayed state is used to visualize the checked state of its children. Containers are checked and non-gray if all contained leafs are checked. The container is grayed if some but not all leafs are checked.

Since:
3.1

Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.viewers.StructuredViewer
StructuredViewer.ColorAndFontCollectorWithProviders
 
Field Summary
 
Fields inherited from class org.eclipse.jface.viewers.AbstractTreeViewer
ALL_LEVELS
 
Fields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY
 
Constructor Summary
ContainerCheckedTreeViewer(Composite parent)
          Constructor for ContainerCheckedTreeViewer.
ContainerCheckedTreeViewer(Composite parent, int style)
          Constructor for ContainerCheckedTreeViewer.
ContainerCheckedTreeViewer(Tree tree)
          Constructor for ContainerCheckedTreeViewer.
 
Method Summary
protected  void doCheckStateChanged(Object element)
          Update element after a checkstate change.
 Object[] getCheckedElements()
          Returns a list of checked elements in this viewer's tree, including currently hidden ones that are marked as checked but are under a collapsed ancestor.
 boolean setChecked(Object element, boolean state)
          Sets the checked state for the given element in this viewer.
 void setCheckedElements(Object[] elements)
          Sets which elements are checked in this viewer's tree.
protected  void setExpanded(Item item, boolean expand)
          Sets the expand state of the given item.
 
Methods inherited from class org.eclipse.jface.viewers.CheckboxTreeViewer
addCheckStateListener, fireCheckStateChanged, getChecked, getGrayed, getGrayedElements, handleDoubleSelect, handleSelect, preservingSelection, removeCheckStateListener, setGrayChecked, setGrayed, setGrayedElements, setParentsGrayed, setSubtreeChecked
 
Methods inherited from class org.eclipse.jface.viewers.TreeViewer
addTreeListener, cancelEditing, doUpdateItem, editElement, getCellEditors, getCellModifier, getChild, getChildren, getColumnProperties, getControl, getExpanded, getItem, getItemCount, getItemCount, getItems, getLabelProvider, getParentItem, getSelection, getTree, hookControl, isCellEditorActive, isSameSelection, newItem, removeAll, setCellEditors, setCellModifier, setColumnProperties, setLabelProvider, setSelection, showItem
 
Methods inherited from class org.eclipse.jface.viewers.AbstractTreeViewer
add, add, addSelectionListener, addTreeListener, associate, collapseAll, collapseToLevel, createChildren, createTreeItem, disassociate, doFindInputItem, doFindItem, doUpdateItem, expandAll, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getExpandedElements, getExpandedState, getNextItem, getPreviousItem, getRawChildren, getSelectionFromWidget, getVisibleExpandedElements, handleTreeCollapse, handleTreeExpand, indexForElement, inputChanged, internalAdd, internalCollapseToLevel, internalExpand, internalExpandToLevel, internalGetWidgetToSelect, internalRefresh, internalRefresh, internalRefresh, internalRemove, isExpandable, labelProviderChanged, remove, remove, removeTreeListener, reveal, scrollDown, scrollUp, setAutoExpandLevel, setContentProvider, setExpandedElements, setExpandedState, setSelectionToWidget, updateChildren, updatePlus
 
Methods inherited from class org.eclipse.jface.viewers.StructuredViewer
addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertContentProviderType, assertElementsNotNull, buildLabel, equals, filter, findItem, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparer, getFilteredChildren, getFilters, getRoot, getSelection, getSortedChildren, getSorter, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, hasFilters, internalUpdate, mapElement, needsRefilter, refresh, refresh, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparer, setInput, setSelection, setSelectionToWidget, setSorter, setUseHashlookup, testFindItem, unmapAllElements, unmapElement, unmapElement, update, update, updateItem, updateSelection, usingElementMap
 
Methods inherited from class org.eclipse.jface.viewers.ContentViewer
getContentProvider, getInput, handleDispose
 
Methods inherited from class org.eclipse.jface.viewers.Viewer
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, setData, setSelection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider
addSelectionChangedListener, removeSelectionChangedListener, setSelection
 

Constructor Detail

ContainerCheckedTreeViewer

public ContainerCheckedTreeViewer(Composite parent)
Constructor for ContainerCheckedTreeViewer.

See Also:
CheckboxTreeViewer.CheckboxTreeViewer(Composite)

ContainerCheckedTreeViewer

public ContainerCheckedTreeViewer(Composite parent,
                                  int style)
Constructor for ContainerCheckedTreeViewer.

See Also:
CheckboxTreeViewer.CheckboxTreeViewer(Composite,int)

ContainerCheckedTreeViewer

public ContainerCheckedTreeViewer(Tree tree)
Constructor for ContainerCheckedTreeViewer.

See Also:
CheckboxTreeViewer.CheckboxTreeViewer(Tree)
Method Detail

doCheckStateChanged

protected void doCheckStateChanged(Object element)
Update element after a checkstate change.

Parameters:
element -

setChecked

public boolean setChecked(Object element,
                          boolean state)
Description copied from interface: ICheckable
Sets the checked state for the given element in this viewer.

Specified by:
setChecked in interface ICheckable
Overrides:
setChecked in class CheckboxTreeViewer

setCheckedElements

public void setCheckedElements(Object[] elements)
Description copied from class: CheckboxTreeViewer
Sets which elements are checked in this viewer's tree. The given list contains the elements that are to be checked; all other elements are to be unchecked.

This method is typically used when restoring the interesting state of a viewer captured by an earlier call to getCheckedElements.

Overrides:
setCheckedElements in class CheckboxTreeViewer
Parameters:
elements - the array of checked elements
See Also:
CheckboxTreeViewer.getCheckedElements()

setExpanded

protected void setExpanded(Item item,
                           boolean expand)
Description copied from class: AbstractTreeViewer
Sets the expand state of the given item.

Overrides:
setExpanded in class TreeViewer

getCheckedElements

public Object[] getCheckedElements()
Description copied from class: CheckboxTreeViewer
Returns a list of checked elements in this viewer's tree, including currently hidden ones that are marked as checked but are under a collapsed ancestor.

This method is typically used when preserving the interesting state of a viewer; setCheckedElements is used during the restore.

Overrides:
getCheckedElements in class CheckboxTreeViewer
Returns:
the array of checked elements
See Also:
CheckboxTreeViewer.setCheckedElements(java.lang.Object[])

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.