bundles/org.eclipse.wst.xsl.ui/src/org/eclipse/wst/xsl/ui/internal/contentoutline/JFaceNodeAdapter.java - sourceediting/webtools.sourceediting.xsl - Git at Google

 /*******************************************************************************
  * Copyright (c) 2009 Standards for Technology in Automotive Retail and others.
  * 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:
  *     David Carver (STAR) - based work on org.eclipse.wst.xml.ui.internal. JFaceNodeAdapter
  *
  *******************************************************************************/
 package org.eclipse.wst.xsl.ui.internal.contentoutline;

 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;

 import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.jface.viewers.StructuredViewer;
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.wst.sse.core.internal.provisional.INodeNotifier;
 import org.eclipse.wst.sse.ui.internal.contentoutline.IJFaceNodeAdapter;
 import org.eclipse.wst.xml.ui.internal.editor.CMImageUtil;
 import org.eclipse.wst.xml.ui.internal.editor.XMLEditorPluginImageHelper;
 import org.eclipse.wst.xml.ui.internal.editor.XMLEditorPluginImages;
 import org.eclipse.wst.xsl.core.XSLCore;
 import org.eclipse.wst.xsl.ui.internal.util.XSLPluginImageHelper;
 import org.eclipse.wst.xsl.ui.internal.util.XSLPluginImages;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;

 /**
  * Adapts a DOM node to a JFace viewer.
  */
 public class JFaceNodeAdapter implements IJFaceNodeAdapter {

 	final static Class ADAPTER_KEY = IJFaceNodeAdapter.class;

 	JFaceNodeAdapterFactory fAdapterFactory;
 	RefreshStructureJob fRefreshJob = null;

 	public JFaceNodeAdapter(JFaceNodeAdapterFactory adapterFactory) {
 		super();
 		this.fAdapterFactory = adapterFactory;
 	}

 	protected ImageDescriptor getXSLImage(Element node) {
 		String name = node.getLocalName();
 		if (name.equals("import") || name.equals("include")) {  //$NON-NLS-1$//$NON-NLS-2$
 			return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_IMPORT_INCLUDE);
 		}
 		if (name.equals("template")) { //$NON-NLS-1$
 			if (node.hasAttribute("name")) { //$NON-NLS-1$
 				return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_TEMPLATE_NAME);
 			} else {
 				return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_TEMPLATE);
 			}
 		}

 		if (name.equals("variable") || name.equals("param")) { //$NON-NLS-1$ //$NON-NLS-2$
 			return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_VARIABLE);
 		}

 		if (name.equals("function")) { //$NON-NLS-1$
 			return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_FUNCTION);
 		}

 		return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_STYLESHET);
 	}

 	protected Image createImage(Object object) {
 		Image image = null;
 		Node node = (Node) object;
 		switch (node.getNodeType()) {
 			case Node.ELEMENT_NODE : {
 				if (XSLCore.XSL_NAMESPACE_URI.equals(node.getNamespaceURI())) {
 					Element elem = (Element) node;
 					ImageDescriptor imgDesc = getXSLImage(elem);
 					if (imgDesc == null) {
 						image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ELEMENT);
 					} else {
 						image = imgDesc.createImage();
 					}
 				} else {
 					image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ELEMENT);
 				}
 				break;
 			}
 			case Node.ATTRIBUTE_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ATTRIBUTE);
 				break;
 			}
 			case Node.TEXT_NODE : { // actually, TEXT should never be seen in
 				// the tree
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_TXTEXT);
 				break;
 			}
 			case Node.CDATA_SECTION_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_CDATASECTION);
 				break;
 			}
 			case Node.ENTITY_REFERENCE_NODE :
 			case Node.ENTITY_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ENTITY);
 				break;
 			}
 			case Node.PROCESSING_INSTRUCTION_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_PROCESSINGINSTRUCTION);
 				break;
 			}
 			// Should never see COMMENT NODEs.
 			case Node.COMMENT_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_COMMENT);
 				break;
 			}
 			case Node.DOCUMENT_TYPE_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_DOCTYPE);
 				break;
 			}
 			case Node.NOTATION_NODE : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_NOTATION);
 				break;
 			}
 			default : {
 				image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_TXTEXT);
 				break;
 			}
 		}
 		return image;
 	}

 	protected Image createXMLImageDescriptor(String imageResourceName) {
 		return XMLEditorPluginImageHelper.getInstance().getImage(imageResourceName);
 	}

 	public Object[] getChildren(Object object) {

 		ArrayList v = new ArrayList();
 		if (object instanceof Node) {
 			Node node = (Node) object;
 			for (Node child = node.getFirstChild(); child != null; child = child.getNextSibling()) {
 				Node n = child;
 				if (n.getNodeType() != Node.TEXT_NODE && n.getNodeType() != Node.COMMENT_NODE) {
 					v.add(n);
 				}
 			}
 		}
 		return v.toArray();
 	}

 	/**
 	 * Returns an enumeration with the elements belonging to the passed
 	 * element. These are the top level items in a list, tree, table, etc...
 	 * @param node
 	 * @return
 	 */
 	public Object[] getElements(Object node) {
 		return getChildren(node);
 	}

 	/**
 	 * Fetches the label image specific to this object instance.
 	 * @param node DOM Node
 	 * @return Image for the label.
 	 */
 	public Image getLabelImage(Object node) {
 		Image image = null;
 		if (node instanceof Node) {
 			// check for an image from the content model
 			image = CMImageUtil.getImage(CMImageUtil.getDeclaration((Node) node));
 			if (image == null) {
 				/*
 				 * Create/get image based on Node type. Images are cached
 				 * transparently in this class, subclasses must do this for
 				 * themselves if they're going to return their own results.
 				 */
 				image = createImage(node);
 			}
 		}
 		return image;
 	}

 	/**
 	 * Fetches the label text specific to this object instance.
 	 * @return Node Name for the Label
 	 */
 	public String getLabelText(Object node) {
 		return getNodeName(node);
 	}

 	private String getNodeName(Object object) {
 		StringBuffer nodeName = new StringBuffer();
 		if (!(object instanceof Node)) {
 			return nodeName.toString();
 		}

 		Node node = (Node) object;
 		if (node.getNodeType() != Node.ELEMENT_NODE) {
 			nodeName.append(node.getNodeName());
 			if (node.getNodeType() == Node.DOCUMENT_TYPE_NODE) {
 				nodeName.insert(0, "DOCTYPE:"); //$NON-NLS-1$
 			}
 			return nodeName.toString();
 		}

 		if (XSLCore.XSL_NAMESPACE_URI.equals(node.getNamespaceURI())) {
 			Element elem = (Element) node;
 			nodeName.append(elem.getLocalName());
 		} else {
 			nodeName.append(node.getNodeName());
 		}
 		return nodeName.toString();
 	}


 	public Object getParent(Object object) {
 		if (object instanceof Node) {
 			Node node = (Node) object;
 			return node.getParentNode();
 		}
 		return null;
 	}

 	private synchronized RefreshStructureJob getRefreshJob() {
 		if (fRefreshJob == null) {
 			fRefreshJob = new RefreshStructureJob();
 		}
 		return fRefreshJob;
 	}


 	public boolean hasChildren(Object object) {
 		Node node = (Node) object;
 		for (Node child = node.getFirstChild(); child != null; child = child.getNextSibling()) {
 			if (child.getNodeType() != Node.TEXT_NODE) {
 				return true;
 			}
 		}
 		return false;
 	}

 	/**
 	 * Allowing the INodeAdapter to compare itself against the type allows it
 	 * to return true in more than one case.
 	 */
 	public boolean isAdapterForType(Object type) {
 		if (type == null) {
 			return false;
 		}
 		return type.equals(ADAPTER_KEY);
 	}

 	/**
 	 * Called by the object being adapter (the notifier) when something has
 	 * changed.
 	 */
 	public void notifyChanged(INodeNotifier notifier, int eventType, Object changedFeature, Object oldValue, Object newValue, int pos) {
 		// future_TODO: the 'uijobs' used in this method were added to solve
 		// threading problems when the dom
 		// is updated in the background while the editor is open. They may be
 		// a bit overkill and not that useful.
 		// (That is, may be be worthy of job manager management). If they are
 		// found to be important enough to leave in,
 		// there's probably some optimization that can be done.
 		if (notifier instanceof Node) {
 			Collection listeners = fAdapterFactory.getListeners();
 			Iterator iterator = listeners.iterator();

 			while (iterator.hasNext()) {
 				Object listener = iterator.next();
 				if ((listener instanceof StructuredViewer) && ((eventType == INodeNotifier.STRUCTURE_CHANGED) || (eventType == INodeNotifier.CONTENT_CHANGED) || (eventType == INodeNotifier.CHANGE))) {

 					StructuredViewer structuredViewer = (StructuredViewer) listener;
 					if (structuredViewer.getControl() != null) {
 						getRefreshJob().refresh(structuredViewer, (Node) notifier);
 					}
 				}
 			}
 		}
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2009 Standards for Technology in Automotive Retail and others.
	* 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:
	* David Carver (STAR) - based work on org.eclipse.wst.xml.ui.internal. JFaceNodeAdapter
	*
	*******************************************************************************/
	package org.eclipse.wst.xsl.ui.internal.contentoutline;

	import java.util.ArrayList;
	import java.util.Collection;
	import java.util.Iterator;

	import org.eclipse.jface.resource.ImageDescriptor;
	import org.eclipse.jface.viewers.StructuredViewer;
	import org.eclipse.swt.graphics.Image;
	import org.eclipse.wst.sse.core.internal.provisional.INodeNotifier;
	import org.eclipse.wst.sse.ui.internal.contentoutline.IJFaceNodeAdapter;
	import org.eclipse.wst.xml.ui.internal.editor.CMImageUtil;
	import org.eclipse.wst.xml.ui.internal.editor.XMLEditorPluginImageHelper;
	import org.eclipse.wst.xml.ui.internal.editor.XMLEditorPluginImages;
	import org.eclipse.wst.xsl.core.XSLCore;
	import org.eclipse.wst.xsl.ui.internal.util.XSLPluginImageHelper;
	import org.eclipse.wst.xsl.ui.internal.util.XSLPluginImages;
	import org.w3c.dom.Element;
	import org.w3c.dom.Node;

	/**
	* Adapts a DOM node to a JFace viewer.
	*/
	public class JFaceNodeAdapter implements IJFaceNodeAdapter {

	final static Class ADAPTER_KEY = IJFaceNodeAdapter.class;

	JFaceNodeAdapterFactory fAdapterFactory;
	RefreshStructureJob fRefreshJob = null;

	public JFaceNodeAdapter(JFaceNodeAdapterFactory adapterFactory) {
	super();
	this.fAdapterFactory = adapterFactory;
	}

	protected ImageDescriptor getXSLImage(Element node) {
	String name = node.getLocalName();
	if (name.equals("import") \|\| name.equals("include")) { //$NON-NLS-1$//$NON-NLS-2$
	return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_IMPORT_INCLUDE);
	}
	if (name.equals("template")) { //$NON-NLS-1$
	if (node.hasAttribute("name")) { //$NON-NLS-1$
	return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_TEMPLATE_NAME);
	} else {
	return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_TEMPLATE);
	}
	}

	if (name.equals("variable") \|\| name.equals("param")) { //$NON-NLS-1$ //$NON-NLS-2$
	return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_VARIABLE);
	}

	if (name.equals("function")) { //$NON-NLS-1$
	return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_FUNCTION);
	}

	return XSLPluginImageHelper.getInstance().getImageDescriptor(XSLPluginImages.IMG_ELM_STYLESHET);
	}

	protected Image createImage(Object object) {
	Image image = null;
	Node node = (Node) object;
	switch (node.getNodeType()) {
	case Node.ELEMENT_NODE : {
	if (XSLCore.XSL_NAMESPACE_URI.equals(node.getNamespaceURI())) {
	Element elem = (Element) node;
	ImageDescriptor imgDesc = getXSLImage(elem);
	if (imgDesc == null) {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ELEMENT);
	} else {
	image = imgDesc.createImage();
	}
	} else {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ELEMENT);
	}
	break;
	}
	case Node.ATTRIBUTE_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ATTRIBUTE);
	break;
	}
	case Node.TEXT_NODE : { // actually, TEXT should never be seen in
	// the tree
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_TXTEXT);
	break;
	}
	case Node.CDATA_SECTION_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_CDATASECTION);
	break;
	}
	case Node.ENTITY_REFERENCE_NODE :
	case Node.ENTITY_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_ENTITY);
	break;
	}
	case Node.PROCESSING_INSTRUCTION_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_PROCESSINGINSTRUCTION);
	break;
	}
	// Should never see COMMENT NODEs.
	case Node.COMMENT_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_COMMENT);
	break;
	}
	case Node.DOCUMENT_TYPE_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_DOCTYPE);
	break;
	}
	case Node.NOTATION_NODE : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_NOTATION);
	break;
	}
	default : {
	image = createXMLImageDescriptor(XMLEditorPluginImages.IMG_OBJ_TXTEXT);
	break;
	}
	}
	return image;
	}

	protected Image createXMLImageDescriptor(String imageResourceName) {
	return XMLEditorPluginImageHelper.getInstance().getImage(imageResourceName);
	}

	public Object[] getChildren(Object object) {

	ArrayList v = new ArrayList();
	if (object instanceof Node) {
	Node node = (Node) object;
	for (Node child = node.getFirstChild(); child != null; child = child.getNextSibling()) {
	Node n = child;
	if (n.getNodeType() != Node.TEXT_NODE && n.getNodeType() != Node.COMMENT_NODE) {
	v.add(n);
	}
	}
	}
	return v.toArray();
	}

	/**
	* Returns an enumeration with the elements belonging to the passed
	* element. These are the top level items in a list, tree, table, etc...
	* @param node
	* @return
	*/
	public Object[] getElements(Object node) {
	return getChildren(node);
	}

	/**
	* Fetches the label image specific to this object instance.
	* @param node DOM Node
	* @return Image for the label.
	*/
	public Image getLabelImage(Object node) {
	Image image = null;
	if (node instanceof Node) {
	// check for an image from the content model
	image = CMImageUtil.getImage(CMImageUtil.getDeclaration((Node) node));
	if (image == null) {
	/*
	* Create/get image based on Node type. Images are cached
	* transparently in this class, subclasses must do this for
	* themselves if they're going to return their own results.
	*/
	image = createImage(node);
	}
	}
	return image;
	}

	/**
	* Fetches the label text specific to this object instance.
	* @return Node Name for the Label
	*/
	public String getLabelText(Object node) {
	return getNodeName(node);
	}

	private String getNodeName(Object object) {
	StringBuffer nodeName = new StringBuffer();
	if (!(object instanceof Node)) {
	return nodeName.toString();
	}

	Node node = (Node) object;
	if (node.getNodeType() != Node.ELEMENT_NODE) {
	nodeName.append(node.getNodeName());
	if (node.getNodeType() == Node.DOCUMENT_TYPE_NODE) {
	nodeName.insert(0, "DOCTYPE:"); //$NON-NLS-1$
	}
	return nodeName.toString();
	}

	if (XSLCore.XSL_NAMESPACE_URI.equals(node.getNamespaceURI())) {
	Element elem = (Element) node;
	nodeName.append(elem.getLocalName());
	} else {
	nodeName.append(node.getNodeName());
	}
	return nodeName.toString();
	}


	public Object getParent(Object object) {
	if (object instanceof Node) {
	Node node = (Node) object;
	return node.getParentNode();
	}
	return null;
	}

	private synchronized RefreshStructureJob getRefreshJob() {
	if (fRefreshJob == null) {
	fRefreshJob = new RefreshStructureJob();
	}
	return fRefreshJob;
	}


	public boolean hasChildren(Object object) {
	Node node = (Node) object;
	for (Node child = node.getFirstChild(); child != null; child = child.getNextSibling()) {
	if (child.getNodeType() != Node.TEXT_NODE) {
	return true;
	}
	}
	return false;
	}

	/**
	* Allowing the INodeAdapter to compare itself against the type allows it
	* to return true in more than one case.
	*/
	public boolean isAdapterForType(Object type) {
	if (type == null) {
	return false;
	}
	return type.equals(ADAPTER_KEY);
	}

	/**
	* Called by the object being adapter (the notifier) when something has
	* changed.
	*/
	public void notifyChanged(INodeNotifier notifier, int eventType, Object changedFeature, Object oldValue, Object newValue, int pos) {
	// future_TODO: the 'uijobs' used in this method were added to solve
	// threading problems when the dom
	// is updated in the background while the editor is open. They may be
	// a bit overkill and not that useful.
	// (That is, may be be worthy of job manager management). If they are
	// found to be important enough to leave in,
	// there's probably some optimization that can be done.
	if (notifier instanceof Node) {
	Collection listeners = fAdapterFactory.getListeners();
	Iterator iterator = listeners.iterator();

	while (iterator.hasNext()) {
	Object listener = iterator.next();
	if ((listener instanceof StructuredViewer) && ((eventType == INodeNotifier.STRUCTURE_CHANGED) \|\| (eventType == INodeNotifier.CONTENT_CHANGED) \|\| (eventType == INodeNotifier.CHANGE))) {

	StructuredViewer structuredViewer = (StructuredViewer) listener;
	if (structuredViewer.getControl() != null) {
	getRefreshJob().refresh(structuredViewer, (Node) notifier);
	}
	}
	}
	}
	}
	}