Package com.intellij.codeInsight.intention.impl

Class EncapsulateFieldAction

java.lang.Object

com.intellij.codeInsight.intention.impl.BaseIntentionAction

com.intellij.codeInsight.intention.PsiElementBaseIntentionAction

com.intellij.refactoring.BaseRefactoringIntentionAction

com.intellij.codeInsight.intention.impl.EncapsulateFieldAction

All Implemented Interfaces:

FileModifier, HighPriorityAction, IntentionAction, PriorityAction, WriteActionAware, Iconable

public class EncapsulateFieldAction
extends BaseRefactoringIntentionAction

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Nested classes/interfaces inherited from interface com.intellij.codeInsight.intention.PriorityAction

PriorityAction.Priority

Field Summary

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.codeInsight.intention.IntentionAction

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
EncapsulateFieldAction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamilyName() Returns the name of the family of intentions.
protected static PsiField	getField(PsiElement element)
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
void	invoke(Project project, Editor editor, PsiElement element) Invokes intention action for the element under caret.
boolean	isAvailable(Project project, Editor editor, PsiElement element) Checks whether this intention is available at a caret offset in file.
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class com.intellij.refactoring.BaseRefactoringIntentionAction

getIcon

Methods inherited from class com.intellij.codeInsight.intention.PsiElementBaseIntentionAction

checkFile, invoke, isAvailable

Methods inherited from class com.intellij.codeInsight.intention.impl.BaseIntentionAction

canModify, setText, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.intention.HighPriorityAction

getPriority

Methods inherited from interface com.intellij.codeInsight.intention.FileModifier

getElementToMakeWritable

Constructor Detail

EncapsulateFieldAction

public EncapsulateFieldAction()

Method Detail

getText

public java.lang.String getText()

Description copied from interface: IntentionAction

Returns text to be shown in the list of available actions, if this action is available.

Specified by:

getText in interface IntentionAction

Overrides:

getText in class BaseIntentionAction

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

getFamilyName

public final java.lang.String getFamilyName()

Description copied from interface: IntentionAction

Returns the name of the family of intentions. It is used to externalize "auto-show" state of intentions. When the user clicks on a light bulb in intention list, all intentions with the same family name get enabled/disabled. The name is also shown in settings tree.

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

isAvailable

public boolean isAvailable(Project project,
                           Editor editor,
                           PsiElement element)

Description copied from class: PsiElementBaseIntentionAction

Checks whether this intention is available at a caret offset in file. If this method returns true, a light bulb for this intention is shown.

Specified by:

isAvailable in class PsiElementBaseIntentionAction

Parameters:

project - the project in which the availability is checked.

editor - the editor in which the intention will be invoked.

element - the element under caret.

Returns:

true if the intention is available, false otherwise.

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiElement element)
            throws IncorrectOperationException

Description copied from class: PsiElementBaseIntentionAction

Invokes intention action for the element under caret.

Specified by:

invoke in class PsiElementBaseIntentionAction

Parameters:

project - the project in which the file is opened.

editor - the editor for the file.

element - the element under cursor.

Throws:

IncorrectOperationException

getField

protected static PsiField getField(PsiElement element)

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: IntentionAction

Indicate whether this action should be invoked inside write action. Should return false if, e.g., a modal dialog is shown inside the action. If false is returned the action itself is responsible for starting write action when needed, by calling Application.runWriteAction(Runnable).

Specified by:

startInWriteAction in interface IntentionAction

Specified by:

startInWriteAction in interface WriteActionAware

Overrides:

startInWriteAction in class BaseIntentionAction

Returns:

true if the intention requires a write action, false otherwise.