Package com.intellij.codeInsight.intention.impl

Class ConvertAbsolutePathToRelativeIntentionAction

java.lang.Object

com.intellij.codeInsight.intention.impl.BaseIntentionAction

com.intellij.codeInsight.intention.impl.ConvertAbsolutePathToRelativeIntentionAction

All Implemented Interfaces:

FileModifier, IntentionAction, WriteActionAware

Direct Known Subclasses:

ConvertRelativePathToAbsoluteIntentionAction

public class ConvertAbsolutePathToRelativeIntentionAction
extends BaseIntentionAction

Field Summary

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ConvertAbsolutePathToRelativeIntentionAction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamilyName() Returns the name of the family of intentions.
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, PsiFile file) Called when user invokes intention.
boolean	isAvailable(Project project, Editor editor, PsiFile file) Checks whether this intention is available at a caret offset in the file.
protected boolean	isConvertToRelative()

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

canModify, setText, startInWriteAction, 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.FileModifier

getElementToMakeWritable

Constructor Detail

ConvertAbsolutePathToRelativeIntentionAction

public ConvertAbsolutePathToRelativeIntentionAction()

Method Detail

isConvertToRelative

protected boolean isConvertToRelative()

isAvailable

public boolean isAvailable(Project project,
                           Editor editor,
                           PsiFile file)

Description copied from interface: IntentionAction

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

Parameters:

project - the project in which the availability is checked.

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

file - the file open in the editor.

Returns:

true if the intention is available, false otherwise.

getFamilyName

public 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...)

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiFile file)
            throws IncorrectOperationException

Description copied from interface: IntentionAction

Called when user invokes intention. This method is called inside command. If IntentionAction.startInWriteAction() returns true, this method is also called inside write action.

Parameters:

project - the project in which the intention is invoked.

editor - the editor in which the intention is invoked.

file - the file open in the editor.

Throws:

IncorrectOperationException

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)