Package com.intellij.formatting

Class WrapImpl

java.lang.Object

com.intellij.formatting.Wrap

com.intellij.formatting.WrapImpl

public class WrapImpl
extends Wrap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrapImpl.Type

Constructor Summary

Constructors

Constructor and Description
WrapImpl(WrapType type, boolean wrapFirstElement)

Method Summary

Modifier and Type	Method and Description
LeafBlockWrapper	getChopStartBlock()
boolean	getIgnoreParentWraps()
WrapImpl	getParent() Allows to check if single wrap is registered for the current wrap and return it in case of success.
WrapImpl.Type	getType()
int	getWrapOffset()
void	ignoreParentWrap(WrapImpl wrap, LeafBlockWrapper currentBlock) Allows to mark given wrap as 'ignored' for the given block.
void	ignoreParentWraps() Allows to instruct current wrap to ignore all parent wraps, i.e.
boolean	isActive()
boolean	isChildOf(WrapImpl wrap, LeafBlockWrapper leaf)
boolean	isChildOf(WrapImpl wrap, LeafBlockWrapper leaf, FormatterIterationMonitor<java.lang.Boolean> iterationMonitor)
boolean	isWrapFirstElement() Allows to check if current wrap object is configured to wrap first element.
void	reset() Resets the following state of the current wrap object: 'firstEntry' property value is set to null; 'firstPosition' property value is set to '-1'; 'isActive' property value is set to 'false';
void	saveChopBlock(LeafBlockWrapper current)
void	setActive() Performs the following changes at wrap object state: 'firstEntry' property value is dropped (set to null) 'isActive' property value is set (to true)
void	setWrapOffset(int startOffset) Applies given value to the 'firstPosition' property value if it's value is undefined at the moment (has negative value).
java.lang.String	toString()

Methods inherited from class com.intellij.formatting.Wrap

createChildWrap, createWrap, createWrap

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapImpl

public WrapImpl(WrapType type,
                boolean wrapFirstElement)

Method Detail

isChildOf

public boolean isChildOf(WrapImpl wrap,
                         LeafBlockWrapper leaf)

isChildOf

public boolean isChildOf(WrapImpl wrap,
                         LeafBlockWrapper leaf,
                         FormatterIterationMonitor<java.lang.Boolean> iterationMonitor)

reset

public void reset()

Resets the following state of the current wrap object:

• 'firstEntry' property value is set to null;
• 'firstPosition' property value is set to '-1';
• 'isActive' property value is set to 'false';

getParent

public WrapImpl getParent()

Allows to check if single wrap is registered for the current wrap and return it in case of success.

Returns:

single wrap registered as a parent of the current wrap if any; null if no wraps or more than one wrap is registered as a parent for the current wrap

getIgnoreParentWraps

public final boolean getIgnoreParentWraps()

ignoreParentWrap

public void ignoreParentWrap(WrapImpl wrap,
                             LeafBlockWrapper currentBlock)

Allows to mark given wrap as 'ignored' for the given block. I.e. 'false' will be returned for subsequent calls to isChildOf(WrapImpl, LeafBlockWrapper) with the same arguments.

Parameters:

wrap - target wrap

currentBlock - target block for which given wrap should be ignored

getChopStartBlock

public LeafBlockWrapper getChopStartBlock()

setActive

public void setActive()

Performs the following changes at wrap object state:

• 'firstEntry' property value is dropped (set to null)
• 'isActive' property value is set (to true)

setWrapOffset

public void setWrapOffset(int startOffset)

Applies given value to the 'firstPosition' property value if it's value is undefined at the moment (has negative value).

Parameters:

startOffset - new 'firstPosition' property value to use if current value is undefined (negative)

getWrapOffset

public int getWrapOffset()

Returns:

'firstPosition' property value defined previously via setWrapOffset(int) if any; '-1' otherwise

getType

public final WrapImpl.Type getType()

isWrapFirstElement

public final boolean isWrapFirstElement()

Allows to check if current wrap object is configured to wrap first element. This property is defined at constructor during object initialization and can't be changed later.

Returns:

'wrapFirstElement' property value

saveChopBlock

public void saveChopBlock(LeafBlockWrapper current)

isActive

public final boolean isActive()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

ignoreParentWraps

public void ignoreParentWraps()

Allows to instruct current wrap to ignore all parent wraps, i.e. all calls to isChildOf(WrapImpl, LeafBlockWrapper) return 'false' after invocation of this method.

Specified by:

ignoreParentWraps in class Wrap

See Also:

Wrap.createChildWrap(Wrap, WrapType, boolean)