common/plugins/org.eclipse.jpt.common.ui/src/org/eclipse/jpt/common/ui/internal/jface/ItemTreeStateProviderManager.java

/*******************************************************************************
 * Copyright (c) 2008, 2012 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.common.ui.internal.jface;

import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jpt.common.ui.internal.util.SWTUtil;
import org.eclipse.jpt.common.ui.jface.ItemExtendedLabelProviderFactory;
import org.eclipse.jpt.common.ui.jface.ItemTreeContentProvider;
import org.eclipse.jpt.common.ui.jface.ItemTreeContentProviderFactory;
import org.eclipse.jpt.common.ui.jface.TreeStateProvider;
import org.eclipse.jpt.common.utility.internal.RunnableAdapter;

/**
 * @see AbstractItemStructuredStateProviderManager
 * @see ItemTreeContentProvider
 */
public class ItemTreeStateProviderManager
	extends AbstractItemStructuredStateProviderManager<TreeViewer, ItemTreeContentProvider>
	implements TreeStateProvider, ItemTreeContentProvider.Manager
{
	/**
	 * Never <code>null</code>.
	 */
	protected final ItemTreeContentProviderFactory itemContentProviderFactory;


	public ItemTreeStateProviderManager(ItemTreeContentProviderFactory itemContentProviderFactory) {
		this(itemContentProviderFactory, null);
	}

	public ItemTreeStateProviderManager(ItemTreeContentProviderFactory itemContentProviderFactory, ItemExtendedLabelProviderFactory itemLabelProviderFactory) {
		super(itemLabelProviderFactory);
		if (itemContentProviderFactory == null) {
			throw new NullPointerException();
		}
		this.itemContentProviderFactory = itemContentProviderFactory;
	}


	// ********** tree content provider **********

	public boolean hasChildren(Object element) {
		ItemTreeContentProvider provider = this.getItemContentProvider(element);
		return (provider != null) && provider.hasChildren();
	}

	public Object[] getChildren(Object parentElement) {
		ItemTreeContentProvider provider = this.getItemContentProvider(parentElement);
		return (provider == null) ? EMPTY_ARRAY : provider.getChildren();
	}

	public Object getParent(Object element) {
		ItemTreeContentProvider provider = this.getItemContentProvider(element);
		return (provider == null) ? null : provider.getParent();
	}

	@Override
	protected ItemTreeContentProvider buildItemContentProvider(Object item) {
		return this.itemContentProviderFactory.buildProvider(item, this);
	}


	// ********** update children **********

	/**
	 * Dispatch to the UI thread.
	 */
	public void updateChildren(Object inputElement) {
		SWTUtil.execute(this.viewer, new UpdateChildrenRunnable(inputElement));
	}

	/* CU private */ class UpdateChildrenRunnable
		extends RunnableAdapter
	{
		private final Object element;
		UpdateChildrenRunnable(Object element) {
			super();
			this.element = element;
		}
		@Override
		public void run() {
			ItemTreeStateProviderManager.this.updateChildren_(this.element);
		}
	}

	/**
	 * Update the specified item's children.
	 */
	/* CU private */ void updateChildren_(Object element) {
		if (this.viewerIsAlive()) {
			this.viewer.refresh(element, false);
		}
	}
}