Attachment 1083 Details for Bug 17907 – updated ContainerCheckedTreeViewer

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

updated ContainerCheckedTreeViewer

ContainerCheckedTreeViewer.java (text/plain), 6.71 KB, created by Martin Aeschlimann

on 2002-05-28 04:56:08 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Aeschlimann

Created: 2002-05-28 04:56:08 EDT

Size: 6.71 KB

patch

obsolete

>package org.eclipse.ui.internal.dialogs;
>/*
> * (c) Copyright IBM Corp. 2000, 2001, 2002.
> * All Rights Reserved.
> */
>import java.util.ArrayList;
>
>import org.eclipse.swt.widgets.Composite;
>import org.eclipse.swt.widgets.Item;
>import org.eclipse.swt.widgets.Tree;
>import org.eclipse.swt.widgets.TreeItem;
>import org.eclipse.swt.widgets.Widget;
>
>import org.eclipse.jface.viewers.CheckStateChangedEvent;
>import org.eclipse.jface.viewers.CheckboxTreeViewer;
>import org.eclipse.jface.viewers.ICheckStateListener;
>import org.eclipse.jface.viewers.ITreeViewerListener;
>import org.eclipse.jface.viewers.TreeExpansionEvent;
>
>
>/**
> * 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.
> */
>public class ContainerCheckedTreeViewer extends CheckboxTreeViewer {
>	
>	/**
>	 * Constructor for ContainerCheckedTreeViewer.
>	 * @see CheckboxTreeViewer#CheckboxTreeViewer(Composite)
>	 */
>	public ContainerCheckedTreeViewer(Composite parent) {
>		super(parent);
>		initViewer();
>	}
>	
>	/**
>	 * Constructor for ContainerCheckedTreeViewer.
>	 * @see CheckboxTreeViewer#CheckboxTreeViewer(Composite,int)
>	 */
>	public ContainerCheckedTreeViewer(Composite parent, int style) {
>		super(parent, style);
>		initViewer();
>	}
>
>	/**
>	 * Constructor for ContainerCheckedTreeViewer.
>	 * @see CheckboxTreeViewer#CheckboxTreeViewer(Tree)
>	 */
>	public ContainerCheckedTreeViewer(Tree tree) {
>		super(tree);
>		initViewer();
>	}
>	
>	private void initViewer() {
>		setUseHashlookup(true);
>		addCheckStateListener(new ICheckStateListener() {
>			public void checkStateChanged(CheckStateChangedEvent event) {
>				doCheckStateChanged(event.getElement());
>			}
>		});
>		addTreeListener(new ITreeViewerListener() {
>			public void treeCollapsed(TreeExpansionEvent event) {
>			}
>			public void treeExpanded(TreeExpansionEvent event) {
>				Widget item= findItem(event.getElement());
>				if (item instanceof TreeItem) {
>					initializeItem((TreeItem) item);
>				}
>			}
>		});
>	}		
>	
>	protected void doCheckStateChanged(Object element) {
>		Widget item= findItem(element);
>		if (item instanceof TreeItem) {
>			TreeItem treeItem= (TreeItem) item;
>			treeItem.setGrayed(false);
>			updateChildrenItems(treeItem);
>			updateParentItems(treeItem.getParentItem());
>		}
>	}
>	
>	/**
>	 * The item has expanded. Updates the checked state of its children. 
>	 */
>	private void initializeItem(TreeItem item) {
>		if (item.getChecked() && !item.getGrayed()) {
>			updateChildrenItems((TreeItem) item);
>		}
>	}
>
>	/**
>	 * Updates the check state of all created children
>	 */	
>	private void updateChildrenItems(TreeItem parent) {
>		Item[] children= getChildren(parent);
>		boolean state= parent.getChecked();
>		for (int i= 0; i < children.length; i++) {
>			TreeItem curr= (TreeItem) children[i];
>			if (curr.getData() != null && ((curr.getChecked() != state) || curr.getGrayed())) {
>				curr.setChecked(state);
>				curr.setGrayed(false);
>				updateChildrenItems(curr);
>			}
>		}
>	}
>	
>	/**
>	 * Updates the check / gray state of all parent items
>	 */
>	private void updateParentItems(TreeItem item) {
>		if (item != null) {
>			Item[] children= getChildren(item);
>			boolean containsChecked= false;
>			boolean containsUnchecked= false;
>			for (int i= 0; i < children.length; i++) {
>				TreeItem curr= (TreeItem) children[i];
>				containsChecked |= curr.getChecked();
>				containsUnchecked |= (!curr.getChecked() || curr.getGrayed());
>			}
>			item.setChecked(containsChecked);
>			item.setGrayed(containsChecked && containsUnchecked);
>			updateParentItems(item.getParentItem());
>		}
>	}
>
>	/*
>	 * @see ICheckable#setChecked(Object, boolean)
>	 */
>	public boolean setChecked(Object element, boolean state) {
>		if (super.setChecked(element, state)) {
>			doCheckStateChanged(element);
>			return true;
>		}
>		return false;
>	}
>
>	/*
>	 * @see CheckboxTreeViewer#setCheckedElements(Object[])
>	 */
>	public void setCheckedElements(Object[] elements) {
>		super.setCheckedElements(elements);
>		for (int i= 0; i < elements.length; i++) {
>			doCheckStateChanged(elements[i]);
>		}
>	}
>	
>	/*
>	 * @see AbstractTreeViewer#setExpanded(Item, boolean)
>	 */
>	protected void setExpanded(Item item, boolean expand) {
>		super.setExpanded(item, expand);
>		if (expand && item instanceof TreeItem) {
>			initializeItem((TreeItem) item);
>		}
>	}
>
>	/*
>	 * @see CheckboxTreeViewer#getCheckedElements()
>	 */
>	public Object[] getCheckedElements() {
>		Object[] checked= super.getCheckedElements();
>		// add all items that are children of a checked node but not created yet
>		ArrayList result= new ArrayList();
>		for (int i= 0; i < checked.length; i++) {
>			Object curr= checked[i];
>			result.add(curr);
>			Widget item= findItem(curr);
>			if (item != null) {
>				Item[] children= getChildren(item);
>				// check if contains the dummy node
>				if (children.length == 1 && children[0].getData() == null) {
>					// not yet created
>					collectChildren(curr, result);
>				}
>			}
>		}
>		return result.toArray();
>	}
>	
>	private void collectChildren(Object element, ArrayList result) {
>		Object[] filteredChildren= getFilteredChildren(element);
>		for (int i= 0; i < filteredChildren.length; i++) {
>			Object curr= filteredChildren[i];
>			result.add(curr);
>			collectChildren(curr, result);
>		}
>	}
>	
>	/**
>	 * Ensures the correct children / parent state of all checked elements
>	 */
>	private void validateChecked(TreeItem treeItem) {
>		if (treeItem.getChecked() && !treeItem.getGrayed()) {
>			// check all children
>			updateChildrenItems(treeItem);
>		} else {
>			// look at children to evaluate the own checked / gray state
>			boolean containsChecked= false;
>			boolean containsUnchecked= false;
>			Item[] items = getChildren(treeItem);
>			for (int i = 0; i < items.length; i++) {
>				Item item= items[i];
>				if (item instanceof TreeItem && item.getData() != null) {
>					TreeItem curr= (TreeItem) item;
>					validateChecked(curr);
>					containsChecked |= curr.getChecked();
>					containsUnchecked |= (!curr.getChecked() || curr.getGrayed());	
>				}
>			}
>			treeItem.setChecked(containsChecked);
>			treeItem.setGrayed(containsChecked && containsUnchecked);
>		}
>	}
>	
>	/* (non-Javadoc)
>	 * Method declared on Viewer.
>	 */
>	protected void preservingSelection(Runnable updateCode) {
>		super.preservingSelection(updateCode);
>
>		Item[] items = getChildren(getControl());
>		for (int i = 0; i < items.length; i++) {
>			Item item= items[i];
>			if (item instanceof TreeItem) {
>				validateChecked((TreeItem) item);
>			}
>		}
>	}
>
>}

Actions: View

Attachments on bug 17907: 1083