| /******************************************************************************* |
| * Copyright (c) 2001, 2004 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.action.IMenuListener; |
| import org.eclipse.jface.action.IMenuManager; |
| import org.eclipse.jface.preference.IPreferenceStore; |
| import org.eclipse.jface.util.TransferDragSourceListener; |
| import org.eclipse.jface.util.TransferDropTargetListener; |
| 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.TreeViewer; |
| import org.eclipse.swt.dnd.DragSourceEvent; |
| import org.eclipse.swt.dnd.DropTargetEvent; |
| import org.eclipse.swt.dnd.Transfer; |
| import org.eclipse.wst.common.ui.internal.dnd.ObjectTransfer; |
| import org.eclipse.wst.common.ui.internal.dnd.ViewerDragAdapter; |
| import org.eclipse.wst.common.ui.internal.dnd.ViewerDropAdapter; |
| import org.eclipse.wst.sse.core.internal.provisional.IStructuredModel; |
| import org.eclipse.wst.sse.core.internal.util.StringUtils; |
| import org.eclipse.wst.sse.ui.internal.IReleasable; |
| 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.sse.ui.views.contentoutline.ContentOutlineConfiguration; |
| 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.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.XMLUIPlugin; |
| 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.contentoutline.XMLNodeActionManager; |
| import org.eclipse.wst.xml.ui.internal.dnd.XMLDragAndDropManager; |
| import org.w3c.dom.Attr; |
| import org.w3c.dom.Element; |
| import org.w3c.dom.NamedNodeMap; |
| import org.w3c.dom.Node; |
| |
| /** |
| * Configuration for XML, expects that the viewer's input will be the DOM |
| * Model |
| */ |
| public class XMLContentOutlineConfiguration extends ContentOutlineConfiguration { |
| private class ActionManagerMenuListener implements IMenuListener, IReleasable { |
| private XMLNodeActionManager fActionManager; |
| private TreeViewer fTreeViewer; |
| |
| public ActionManagerMenuListener(TreeViewer viewer) { |
| fTreeViewer = viewer; |
| } |
| |
| public void menuAboutToShow(IMenuManager manager) { |
| if (fActionManager == null) { |
| fActionManager = createNodeActionManager(fTreeViewer); |
| } |
| fActionManager.fillContextMenu(manager, fTreeViewer.getSelection()); |
| } |
| |
| public void release() { |
| fTreeViewer = null; |
| if (fActionManager != null) { |
| fActionManager.setModel(null); |
| } |
| } |
| } |
| |
| /** |
| * 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(); |
| } |
| |
| public void update() { |
| super.update(); |
| updateShowAttributes(isChecked(), fTreeViewer); |
| } |
| } |
| |
| private IContentProvider fContentProvider = null; |
| |
| protected ActionManagerMenuListener fContextMenuFiller = null; |
| |
| private ILabelProvider fLabelProvider = null; |
| |
| private TransferDragSourceListener[] fTransferDragSourceListeners; |
| |
| private TransferDropTargetListener[] fTransferDropTargetListeners; |
| /* |
| * Preference key for Show Attributes |
| */ |
| private final String OUTLINE_SHOW_ATTRIBUTE_PREF = "outline-show-attribute-editor"; //$NON-NLS-1$ |
| |
| boolean fShowAttributes = false; |
| |
| public XMLContentOutlineConfiguration() { |
| super(); |
| } |
| |
| 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; |
| } |
| |
| protected XMLNodeActionManager createNodeActionManager(TreeViewer treeViewer) { |
| return new XMLNodeActionManager((IStructuredModel) treeViewer.getInput(), 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; |
| |
| // replace attribute node in selection with its parent |
| if (node.getNodeType() == Node.ATTRIBUTE_NODE) |
| node = ((Attr) node).getOwnerElement(); |
| // replace TextNode in selection with its parent |
| else if (node.getNodeType() == 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; |
| } |
| |
| /** |
| * @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getLabelProvider(org.eclipse.jface.viewers.TreeViewer) |
| */ |
| public ILabelProvider getLabelProvider(TreeViewer viewer) { |
| if (fLabelProvider == null) { |
| fLabelProvider = new JFaceNodeLabelProvider() { |
| public String getText(Object o) { |
| StringBuffer text = new StringBuffer(super.getText(o)); |
| if (o instanceof Node) { |
| Node node = (Node) o; |
| if (node.getNodeType() == Node.ELEMENT_NODE && fShowAttributes) { |
| // https://bugs.eclipse.org/bugs/show_bug.cgi?id=88444 |
| if (node.hasAttributes()) { |
| Element element = (Element) node; |
| 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) { |
| int i = 0; |
| while (i < attributes.getLength() && idTypedAttribute == null) { |
| Node attr = attributes.item(i); |
| String attrName = attr.getNodeName(); |
| CMAttributeDeclaration attrDecl = (CMAttributeDeclaration) elementDecl.getAttributes().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("id"); //$NON-NLS-1$ |
| hasName = hasName || attrName.equals("name"); //$NON-NLS-1$ |
| } |
| } |
| ++i; |
| } |
| } |
| |
| /* |
| * If no suitable attribute was found, try |
| * using a required attribute, if none, then |
| * prefer "id" or "name", otherwise just use |
| * first attribute |
| */ |
| if (idTypedAttribute != null) { |
| shownAttribute = idTypedAttribute; |
| } |
| else if (requiredAttribute != null) { |
| shownAttribute = requiredAttribute; |
| } |
| else if (hasId) { |
| shownAttribute = attributes.getNamedItem("id"); //$NON-NLS-1$ |
| } |
| else if (hasName) { |
| shownAttribute = attributes.getNamedItem("name"); //$NON-NLS-1$ |
| } |
| if (shownAttribute == null) { |
| shownAttribute = attributes.item(0); |
| } |
| |
| // display the attribute |
| String attributeName = shownAttribute.getNodeName(); |
| if (attributeName != null && attributeName.length() > 0) { |
| text.append(" " + attributeName); //$NON-NLS-1$ |
| String attributeValue = shownAttribute.getNodeValue(); |
| if (attributeValue != null && attributeValue.length() > 0) { |
| text.append("=" + StringUtils.strip(attributeValue)); //$NON-NLS-1$ |
| } |
| } |
| } |
| } |
| } |
| return text.toString(); |
| } |
| }; |
| } |
| return fLabelProvider; |
| } |
| |
| /** |
| * @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getMenuListener(org.eclipse.jface.viewers.TreeViewer) |
| */ |
| public IMenuListener getMenuListener(TreeViewer viewer) { |
| if (fContextMenuFiller == null) { |
| fContextMenuFiller = new ActionManagerMenuListener(viewer); |
| } |
| return fContextMenuFiller; |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.wst.sse.ui.views.contentoutline.StructuredContentOutlineConfiguration#getPreferenceStore() |
| */ |
| protected IPreferenceStore getPreferenceStore() { |
| return XMLUIPlugin.getDefault().getPreferenceStore(); |
| } |
| |
| 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; |
| } |
| |
| /** |
| * @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getTransferDragSourceListeners(org.eclipse.jface.viewers.TreeViewer) |
| */ |
| public TransferDragSourceListener[] getTransferDragSourceListeners(TreeViewer treeViewer) { |
| if (fTransferDragSourceListeners == null) { |
| // emulate the XMLDragAndDropManager |
| final ViewerDragAdapter dragAdapter = new ViewerDragAdapter(treeViewer); |
| fTransferDragSourceListeners = new TransferDragSourceListener[]{new TransferDragSourceListener() { |
| public void dragFinished(DragSourceEvent event) { |
| dragAdapter.dragFinished(event); |
| } |
| |
| public void dragSetData(DragSourceEvent event) { |
| dragAdapter.dragSetData(event); |
| } |
| |
| public void dragStart(DragSourceEvent event) { |
| dragAdapter.dragStart(event); |
| } |
| |
| public Transfer getTransfer() { |
| return ObjectTransfer.getInstance(); |
| } |
| }}; |
| } |
| |
| return fTransferDragSourceListeners; |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.wst.sse.ui.views.contentoutline.ContentOutlineConfiguration#getTransferDropTargetListeners(org.eclipse.jface.viewers.TreeViewer) |
| */ |
| public TransferDropTargetListener[] getTransferDropTargetListeners(TreeViewer treeViewer) { |
| if (fTransferDropTargetListeners == null) { |
| // emulate the XMLDragAnDropManager |
| final ViewerDropAdapter dropAdapter = new ViewerDropAdapter(treeViewer, new XMLDragAndDropManager()); |
| fTransferDropTargetListeners = new TransferDropTargetListener[]{new TransferDropTargetListener() { |
| public void dragEnter(DropTargetEvent event) { |
| dropAdapter.dragEnter(event); |
| } |
| |
| public void dragLeave(DropTargetEvent event) { |
| dropAdapter.dragLeave(event); |
| } |
| |
| public void dragOperationChanged(DropTargetEvent event) { |
| dropAdapter.dragOperationChanged(event); |
| } |
| |
| public void dragOver(DropTargetEvent event) { |
| dropAdapter.dragOver(event); |
| } |
| |
| public void drop(DropTargetEvent event) { |
| dropAdapter.drop(event); |
| } |
| |
| public void dropAccept(DropTargetEvent event) { |
| dropAdapter.dropAccept(event); |
| } |
| |
| public Transfer getTransfer() { |
| return ObjectTransfer.getInstance(); |
| } |
| |
| public boolean isEnabled(DropTargetEvent event) { |
| return getTransfer().isSupportedType(event.currentDataType); |
| } |
| }}; |
| } |
| return fTransferDropTargetListeners; |
| } |
| |
| public void unconfigure(TreeViewer viewer) { |
| super.unconfigure(viewer); |
| fTransferDragSourceListeners = null; |
| fTransferDropTargetListeners = null; |
| if (fContextMenuFiller != null) { |
| fContextMenuFiller.release(); |
| fContextMenuFiller = null; |
| } |
| // TODO: Add DnD support |
| // XMLDragAndDropManager.addDragAndDropSupport(fTreeViewer); |
| } |
| |
| /** |
| * Updates show attributes flag in JFaceNodeAdapter to indicate whether or |
| * not to show attributes in outline view. Also refreshes tree view due to |
| * label updates. |
| * |
| * @param showAttr |
| * @param viewer |
| */ |
| void updateShowAttributes(boolean showAttr, TreeViewer viewer) { |
| fShowAttributes = showAttr; |
| // refresh the outline view |
| viewer.refresh(); |
| } |
| } |
