Package com.intellij.lang.folding

Class CustomFoldingSurroundDescriptor

java.lang.Object

com.intellij.lang.folding.CustomFoldingSurroundDescriptor

All Implemented Interfaces:

SurroundDescriptor

public class CustomFoldingSurroundDescriptor
extends java.lang.Object
implements SurroundDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static CustomFoldingSurroundDescriptor	INSTANCE
static com.intellij.lang.folding.CustomFoldingSurroundDescriptor.CustomFoldingRegionSurrounder[]	SURROUNDERS

Constructor Summary

Constructors

Constructor and Description
CustomFoldingSurroundDescriptor()

Method Summary

Modifier and Type	Method and Description
PsiElement []	getElementsToSurround(PsiFile file, int startOffset, int endOffset) Returns the list of elements which will be included in the surrounded region for the specified selection in the specified file, or an empty array if no surrounders from this surround descriptor are applicable to the specified selection.
Surrounder []	getSurrounders() Returns the list of surrounders (surround templates) which can be used for this code fragment type.
boolean	isExclusive()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final CustomFoldingSurroundDescriptor INSTANCE

SURROUNDERS

public static final com.intellij.lang.folding.CustomFoldingSurroundDescriptor.CustomFoldingRegionSurrounder[] SURROUNDERS

Constructor Detail

CustomFoldingSurroundDescriptor

public CustomFoldingSurroundDescriptor()

Method Detail

getElementsToSurround

public PsiElement [] getElementsToSurround(PsiFile file,
                                           int startOffset,
                                           int endOffset)

Description copied from interface: SurroundDescriptor

Returns the list of elements which will be included in the surrounded region for the specified selection in the specified file, or an empty array if no surrounders from this surround descriptor are applicable to the specified selection.

Specified by:

getElementsToSurround in interface SurroundDescriptor

Parameters:

file - the file where elements are to be surrounded.

startOffset - the selection start offset, with whitespaces skipped

endOffset - the selection end offset, with whitespaces skipped

Returns:

the elements to be surrounded, or an empty array if cannot surround

getSurrounders

public Surrounder [] getSurrounders()

Description copied from interface: SurroundDescriptor

Returns the list of surrounders (surround templates) which can be used for this code fragment type.

Specified by:

getSurrounders in interface SurroundDescriptor

Returns:

the list of surrounders.

isExclusive

public boolean isExclusive()

Specified by:

isExclusive in interface SurroundDescriptor