org.eclipse.osbp.vaaclipse.additions/src/org/eclipse/osbp/vaaclipse/additions/view/ShowViewDialogContent.java

/*******************************************************************************
 * Copyright (c) 2012 Rushan R. Gilmullin and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0 
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 * 
 * Contributors:
 *     Rushan R. Gilmullin - initial API and implementation
 *******************************************************************************/
 package org.eclipse.osbp.vaaclipse.additions.view;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

import javax.annotation.PostConstruct;
import javax.inject.Inject;

import org.eclipse.e4.core.contexts.IEclipseContext;
import org.eclipse.e4.ui.model.application.MApplication;
import org.eclipse.e4.ui.model.application.descriptor.basic.MPartDescriptor;
import org.eclipse.e4.ui.workbench.modeling.EPartService;
import org.eclipse.e4.ui.workbench.modeling.EPartService.PartState;
import org.eclipse.osbp.e4extension.service.EPartServiceExt;
import org.eclipse.osbp.vaaclipse.publicapi.resources.BundleResource;
import org.eclipse.osbp.vaadin.optiondialog.OptionDialog;
import org.eclipse.osbp.vaadin.optiondialog.OptionDialog.ComponentProvider;

import com.vaadin.data.Container.Filter;
import com.vaadin.data.Container.Filterable;
import com.vaadin.data.Item;
import com.vaadin.data.util.HierarchicalContainer;
import com.vaadin.data.util.filter.SimpleStringFilter;
import com.vaadin.event.FieldEvents.TextChangeListener;
import com.vaadin.event.ItemClickEvent;
import com.vaadin.event.FieldEvents.TextChangeEvent;
import com.vaadin.server.Sizeable.Unit;
import com.vaadin.server.ThemeResource;
import com.vaadin.shared.MouseEventDetails.MouseButton;
import com.vaadin.shared.ui.MarginInfo;
import com.vaadin.ui.Component;
import com.vaadin.ui.Panel;
import com.vaadin.ui.TextField;
import com.vaadin.ui.Tree;
import com.vaadin.ui.Tree.TreeDragMode;
import com.vaadin.ui.VerticalLayout;

/**
 * @author rushan
 *
 */
class ShowViewDialogContent implements ComponentProvider {
	private static final String NAME_PROP = "name";
	private static final String ICON_PROP = "icon";
	private static final String OBJECT_PROP = "object";

	final private static String CATEGORY_TAG = "categoryTag:";
	final private static int CATEGORY_TAG_LENGTH = CATEGORY_TAG.length();

	private Tree tree;
	private Panel panel;
	private HierarchicalContainer container;
	private OptionDialog optionDialog;

	@Inject
	private EPartService partService;

	@Inject
	private EPartServiceExt partServiceExt;

	@Inject
	private MApplication application;

	@Inject
	IEclipseContext context;
	private VerticalLayout content;
	private TextField searchField;

	@Override
	public Component getComponent(OptionDialog optionDialog) {
		this.optionDialog = optionDialog;
		return this.content;
	}

	@PostConstruct
	public void init() {
		content = new VerticalLayout();
		content.setSpacing(true);
		content.setMargin(new MarginInfo(true, true, false, true));
		searchField = new TextField();
		searchField.focus();
		searchField.setWidth(100, Unit.PERCENTAGE);
		searchField.addTextChangeListener(new TextChangeListener() {
			SimpleStringFilter filter = null;

			@Override
			public void textChange(TextChangeEvent event) {
				Filterable f = (Filterable) tree.getContainerDataSource();

				// Remove old filter
				if (filter != null)
					f.removeContainerFilter(filter);

				// Set new filter for the "caption" property
				filter = new SimpleStringFilter(NAME_PROP, event.getText(),
						true, false);
				f.addContainerFilter(filter);
			}
		});
		content.addComponent(searchField);
		panel = new Panel();
		panel.setSizeFull();
		content.addComponent(panel);
		createTree();
		content.setExpandRatio(searchField, 0);
		content.setExpandRatio(panel, 1);
	}

