Package com.intellij.codeInsight.daemon.impl.analysis

Class CreateNSDeclarationIntentionFix

java.lang.Object

com.intellij.codeInsight.daemon.impl.analysis.CreateNSDeclarationIntentionFix

All Implemented Interfaces:

FileModifier, IntentionAction, HintAction, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

public class CreateNSDeclarationIntentionFix
extends java.lang.Object
implements HintAction, LocalQuickFix

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNSDeclarationIntentionFix.ExternalUriProcessor
static interface	CreateNSDeclarationIntentionFix.MetaHandler
static interface	CreateNSDeclarationIntentionFix.StringToAttributeProcessor
static class	CreateNSDeclarationIntentionFix.TagMetaHandler

Field Summary

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

EMPTY_ARRAY

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateNSDeclarationIntentionFix(PsiElement element, java.lang.String namespacePrefix)
	CreateNSDeclarationIntentionFix(PsiElement element, java.lang.String namespacePrefix, XmlToken token)

Method Summary

Modifier and Type	Method and Description
void	applyFix(Project project, ProblemDescriptor descriptor) Called to apply the fix.
static CreateNSDeclarationIntentionFix	createFix(PsiElement element, java.lang.String namespacePrefix)
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.
static java.lang.String	getUnboundNamespaceForPrefix(java.lang.String prefix, XmlFile xmlFile, java.util.Set<java.lang.String> namespaces) Given a prefix in a file and a set of candidate namespaces, returns the namespace that matches the prefix (if any) as determined by the XmlSchemaProvider.getDefaultPrefix(String, XmlFile) implementations
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.
static void	processExternalUris(CreateNSDeclarationIntentionFix.MetaHandler metaHandler, PsiFile file, CreateNSDeclarationIntentionFix.ExternalUriProcessor processor)
static void	runActionOverSeveralAttributeValuesAfterLettingUserSelectTheNeededOne(java.lang.String [] namespacesToChooseFrom, Project project, CreateNSDeclarationIntentionFix.StringToAttributeProcessor onSelection, java.lang.String title, IntentionAction requestor, Editor editor)
boolean	showHint(Editor editor) Show a popup or perform an automatic action in the given editor.
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInspection.HintAction

fixSilently

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

getElementToMakeWritable

Methods inherited from interface com.intellij.codeInspection.QuickFix

getName

Constructor Detail

CreateNSDeclarationIntentionFix

protected CreateNSDeclarationIntentionFix(PsiElement element,
                                          java.lang.String namespacePrefix)

CreateNSDeclarationIntentionFix

public CreateNSDeclarationIntentionFix(PsiElement element,
                                       java.lang.String namespacePrefix,
                                       XmlToken token)

Method Detail

createFix

public static CreateNSDeclarationIntentionFix createFix(PsiElement element,
                                                        java.lang.String namespacePrefix)

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

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

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.

Specified by:

getFamilyName in interface IntentionAction

Specified by:

getFamilyName in interface QuickFix<ProblemDescriptor>

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

applyFix

public void applyFix(Project project,
                     ProblemDescriptor descriptor)

Description copied from interface: QuickFix

Called to apply the fix.

Please call com.intellij.profile.codeInspection.ProjectInspectionProfileManager#fireProfileChanged() if inspection profile is changed as result of fix.

Specified by:

applyFix in interface QuickFix<ProblemDescriptor>

Parameters:

project - Project

descriptor - problem reported by the tool which provided this quick fix action

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.

Specified by:

isAvailable in interface IntentionAction

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.

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.

Specified by:

invoke in interface IntentionAction

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

getUnboundNamespaceForPrefix

public static java.lang.String getUnboundNamespaceForPrefix(java.lang.String prefix,
                                                            XmlFile xmlFile,
                                                            java.util.Set<java.lang.String> namespaces)

Given a prefix in a file and a set of candidate namespaces, returns the namespace that matches the prefix (if any) as determined by the XmlSchemaProvider.getDefaultPrefix(String, XmlFile) implementations

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

Returns:

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

showHint

public boolean showHint(Editor editor)

Description copied from interface: HintAction

Show a popup or perform an automatic action in the given editor. Invoked for the visible highlighting results (e.g. errors or warnings) on UI thread after the background highlighting is finished, without a write action. Before the invocation, IntentionAction.isAvailable(Project, Editor, PsiFile) is checked to be true.

Specified by:

showHint in interface HintAction

Returns:

whether anything user-visible happened: a popup was shown or anything has changed in document/PSI/project model

runActionOverSeveralAttributeValuesAfterLettingUserSelectTheNeededOne

public static void runActionOverSeveralAttributeValuesAfterLettingUserSelectTheNeededOne(java.lang.String [] namespacesToChooseFrom,
                                                                                         Project project,
                                                                                         CreateNSDeclarationIntentionFix.StringToAttributeProcessor onSelection,
                                                                                         java.lang.String title,
                                                                                         IntentionAction requestor,
                                                                                         Editor editor)
                                                                                  throws IncorrectOperationException

Throws:

IncorrectOperationException

processExternalUris

public static void processExternalUris(CreateNSDeclarationIntentionFix.MetaHandler metaHandler,
                                       PsiFile file,
                                       CreateNSDeclarationIntentionFix.ExternalUriProcessor processor)