/*******************************************************************************
* Copyright (c) 2001, 2016 IBM Corporation 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:
* IBM Corporation - initial API and implementation
* Jens Lukowski/Innoopract - initial renaming/restructuring
*
*******************************************************************************/
package org.eclipse.wst.xml.ui.views.contentoutline;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.StyledString;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.wst.sse.ui.internal.contentoutline.PropertyChangeUpdateAction;
import org.eclipse.wst.sse.ui.internal.contentoutline.PropertyChangeUpdateActionContributionItem;
import org.eclipse.wst.sse.ui.internal.editor.EditorPluginImageHelper;
import org.eclipse.wst.sse.ui.internal.editor.EditorPluginImages;
import org.eclipse.wst.xml.core.internal.contentmodel.CMAttributeDeclaration;
import org.eclipse.wst.xml.core.internal.contentmodel.CMDataType;
import org.eclipse.wst.xml.core.internal.contentmodel.CMElementDeclaration;
import org.eclipse.wst.xml.core.internal.contentmodel.CMNamedNodeMap;
import org.eclipse.wst.xml.core.internal.contentmodel.modelquery.ModelQuery;
import org.eclipse.wst.xml.core.internal.modelquery.ModelQueryUtil;
import org.eclipse.wst.xml.ui.internal.XMLUIMessages;
import org.eclipse.wst.xml.ui.internal.contentoutline.JFaceNodeContentProvider;
import org.eclipse.wst.xml.ui.internal.contentoutline.JFaceNodeLabelProvider;
import org.eclipse.wst.xml.ui.internal.preferences.XMLUIPreferenceNames;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
/**
* More advanced Outline Configuration for XML support. Expects that the viewer's
* input will be the DOM Model.
*
* @see AbstractXMLContentOutlineConfiguration
* @since 1.0
*/
public class XMLContentOutlineConfiguration extends AbstractXMLContentOutlineConfiguration {
static final String ATTR_NAME = "name";
static final String ATTR_ID = "id";
private class AttributeShowingLabelProvider extends JFaceNodeLabelProvider implements IStyledLabelProvider {
public boolean isLabelProperty(Object element, String property) {
return true;
}
private Node getAttributeToShow(Element element) {
NamedNodeMap attributes = element.getAttributes();
Node idTypedAttribute = null;
Node requiredAttribute = null;
boolean hasId = false;
boolean hasName = false;
Node shownAttribute = null;
// try to get content model element
// declaration
CMElementDeclaration elementDecl = null;
ModelQuery mq = ModelQueryUtil.getModelQuery(element.getOwnerDocument());
if (mq != null) {
elementDecl = mq.getCMElementDeclaration(element);
}
// find an attribute of type (or just named)
// ID
if (elementDecl != null) {
final CMNamedNodeMap attributeDeclarationMap = elementDecl.getAttributes();
int i = 0;
while (i < attributes.getLength() && idTypedAttribute == null) {
Node attr = attributes.item(i);
String attrName = attr.getNodeName();
CMAttributeDeclaration attrDecl = (CMAttributeDeclaration) attributeDeclarationMap.getNamedItem(attrName);
if (attrDecl != null) {
if ((attrDecl.getAttrType() != null) && (CMDataType.ID.equals(attrDecl.getAttrType().getDataTypeName()))) {
idTypedAttribute = attr;
}
else if ((attrDecl.getUsage() == CMAttributeDeclaration.REQUIRED) && (requiredAttribute == null)) {
/*
* as a backup, keep tabs on any required
* attributes
*/
requiredAttribute = attr;
}
else {
hasId = hasId || attrName.equals(ATTR_ID);
hasName = hasName || attrName.equals(ATTR_NAME);
}
}
++i;
}
}
/*
* If no suitable attribute with type "ID" was found, then prefer
* "id" or "name", otherwise try using a required attribute, if
* none, then just use the first attribute
*/
if (idTypedAttribute != null) {
shownAttribute = idTypedAttribute;
}
else if (hasId) {
shownAttribute = attributes.getNamedItem(ATTR_ID);
}
else if (hasName) {
shownAttribute = attributes.getNamedItem(ATTR_NAME);
}
else if (requiredAttribute != null) {
shownAttribute = requiredAttribute;
}
if (shownAttribute == null) {
shownAttribute = attributes.item(0);
}
return shownAttribute;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.viewers.ILabelProvider#getText(java.lang.Object)
*/
public String getText(Object o) {
if (o instanceof Node) {
Node node = (Node) o;
StringBuffer buffer = new StringBuffer(super.getText(node));
if (node.getNodeType() == Node.ELEMENT_NODE && fShowAttributes) {
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=88444
if (node.hasAttributes()) {
Node shownAttribute = getAttributeToShow((Element) node);
if (shownAttribute != null) {
String attributeName = shownAttribute.getNodeName();
if (attributeName != null && attributeName.length() > 0) {
String attributeValue = shownAttribute.getNodeValue();
if (attributeValue != null) {
buffer.append(" "); //$NON-NLS-1$
buffer.append(attributeName);
// https://bugs.eclipse.org/486252
buffer.append("="); //$NON-NLS-1$
buffer.append(attributeValue);
}
}
}
}
}
return buffer.toString();
}
return super.toString();
}
/* (non-Javadoc)
* @see org.eclipse.jface.viewers.CellLabelProvider#getToolTipText(java.lang.Object)
*/
public String getToolTipText(Object element) {
if (element instanceof Node) {
switch (((Node) element).getNodeType()) {
case Node.COMMENT_NODE :
case Node.CDATA_SECTION_NODE :
case Node.PROCESSING_INSTRUCTION_NODE :
case Node.TEXT_NODE : {
String nodeValue = ((Node) element).getNodeValue().trim();
return prepareText(nodeValue);
}
case Node.ELEMENT_NODE : {
// show the preceding comment's tooltip information
Node previous = ((Node) element).getPreviousSibling();
if (previous != null && previous.getNodeType() == Node.TEXT_NODE)
previous = previous.getPreviousSibling();
if (previous != null && previous.getNodeType() == Node.COMMENT_NODE)
return getToolTipText(previous);
}
}
}
return super.getToolTipText(element);
}
/**
* Remove leading indentation from each line in the give string.
* @param text
* @return
*/
private String prepareText(String text) {
StringBuffer nodeText = new StringBuffer();
for (int i = 0; i < text.length(); i++) {
char c = text.charAt(i);
if (c != '\r' && c != '\n') {
nodeText.append(c);
}
else if (c == '\r' || c == '\n') {
nodeText.append('\n');
while (Character.isWhitespace(c) && i < text.length()) {
i++;
c = text.charAt(i);
}
nodeText.append(c);
}
}
return nodeText.toString();
}
public StyledString getStyledText(Object element) {
if (element instanceof Node) {
Node node = (Node) element;
StyledString styleString = new StyledString(super.getText(node));
if (node.getNodeType() == Node.ELEMENT_NODE && fShowAttributes) {
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=88444
if (node.hasAttributes()) {
Node shownAttribute = getAttributeToShow((Element) node);
if (shownAttribute != null) {
// display the attribute and styled value
String attributeName = shownAttribute.getNodeName();
if (attributeName != null && attributeName.length() > 0) {
String attributeValue = shownAttribute.getNodeValue();
if (attributeValue != null) {
StringBuffer buffer = new StringBuffer(" "); //$NON-NLS-1$
buffer.append(attributeName);
// https://bugs.eclipse.org/486252
buffer.append("="); //$NON-NLS-1$
buffer.append(attributeValue);
styleString.append(buffer.toString(), StyledString.QUALIFIER_STYLER);
}
}
}
}
}
return styleString;
}
return new StyledString(getText(element));
}
}
/**
* Toggle action for whether or not to display element's first attribute
*/
private class ToggleShowAttributeAction extends PropertyChangeUpdateAction {
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=88444
private TreeViewer fTreeViewer;
public ToggleShowAttributeAction(IPreferenceStore store, String preference, TreeViewer treeViewer) {
super(XMLUIMessages.XMLContentOutlineConfiguration_0, store, preference, true);
setToolTipText(getText());
// images needed
// setDisabledImageDescriptor(SYNCED_D);
// (nsd) temporarily re-use Properties view image
setImageDescriptor(EditorPluginImageHelper.getInstance().getImageDescriptor(EditorPluginImages.IMG_OBJ_PROP_PS));
fTreeViewer = treeViewer;
update();
}
/*
* (non-Javadoc)
*
* @see org.eclipse.ui.texteditor.IUpdate#update()
*/
public void update() {
super.update();
fShowAttributes = isChecked();
// notify the configuration of the change
enableShowAttributes(fShowAttributes, fTreeViewer);
// refresh the outline view
fTreeViewer.refresh(true);
}
}
private ILabelProvider fAttributeShowingLabelProvider;
private IContentProvider fContentProvider = null;
boolean fShowAttributes = false;
/*
* Preference key for Show Attributes
*/
private final String OUTLINE_SHOW_ATTRIBUTE_PREF = "outline-show-attribute"; //$NON-NLS-1$
private static final String OUTLINE_FILTER_PREF = "org.eclipse.wst.xml.ui.OutlinePage"; //$NON-NLS-1$
/**
* Create new instance of XMLContentOutlineConfiguration
*/
public XMLContentOutlineConfiguration() {
// Must have empty constructor to createExecutableExtension
super();
/**
* Set up our preference store here. This is done so that subclasses
* aren't required to set their own values, although if they have,
* those will be used instead.
*/
IPreferenceStore store = getPreferenceStore();
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.DOCUMENT_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.DOCUMENT_NODE, "1, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.PROCESSING_INSTRUCTION_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.PROCESSING_INSTRUCTION_NODE, "2, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.DOCUMENT_TYPE_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.DOCUMENT_TYPE_NODE, "3, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.DOCUMENT_FRAGMENT_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.DOCUMENT_FRAGMENT_NODE, "4, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.COMMENT_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.COMMENT_NODE, "5, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ATTRIBUTE_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ATTRIBUTE_NODE, "6, false");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ELEMENT_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ELEMENT_NODE, "7, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ENTITY_REFERENCE_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ENTITY_REFERENCE_NODE, "8, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.CDATA_SECTION_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.CDATA_SECTION_NODE, "9, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ENTITY_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.ENTITY_NODE, "10, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.NOTATION_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.NOTATION_NODE, "11, true");
if (store.getDefaultString(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.TEXT_NODE).length() == 0)
store.setDefault(XMLUIPreferenceNames.OUTLINE_BEHAVIOR.TEXT_NODE, "12, false");
}
/*
* (non-Javadoc)
*
* @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#createMenuContributions(org.eclipse.jface.viewers.TreeViewer)
*/
protected IContributionItem[] createMenuContributions(TreeViewer viewer) {
IContributionItem[] items;
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=88444
IContributionItem showAttributeItem = new PropertyChangeUpdateActionContributionItem(new ToggleShowAttributeAction(getPreferenceStore(), OUTLINE_SHOW_ATTRIBUTE_PREF, viewer));
items = super.createMenuContributions(viewer);
if (items == null) {
items = new IContributionItem[]{showAttributeItem};
}
else {
IContributionItem[] combinedItems = new IContributionItem[items.length + 1];
System.arraycopy(items, 0, combinedItems, 0, items.length);
combinedItems[items.length] = showAttributeItem;
items = combinedItems;
}
return items;
}
/**
* Notifies this configuration that the flag that indicates whether or not
* to show attribute values in the tree viewer has changed. The tree
* viewer is automatically refreshed afterwards to update the labels.
*
* Clients should not call this method, but rather should react to it.
*
* @param showAttributes
* flag indicating whether or not to show attribute values in
* the tree viewer
* @param treeViewer
* the TreeViewer associated with this configuration
*/
protected void enableShowAttributes(boolean showAttributes, TreeViewer treeViewer) {
// nothing by default
}
/*
* (non-Javadoc)
*
* @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getContentProvider(org.eclipse.jface.viewers.TreeViewer)
*/
public IContentProvider getContentProvider(TreeViewer viewer) {
if (fContentProvider == null) {
fContentProvider = new JFaceNodeContentProvider();
}
return fContentProvider;
}
private Object getFilteredNode(Object object) {
if (object instanceof Node) {
Node node = (Node) object;
short nodeType = node.getNodeType();
// replace attribute node in selection with its parent
if (nodeType == Node.ATTRIBUTE_NODE) {
node = ((Attr) node).getOwnerElement();
}
// anything else not visible, replace with parent node
else if (nodeType == Node.TEXT_NODE) {
node = node.getParentNode();
}
return node;
}
return object;
}
private Object[] getFilteredNodes(Object[] filteredNodes) {
for (int i = 0; i < filteredNodes.length; i++) {
filteredNodes[i] = getFilteredNode(filteredNodes[i]);
}
return filteredNodes;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getLabelProvider(org.eclipse.jface.viewers.TreeViewer)
*/
public ILabelProvider getLabelProvider(TreeViewer viewer) {
if (fAttributeShowingLabelProvider == null) {
fAttributeShowingLabelProvider = new AttributeShowingLabelProvider();
}
return fAttributeShowingLabelProvider;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getSelection(org.eclipse.jface.viewers.TreeViewer,
* org.eclipse.jface.viewers.ISelection)
*/
public ISelection getSelection(TreeViewer viewer, ISelection selection) {
ISelection filteredSelection = selection;
if (selection instanceof IStructuredSelection) {
Object[] filteredNodes = getFilteredNodes(((IStructuredSelection) selection).toArray());
filteredSelection = new StructuredSelection(filteredNodes);
}
return filteredSelection;
}
protected String getOutlineFilterTarget(){
return OUTLINE_FILTER_PREF ;
}
}