org.eclipse.xtext.ui.editor.folding

Class DefaultFoldingRegionAcceptor

java.lang.Object

org.eclipse.xtext.ui.editor.folding.DefaultFoldingRegionAcceptor

All Implemented Interfaces:

IFoldingRegionAcceptor<ITextRegion>, IFoldingRegionAcceptorExtension<ITextRegion>

public class DefaultFoldingRegionAcceptor
extends Object
implements IFoldingRegionAcceptorExtension<ITextRegion>

Author:

Michael Clay - Initial contribution and API, Sebastian Zarnekow - Introduced FoldedPosition

Constructor Summary

Constructors

Constructor and Description
DefaultFoldingRegionAcceptor(IXtextDocument document, Collection<FoldedPosition> result)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(int offset, int length)
void	accept(int offset, int length, boolean initiallyFolded)
void	accept(int offset, int length, boolean initiallyFolded, ITextRegion significantRegion)
void	accept(int offset, int length, ITextRegion significantRegion)
protected org.eclipse.jface.text.IRegion	getLineRegion(int offset, int length)
protected FoldedPosition	newFoldedPosition(org.eclipse.jface.text.IRegion region, ITextRegion significantRegion)
protected FoldedPosition	newFoldedPosition(org.eclipse.jface.text.IRegion region, ITextRegion significantRegion, boolean initiallyFolded) Deprecated. use / override newFoldedPosition(IRegion, ITextRegion) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFoldingRegionAcceptor

public DefaultFoldingRegionAcceptor(IXtextDocument document,
                            Collection<FoldedPosition> result)

Method Detail

accept

public void accept(int offset,
          int length,
          boolean initiallyFolded,
          ITextRegion significantRegion)

Specified by:

accept in interface IFoldingRegionAcceptorExtension<ITextRegion>

Parameters:

offset - of the significant content

length - of the significant content

initiallyFolded - whether this region should be folded by default

significantRegion - used to compute the significant region.

Since:

2.8

accept

public void accept(int offset,
          int length,
          ITextRegion significantRegion)

Specified by:

accept in interface IFoldingRegionAcceptor<ITextRegion>

Parameters:

offset - of the significant content

length - of the significant content

significantRegion - used to compute the significant region.

accept

public void accept(int offset,
          int length,
          boolean initiallyFolded)

Specified by:

accept in interface IFoldingRegionAcceptorExtension<ITextRegion>

Parameters:

offset - of the significant content

length - of the significant content

initiallyFolded - whether this region should be folded by default

Since:

2.8

accept

public void accept(int offset,
          int length)

Specified by:

accept in interface IFoldingRegionAcceptor<ITextRegion>

getLineRegion

protected org.eclipse.jface.text.IRegion getLineRegion(int offset,
                                           int length)

newFoldedPosition

protected FoldedPosition newFoldedPosition(org.eclipse.jface.text.IRegion region,
                               ITextRegion significantRegion)

Returns:

a freshly created FoldedPosition

newFoldedPosition

@Deprecated
protected FoldedPosition newFoldedPosition(org.eclipse.jface.text.IRegion region,
                                          ITextRegion significantRegion,
                                          boolean initiallyFolded)

Deprecated. use / override newFoldedPosition(IRegion, ITextRegion) instead

Returns:

a freshly created FoldedPosition

Since:

2.8