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

Class AbstractOutlineNode

java.lang.Object

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

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IOutlineNode, IOutlineNode.Extension, IReadAccess<org.eclipse.emf.ecore.EObject>

Direct Known Subclasses:

DocumentRootNode, EObjectNode, EStructuralFeatureNode

public abstract class AbstractOutlineNode
extends Object
implements IOutlineNode, IOutlineNode.Extension

Author:

Jan Koehnlein - Initial contribution and API

Nested Class Summary

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

IOutlineNode.Extension

Nested classes/interfaces inherited from interface org.eclipse.xtext.util.concurrent.IReadAccess

IReadAccess.Priority<P>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOutlineNode(IOutlineNode parent, org.eclipse.jface.resource.ImageDescriptor imageDescriptor, Object text, boolean isLeaf)
protected	AbstractOutlineNode(IOutlineNode parent, org.eclipse.swt.graphics.Image image, Object text, boolean isLeaf) A BackgroundOutlineTreeProvider must use AbstractOutlineNode(IOutlineNode, ImageDescriptor, Object, boolean) instead.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addChild(IOutlineNode outlineNode)
Object	getAdapter(Class adapterType)
List<IOutlineNode>	getChildren()
IXtextDocument	getDocument()
protected org.eclipse.emf.common.util.URI	getEObjectURI()
ITextRegion	getFullTextRegion() The region that triggers selection of this node when "Link with Editor" is enabled.
org.eclipse.swt.graphics.Image	getImage() Deprecated. use getImageDescriptor() instead.
org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor()
IOutlineNode	getParent()
ITextRegion	getSignificantTextRegion() The region that is selected in the editor when this node is double clicked or selected in "Link with Editor" mode.
Object	getText()
IOutlineTreeStructureProvider	getTreeProvider()
boolean	hasChildren()
<T> T	readOnly(IUnitOfWork<T,org.eclipse.emf.ecore.EObject> work)
protected boolean	removeChild(IOutlineNode outlineNode)
void	setImage(org.eclipse.swt.graphics.Image image)
void	setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor imageDescriptor)
protected void	setParent(IOutlineNode newParent)
void	setText(Object text)
void	setTextRegion(ITextRegion textRegion)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOutlineNode

protected AbstractOutlineNode(IOutlineNode parent,
                   org.eclipse.swt.graphics.Image image,
                   Object text,
                   boolean isLeaf)

A BackgroundOutlineTreeProvider must use AbstractOutlineNode(IOutlineNode, ImageDescriptor, Object, boolean) instead.

AbstractOutlineNode

protected AbstractOutlineNode(IOutlineNode parent,
                   org.eclipse.jface.resource.ImageDescriptor imageDescriptor,
                   Object text,
                   boolean isLeaf)

Since:

2.4

Method Detail

setParent

protected void setParent(IOutlineNode newParent)

addChild

protected boolean addChild(IOutlineNode outlineNode)

removeChild

protected boolean removeChild(IOutlineNode outlineNode)

getChildren

public List<IOutlineNode> getChildren()

Specified by:

getChildren in interface IOutlineNode

getParent

public IOutlineNode getParent()

Specified by:

getParent in interface IOutlineNode

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface IOutlineNode

getText

public Object getText()

Specified by:

getText in interface IOutlineNode

setText

public void setText(Object text)

getImage

@Deprecated
public org.eclipse.swt.graphics.Image getImage()

Deprecated. use getImageDescriptor() instead.

Specified by:

getImage in interface IOutlineNode

setImage

public void setImage(org.eclipse.swt.graphics.Image image)

getImageDescriptor

public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor()

Specified by:

getImageDescriptor in interface IOutlineNode.Extension

Since:

2.4

setImageDescriptor

public void setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor imageDescriptor)

Since:

2.4

getDocument

public IXtextDocument getDocument()

getTreeProvider

public IOutlineTreeStructureProvider getTreeProvider()

setTextRegion

public void setTextRegion(ITextRegion textRegion)

getFullTextRegion

public ITextRegion getFullTextRegion()

Description copied from interface: IOutlineNode

The region that triggers selection of this node when "Link with Editor" is enabled.

Specified by:

getFullTextRegion in interface IOutlineNode

getSignificantTextRegion

public ITextRegion getSignificantTextRegion()

Description copied from interface: IOutlineNode

The region that is selected in the editor when this node is double clicked or selected in "Link with Editor" mode.

Specified by:

getSignificantTextRegion in interface IOutlineNode

toString

public String toString()

Overrides:

toString in class Object

getAdapter

public Object getAdapter(Class adapterType)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

getEObjectURI

protected org.eclipse.emf.common.util.URI getEObjectURI()

readOnly

public <T> T readOnly(IUnitOfWork<T,org.eclipse.emf.ecore.EObject> work)

Specified by:

readOnly in interface IReadAccess<org.eclipse.emf.ecore.EObject>