org.eclipse.xtext.formatting2.internal

Class HiddenRegionReplacer

java.lang.Object

org.eclipse.xtext.formatting2.internal.HiddenRegionReplacer

All Implemented Interfaces:

ITextReplacer

public class HiddenRegionReplacer
extends java.lang.Object
implements ITextReplacer

Field Summary

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

GET_REGION

Constructor Summary

Constructors

Constructor and Description
HiddenRegionReplacer(IHiddenRegion region, IHiddenRegionFormatting formatting)

Method Summary

Modifier and Type	Method and Description
protected void	applyHiddenRegionFormatting(java.util.List<ITextReplacer> replacers) This method is called when we have multiple TextReplacers for this HiddenRegion because the HiddenRegion contains comments.
protected void	applyIndentation(java.util.List<ITextReplacer> replacers, IHiddenRegionFormatting separator)
protected void	applyPriorityAndDefaultFormatting(java.util.List<ITextReplacer> replacers, IHiddenRegionFormatting separator)
protected void	applySeparatorConfiguration(IHiddenRegionFormatting separator) Apply newline and space configuration to the first whitespace region that follows or contains a linewrap.
ITextReplacerContext	createReplacements(ITextReplacerContext context) Creates the real replacements for this region.
protected java.util.List<ITextReplacer>	createReplacers(AbstractFormatter2 formatter)
protected WhitespaceReplacer	findWhitespaceThatSeparatesSemanticRegions(java.util.List<ITextReplacer> replacers)
IHiddenRegionFormatting	getFormatting()
IHiddenRegion	getRegion() The region this replace is responsible for.
protected void	introduceNewlinesAroundMLComments(java.util.List<ITextReplacer> replacers)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HiddenRegionReplacer

public HiddenRegionReplacer(IHiddenRegion region,
                            IHiddenRegionFormatting formatting)

Method Detail

applyHiddenRegionFormatting

protected void applyHiddenRegionFormatting(java.util.List<ITextReplacer> replacers)

This method is called when we have multiple TextReplacers for this HiddenRegion because the HiddenRegion contains comments. It applies the formatting configuration from formatting to the WhitespaceReplacer that surrounds the comment.

applyIndentation

protected void applyIndentation(java.util.List<ITextReplacer> replacers,
                                IHiddenRegionFormatting separator)

Since:

2.23

applySeparatorConfiguration

protected void applySeparatorConfiguration(IHiddenRegionFormatting separator)

Apply newline and space configuration to the first whitespace region that follows or contains a linewrap.

Since:

2.23

applyPriorityAndDefaultFormatting

protected void applyPriorityAndDefaultFormatting(java.util.List<ITextReplacer> replacers,
                                                 IHiddenRegionFormatting separator)

Since:

2.23

introduceNewlinesAroundMLComments

protected void introduceNewlinesAroundMLComments(java.util.List<ITextReplacer> replacers)

Since:

2.23

createReplacements

public ITextReplacerContext createReplacements(ITextReplacerContext context)

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

createReplacers

protected java.util.List<ITextReplacer> createReplacers(AbstractFormatter2 formatter)

findWhitespaceThatSeparatesSemanticRegions

protected WhitespaceReplacer findWhitespaceThatSeparatesSemanticRegions(java.util.List<ITextReplacer> replacers)

getFormatting

public IHiddenRegionFormatting getFormatting()

getRegion

public IHiddenRegion getRegion()

Description copied from interface: ITextReplacer

The region this replace is responsible for. All text replacements create by this replacer must be inside this region.

Specified by:

getRegion in interface ITextReplacer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object