org.eclipse.xtext.formatting2.internal

Class SubDocument

java.lang.Object

org.eclipse.xtext.formatting2.internal.FormattableDocument

org.eclipse.xtext.formatting2.internal.SubDocument

All Implemented Interfaces:

IFormattableDocument, IFormattableSubDocument, ICompositeTextReplacer, ITextReplacer

Direct Known Subclasses:

FilteredSubDocument, MaxLineWidthDocument

public class SubDocument
extends FormattableDocument
implements IFormattableSubDocument, ICompositeTextReplacer

Author:

Moritz Eysholdt - Initial contribution and API

Field Summary

Fields inherited from interface org.eclipse.xtext.formatting2.ITextReplacer

GET_REGION

Constructor Summary

Constructors

Constructor and Description
SubDocument(ITextSegment region, IFormattableDocument parent)

Method Summary

Methods

Modifier and Type	Method and Description
ITextReplacerContext	createReplacements(ITextReplacerContext previous) Creates the real replacements for this region.
AbstractFormatter2	getFormatter() Returns the formatter that is being used.
ITextSegment	getRegion() Returns the region this formattable document is responsible for.
FormatterRequest	getRequest() Returns the current formatting request.
IFormattableSubDocument	requireFitsInLine()
IFormattableSubDocument	requireFitsInLine(int offset, int length)
IFormattableSubDocument	requireFitsInLine(int offset, int length, int maxLineWidth)

Methods inherited from class org.eclipse.xtext.formatting2.internal.FormattableDocument

addReplacer, append, append, applyTextReplacements, createTextReplacerSet, format, formatConditionally, formatConditionally, getPreferences, getTextRegionAccess, interior, interior, interior, needsAutowrap, prepend, prepend, renderToTextReplacements, set, set, surround, surround, toString, withReplacerFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.xtext.formatting2.IFormattableDocument

addReplacer, append, append, format, formatConditionally, formatConditionally, interior, interior, interior, prepend, prepend, renderToTextReplacements, set, set, surround, surround, withReplacerFilter

Methods inherited from interface org.eclipse.xtext.formatting2.internal.ICompositeTextReplacer

addReplacer

Constructor Detail

SubDocument

public SubDocument(ITextSegment region,
           IFormattableDocument parent)

Method Detail

createReplacements

public ITextReplacerContext createReplacements(ITextReplacerContext previous)

Description copied from interface: ITextReplacer

Creates the real replacements for this region. The given context may be altered and returned afterwards.

Specified by:

createReplacements in interface ITextReplacer

Overrides:

createReplacements in class FormattableDocument

getFormatter

public AbstractFormatter2 getFormatter()

Description copied from interface: IFormattableDocument

Returns the formatter that is being used.

Specified by:

getFormatter in interface IFormattableDocument

getRegion

public ITextSegment getRegion()

Description copied from interface: IFormattableDocument

Returns the region this formattable document is responsible for.

Specified by:

getRegion in interface IFormattableDocument

Specified by:

getRegion in interface ITextReplacer

getRequest

public FormatterRequest getRequest()

Description copied from interface: IFormattableDocument

Returns the current formatting request.

Specified by:

getRequest in interface IFormattableDocument

requireFitsInLine

public IFormattableSubDocument requireFitsInLine()

Specified by:

requireFitsInLine in interface IFormattableSubDocument

requireFitsInLine

public IFormattableSubDocument requireFitsInLine(int offset,
                                        int length)

requireFitsInLine

public IFormattableSubDocument requireFitsInLine(int offset,
                                        int length,
                                        int maxLineWidth)

Specified by:

requireFitsInLine in interface IFormattableSubDocument