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

Class BackgroundOutlineTreeProvider

java.lang.Object

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

All Implemented Interfaces:

IOutlineTreeStructureProvider, IOutlineTreeProvider, IOutlineTreeProvider.Background, IOutlineTreeProvider.Cancelable

public class BackgroundOutlineTreeProvider
extends Object
implements IOutlineTreeStructureProvider, IOutlineTreeProvider, IOutlineTreeProvider.Background, IOutlineTreeProvider.Cancelable

An outline tree (structure) provider using ImageDescriptors instead of Images. This allows to create the tree of IOutlineNodes in a background job. Use this class instead of the DefaultOutlineTreeProvider if the UI blocks too long because of the outline calculation. Note that the default implementation already calculates hidden nodes on demand only. It is essential that the ILabelProvider implements ILabelProviderImageDescriptorExtension and that the method ILabelProviderImageDescriptorExtension.getImageDescriptor(Object) does not need to be executed in the Display thread, e.g. does not create Image objects internally.

Since:

2.4

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

Constructor Summary

Constructors

Constructor and Description
BackgroundOutlineTreeProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkCanceled()
void	createChildren(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected EObjectNode	createNode(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
IOutlineNode	createRoot(IXtextDocument document)
IOutlineNode	createRoot(IXtextDocument document, CancelIndicator cancelIndicator)
protected org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor(Object modelElement)
protected org.eclipse.jface.viewers.ILabelProvider	getLabelProvider() TODO will provide an annotatedWith based Binding later
protected OutlineNodeFactory	getOutlineNodeFactory()
protected Object	getText(Object modelElement)
protected void	internalCreateChildren(DocumentRootNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	internalCreateChildren(EStructuralFeatureNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected void	internalCreateChildren(IOutlineNode parentNode, org.eclipse.emf.ecore.EObject modelElement)
protected boolean	isLeaf(org.eclipse.emf.ecore.EObject modelElement)

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundOutlineTreeProvider

public BackgroundOutlineTreeProvider()

Method Detail

createRoot

public IOutlineNode createRoot(IXtextDocument document,
                      CancelIndicator cancelIndicator)

Specified by:

createRoot in interface IOutlineTreeProvider.Cancelable

Since:

2.7

createRoot

public IOutlineNode createRoot(IXtextDocument document)

Specified by:

createRoot in interface IOutlineTreeProvider

checkCanceled

protected void checkCanceled()

Since:

2.7

createChildren

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

Specified by:

createChildren in interface IOutlineTreeStructureProvider

internalCreateChildren

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

internalCreateChildren

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

internalCreateChildren

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

createNode

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

getImageDescriptor

protected org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(Object modelElement)

getText

protected Object getText(Object modelElement)

isLeaf

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

getOutlineNodeFactory

protected OutlineNodeFactory getOutlineNodeFactory()

getLabelProvider

protected org.eclipse.jface.viewers.ILabelProvider getLabelProvider()

TODO will provide an annotatedWith based Binding later

Since:

2.7