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
-
-
Field Summary
-
Fields inherited from interface org.eclipse.xtext.formatting2.ITextReplacer
GET_REGION
-
-
Constructor Summary
Constructors Constructor Description SubDocument(ITextSegment region, IFormattableDocument parent)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, getReplacers, 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.internal.ICompositeTextReplacer
addReplacer
-
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
-
-
-
-
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 interfaceITextReplacer
- Overrides:
createReplacements
in classFormattableDocument
-
getFormatter
public AbstractFormatter2 getFormatter()
Description copied from interface:IFormattableDocument
Returns the formatter that is being used.- Specified by:
getFormatter
in interfaceIFormattableDocument
-
getRegion
public ITextSegment getRegion()
Description copied from interface:IFormattableDocument
Returns the region this formattable document is responsible for.- Specified by:
getRegion
in interfaceIFormattableDocument
- Specified by:
getRegion
in interfaceITextReplacer
-
getRequest
public FormatterRequest getRequest()
Description copied from interface:IFormattableDocument
Returns the current formatting request.- Specified by:
getRequest
in interfaceIFormattableDocument
-
requireFitsInLine
public IFormattableSubDocument requireFitsInLine()
- Specified by:
requireFitsInLine
in interfaceIFormattableSubDocument
-
requireFitsInLine
public IFormattableSubDocument requireFitsInLine(int offset, int length)
-
requireFitsInLine
public IFormattableSubDocument requireFitsInLine(int offset, int length, int maxLineWidth)
- Specified by:
requireFitsInLine
in interfaceIFormattableSubDocument
-
-