	@Override
	public void optionSelected(OptionDialog optionDialog, int optionId) {
		if (optionId == 0) {
			Object selected = tree.getValue();
			if (selected instanceof MPartDescriptor) {
				optionDialog.close();

				MPartDescriptor descriptor = (MPartDescriptor) selected;
				showView(descriptor);
			}
		} else if (optionId == 1)
			optionDialog.close();
	}

	public void showView(MPartDescriptor... descriptors) {
		for (MPartDescriptor descriptor : descriptors) {
			partServiceExt.showPart(descriptor.getElementId(),
					PartState.ACTIVATE);
		}
	}

	@Override
	public void setMessage(String message) {
	}

	private void createTree() {
		tree = new Tree();
		tree.setDragMode(TreeDragMode.NODE);
		tree.setSizeFull();
		tree.setImmediate(true);
		panel.setContent(tree);

		container = createDataSource();
		tree.setContainerDataSource(container);

		// Set tree to show the 'name' property as caption for items
		tree.setItemCaptionPropertyId(NAME_PROP);
		tree.setItemIconPropertyId(ICON_PROP);

		tree.addItemClickListener(new ItemClickEvent.ItemClickListener() {

			private static final long serialVersionUID = 1L;

			public void itemClick(final ItemClickEvent event) {
				if (event.getButton() == MouseButton.LEFT) {
					Item item = event.getItem();
					Object object = item.getItemProperty(OBJECT_PROP)
							.getValue();
					optionDialog.setOptionEnabled(0,
							object instanceof MPartDescriptor);
				}
			}
		});
	}

	private void setupCategoryItem(Item categoryItem, String category) {
		categoryItem.getItemProperty(NAME_PROP).setValue(category);
		categoryItem
				.getItemProperty(ICON_PROP)
				.setValue(
						BundleResource
								.valueOf("platform:/plugin/org.eclipse.osbp.vaaclipse.resources/VAADIN/themes/vaaclipse_default_theme/img/folder.png"));
		categoryItem.getItemProperty(OBJECT_PROP).setValue(category);
	}

	private void setupDescriptorItem(Item descriptorItem,
			MPartDescriptor descriptor) {
		descriptorItem.getItemProperty(NAME_PROP).setValue(
				descriptor.getLabel());
		if (descriptor.getIconURI() != null
				&& descriptor.getIconURI().trim().length() > 0)
			descriptorItem.getItemProperty(ICON_PROP).setValue(
					BundleResource.valueOf(descriptor.getIconURI()));
		descriptorItem.getItemProperty(OBJECT_PROP).setValue(descriptor);
	}

	private HierarchicalContainer createDataSource() {
		HierarchicalContainer data = new HierarchicalContainer();
		data.addContainerProperty(NAME_PROP, String.class, "No Name");
		data.addContainerProperty(ICON_PROP, ThemeResource.class, null);
		data.addContainerProperty(OBJECT_PROP, Object.class, null);

		List<MPartDescriptor> descriptors = application.getDescriptors();
		Set<String> categoryTags = new HashSet<String>();

		for (MPartDescriptor descriptor : descriptors) {
			List<String> tags = descriptor.getTags();
			String category = null;
			boolean isView = false;
			for (String tag : tags) {
				if (tag.equals("View"))
					isView = true;
				else if (tag.startsWith(CATEGORY_TAG)) {
					category = tag.substring(CATEGORY_TAG_LENGTH);
				}
			}
			if (isView) {
				Item descriptorItem = data.addItem(descriptor);
				data.setChildrenAllowed(descriptor, false);
				setupDescriptorItem(descriptorItem, descriptor);

				if (category != null) {
					category = category.trim();
					if (!category.isEmpty()) {
						if (!categoryTags.contains(category)) {
							categoryTags.add(category);
							Item categoryItem = data.addItem(category);
							setupCategoryItem(categoryItem, category);
						}

						data.setParent(descriptor, category);
					}
				}
			}
		}

		return data;
	}
}