Package com.intellij.codeInsight.intention.impl

Class SurroundAutoCloseableAction.Template

java.lang.Object

com.intellij.codeInsight.intention.impl.SurroundAutoCloseableAction.Template

All Implemented Interfaces:

SurroundDescriptor, Surrounder

Enclosing class:

SurroundAutoCloseableAction

public static class SurroundAutoCloseableAction.Template
extends java.lang.Object
implements SurroundDescriptor, Surrounder

Field Summary

Fields inherited from interface com.intellij.lang.surroundWith.Surrounder

EMPTY_ARRAY, myArrayFactory

Constructor Summary

Constructors

Constructor and Description
Template()

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.
java.lang.String	getTemplateDescription() Returns the user-visible name of the Surround With template.
boolean	isApplicable(PsiElement [] elements) Checks if the template can be used to surround the specified range of elements.
boolean	isExclusive()
TextRange	surroundElements(Project project, Editor editor, PsiElement [] elements) Performs the Surround With action on the specified range of elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template()

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

getTemplateDescription

public java.lang.String getTemplateDescription()

Description copied from interface: Surrounder

Returns the user-visible name of the Surround With template.

Specified by:

getTemplateDescription in interface Surrounder

Returns:

the template name

isApplicable

public boolean isApplicable(PsiElement [] elements)

Description copied from interface: Surrounder

Checks if the template can be used to surround the specified range of elements.

Specified by:

isApplicable in interface Surrounder

Parameters:

elements - the elements to be surrounded

Returns:

true if the template is applicable to the elements, false otherwise.

surroundElements

public TextRange surroundElements(Project project,
                                  Editor editor,
                                  PsiElement [] elements)

Description copied from interface: Surrounder

Performs the Surround With action on the specified range of elements.

Specified by:

surroundElements in interface Surrounder

Parameters:

project - the project containing the elements.

editor - the editor in which the action is invoked.

elements - the elements to be surrounded.

Returns:

range to select/to position the caret