Package com.intellij.formatting

Class Wrap

java.lang.Object

com.intellij.formatting.Wrap

Direct Known Subclasses:

WrapImpl

public abstract class Wrap
extends java.lang.Object

The wrap setting for a formatting model block. Indicates the conditions under which a line break is inserted before the block when formatting, if the block extends beyond the right margin.

See Also:

Block.getWrap()

Constructor Summary

Constructors

Constructor and Description
Wrap()

Method Summary

Modifier and Type	Method and Description
static Wrap	createChildWrap(Wrap parentWrap, WrapType wrapType, boolean wrapFirstElement) Creates a low priority wrap setting of the specified type.
static Wrap	createWrap(int type, boolean wrapFirstElement) Creates a block wrap setting of the legacy representation of specified wrap type (see WrapType.getLegacyRepresentation()).
static Wrap	createWrap(WrapType type, boolean wrapFirstElement) Creates a block wrap setting of the specified type.
abstract void	ignoreParentWraps() Converts a low-priority wrap setting to a regular wrap setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wrap

public Wrap()

Method Detail

ignoreParentWraps

public abstract void ignoreParentWraps()

Converts a low-priority wrap setting to a regular wrap setting.

See Also:

createChildWrap(Wrap, WrapType, boolean)

createWrap

public static Wrap createWrap(int type,
                              boolean wrapFirstElement)

Creates a block wrap setting of the legacy representation of specified wrap type (see WrapType.getLegacyRepresentation()).

Parameters:

type - the type of the wrap setting.

wrapFirstElement - determines if first block between the multiple blocks that use the same wrap object should be wrapped

Returns:

the wrap setting instance.

See Also:

createWrap(WrapType, boolean)

createWrap

public static Wrap createWrap(WrapType type,
                              boolean wrapFirstElement)

Creates a block wrap setting of the specified type.

The wrap created may be customized by the 'wrap first element' flag. It affects a situation when there are multiple blocks that share the same wrap object. It determines if the first block should be wrapped when subsequent blocks exceeds right margin.

Example:

             |
   foo(123, 4|56
             |
             | <- right margin
 

Consider that blocks '123' and '456' share the same wrap object. The wrap is made on the block '123' if 'wrap first element' flag is true; on the block '456' otherwise

Note: giving 'false' argument doesn't mean that a single block that uses that wrap can't be wrapped.

Example:

         |
   foo(12|3);
         |
         | <- right margin
 

Let block '123' use a wrap that was created with false as a 'wrap first element' argument. The block is wrapped by the formatter then because there is no other block that uses the same wrap object and right margin is exceeded.

Parameters:

type - the type of the wrap setting.

wrapFirstElement - determines if first block between the multiple blocks that use the same wrap object should be wrapped

Returns:

the wrap setting instance.

createChildWrap

public static Wrap createChildWrap(Wrap parentWrap,
                                   WrapType wrapType,
                                   boolean wrapFirstElement)

Creates a low priority wrap setting of the specified type. If the formatter detects that the line should be wrapped at a location of the child wrap, the line is wrapped at the position of its parent wrap instead.

Parameters:

parentWrap - the parent for this wrap setting.

wrapType - the type of the wrap setting.

wrapFirstElement - if true, the first element in a sequence of elements of the same type is also wrapped.

Returns:

the wrap setting instance.

See Also:

ignoreParentWraps()