org.eclipse.xtext.formatting2.internal

Class AbstractHiddenRegionFormatter

java.lang.Object

org.eclipse.xtext.formatting2.internal.AbstractHiddenRegionFormatter

All Implemented Interfaces:

IHiddenRegionFormatter

Direct Known Subclasses:

DoubleHiddenRegionFormatter, SingleHiddenRegionFormatter

public abstract class AbstractHiddenRegionFormatter
extends Object
implements IHiddenRegionFormatter

Since:

2.9

Author:

Moritz Eysholdt - Initial contribution and API

Field Summary

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

HIGH_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractHiddenRegionFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
void	highPriority() When merging, treat this configuration with a high priority.
void	lowPriority() When merging, treat this configuration with a low priority.
void	newLine() Forces a line break in this hidden region.
void	noSpace() Format this hidden region with using no space (zero characters).
void	oneSpace() One space is added at this hidden region.
void	setNewLines(int newLines) Forces the number of newlines in this hidden region.

Methods inherited from class java.lang.Object

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

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

autowrap, autowrap, getRequest, indent, noAutowrap, noIndentation, setNewLines, setOnAutowrap, setPriority, setSpace

Constructor Detail

AbstractHiddenRegionFormatter

public AbstractHiddenRegionFormatter()

Method Detail

highPriority

public void highPriority()

Description copied from interface: IHiddenRegionFormatter

When merging, treat this configuration with a high priority.

Specified by:

highPriority in interface IHiddenRegionFormatter

See Also:

IHiddenRegionFormatter.lowPriority(), IHiddenRegionFormatter.HIGH_PRIORITY

lowPriority

public void lowPriority()

Description copied from interface: IHiddenRegionFormatter

When merging, treat this configuration with a low priority.

Specified by:

lowPriority in interface IHiddenRegionFormatter

See Also:

IHiddenRegionFormatter.highPriority(), IHiddenRegionFormatter.LOW_PRIORITY

newLine

public void newLine()

Description copied from interface: IHiddenRegionFormatter

Forces a line break in this hidden region. Same as setNewLines(1).

Specified by:

newLine in interface IHiddenRegionFormatter

noSpace

public void noSpace()

Description copied from interface: IHiddenRegionFormatter

Format this hidden region with using no space (zero characters). Same as setSpace("").

Specified by:

noSpace in interface IHiddenRegionFormatter

oneSpace

public void oneSpace()

Description copied from interface: IHiddenRegionFormatter

One space is added at this hidden region. Same as setSpace(" ").

Specified by:

oneSpace in interface IHiddenRegionFormatter

setNewLines

public void setNewLines(int newLines)

Description copied from interface: IHiddenRegionFormatter

Forces the number of newlines in this hidden region. Same as setNewLines(nl, nl, nl)

Specified by:

setNewLines in interface IHiddenRegionFormatter