org.eclipse.xtext.ui.editor.outline.impl

Class DefaultOutlineTreeProvider

java.lang.Object

org.eclipse.xtext.ui.editor.outline.impl.DefaultOutlineTreeProvider

All Implemented Interfaces:

IOutlineTreeStructureProvider, IOutlineTreeProvider, IOutlineTreeProvider.Cancelable

Direct Known Subclasses:

ModeAwareOutlineTreeProvider

public class DefaultOutlineTreeProvider
extends Object
implements IOutlineTreeStructureProvider, IOutlineTreeProvider, IOutlineTreeProvider.Cancelable

The default implementation of an IOutlineTreeProvider. If you would like to run your outline in Background, please have a look at BackgroundOutlineTreeProvider. Please note that this would have implications to you LabelProvider implementation. Please read the JavaDoc in the mentioned class carefully.

Author:

Jan Koehnlein - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.ui.editor.outline.IOutlineTreeProvider

IOutlineTreeProvider.Background, IOutlineTreeProvider.Cancelable, IOutlineTreeProvider.ModeAware

Field Summary

Fields

Modifier and Type	Field and Description
protected PolymorphicDispatcher<Void>	createChildrenDispatcher
protected PolymorphicDispatcher<Void>	createNodeDispatcher
protected PolymorphicDispatcher<org.eclipse.swt.graphics.Image>	imageDispatcher
protected PolymorphicDispatcher<Boolean>	isLeafDispatcher
protected org.eclipse.jface.viewers.ILabelProvider	labelProvider
protected ILocationInFileProvider	locationInFileProvider
protected PolymorphicDispatcher<Object>	textDispatcher

Constructor Summary

Constructors

Constructor and Description
DefaultOutlineTreeProvider()
DefaultOutlineTreeProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider, ILocationInFileProvider locationInFileProvider) For testing.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_createChildren(DocumentRootNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	_createChildren(EStructuralFeatureNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	_createChildren(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	_createChildren(Object parent, Object element) Default for createChildrenDispatcher
protected void	_createNode(DocumentRootNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	_createNode(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	_createNode(Object parentObject, org.eclipse.emf.ecore.EObject modelElement) Default for createNodeDispatcher
protected org.eclipse.swt.graphics.Image	_image(Object modelElement) Default for imageDispatcher
protected boolean	_isLeaf(org.eclipse.emf.ecore.EObject modelElement)
protected boolean	_isLeaf(Object modelElement) Default for isLeafDispatcher
protected Object	_text(Object modelElement) Default for textDispatcher
protected void	checkCanceled()
void	createChildren(IOutlineNode parent, org.eclipse.emf.ecore.EObject modelElement)
protected EObjectNode	createEObjectNode(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected EObjectNode	createEObjectNode(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement, org.eclipse.swt.graphics.Image image, Object text, boolean isLeaf)
protected EStructuralFeatureNode	createEStructuralFeatureNode(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, org.eclipse.swt.graphics.Image image, Object text, boolean isLeaf)
protected void	createNode(IOutlineNode parent, org.eclipse.emf.ecore.EObject modelElement)
IOutlineNode	createRoot(IXtextDocument document)
IOutlineNode	createRoot(IXtextDocument document, CancelIndicator cancelIndicator)
protected boolean	isLocalElement(IOutlineNode node, org.eclipse.emf.ecore.EObject element)
protected String	nullSafeClassName(Object object)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

labelProvider

@Inject
protected org.eclipse.jface.viewers.ILabelProvider labelProvider

locationInFileProvider

@Inject
protected ILocationInFileProvider locationInFileProvider

createChildrenDispatcher

protected PolymorphicDispatcher<Void> createChildrenDispatcher

createNodeDispatcher

protected PolymorphicDispatcher<Void> createNodeDispatcher

textDispatcher

protected PolymorphicDispatcher<Object> textDispatcher

imageDispatcher

protected PolymorphicDispatcher<org.eclipse.swt.graphics.Image> imageDispatcher

isLeafDispatcher

protected PolymorphicDispatcher<Boolean> isLeafDispatcher

Constructor Detail

DefaultOutlineTreeProvider

public DefaultOutlineTreeProvider()

DefaultOutlineTreeProvider

public DefaultOutlineTreeProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider,
                          ILocationInFileProvider locationInFileProvider)

For testing.

Method Detail

createRoot

public IOutlineNode createRoot(IXtextDocument document)

Specified by:

createRoot in interface IOutlineTreeProvider

createRoot

public IOutlineNode createRoot(IXtextDocument document,
                      CancelIndicator cancelIndicator)

Specified by:

createRoot in interface IOutlineTreeProvider.Cancelable

Since:

2.7

checkCanceled

protected void checkCanceled()

Since:

2.7

createChildren

public void createChildren(IOutlineNode parent,
                  org.eclipse.emf.ecore.EObject modelElement)

Specified by:

createChildren in interface IOutlineTreeStructureProvider

_createChildren

protected void _createChildren(DocumentRootNode parentNode,
                   org.eclipse.emf.ecore.EObject modelElement)

_createChildren

protected void _createChildren(IOutlineNode parentNode,
                   org.eclipse.emf.ecore.EObject modelElement)

_createChildren

protected void _createChildren(EStructuralFeatureNode parentNode,
                   org.eclipse.emf.ecore.EObject modelElement)

createNode

protected void createNode(IOutlineNode parent,
              org.eclipse.emf.ecore.EObject modelElement)

_createNode

protected void _createNode(DocumentRootNode parentNode,
               org.eclipse.emf.ecore.EObject modelElement)

Since:

2.1

_createNode

protected void _createNode(IOutlineNode parentNode,
               org.eclipse.emf.ecore.EObject modelElement)

createEObjectNode

protected EObjectNode createEObjectNode(IOutlineNode parentNode,
                            org.eclipse.emf.ecore.EObject modelElement)

isLocalElement

protected boolean isLocalElement(IOutlineNode node,
                     org.eclipse.emf.ecore.EObject element)

Since:

2.2

createEObjectNode

protected EObjectNode createEObjectNode(IOutlineNode parentNode,
                            org.eclipse.emf.ecore.EObject modelElement,
                            org.eclipse.swt.graphics.Image image,
                            Object text,
                            boolean isLeaf)

Since:

2.1

_isLeaf

protected boolean _isLeaf(org.eclipse.emf.ecore.EObject modelElement)

createEStructuralFeatureNode

protected EStructuralFeatureNode createEStructuralFeatureNode(IOutlineNode parentNode,
                                                  org.eclipse.emf.ecore.EObject owner,
                                                  org.eclipse.emf.ecore.EStructuralFeature feature,
                                                  org.eclipse.swt.graphics.Image image,
                                                  Object text,
                                                  boolean isLeaf)

_createChildren

protected void _createChildren(Object parent,
                   Object element)

Default for createChildrenDispatcher

_createNode

protected void _createNode(Object parentObject,
               org.eclipse.emf.ecore.EObject modelElement)

Default for createNodeDispatcher

_isLeaf

protected boolean _isLeaf(Object modelElement)

Default for isLeafDispatcher

_text

protected Object _text(Object modelElement)

Default for textDispatcher

_image

protected org.eclipse.swt.graphics.Image _image(Object modelElement)

Default for imageDispatcher

nullSafeClassName

protected String nullSafeClassName(Object object)