Package com.intellij.ide.actions

Class CreateFromTemplateAction<T extends PsiElement>

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.ide.actions.CreateFromTemplateAction<T>

All Implemented Interfaces:

WriteActionAware, PossiblyDumbAware

Direct Known Subclasses:

CreateFileFromTemplateAction, CreateTemplateInPackageAction

public abstract class CreateFromTemplateAction<T extends PsiElement>
extends AnAction
implements WriteActionAware

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CreateFromTemplateAction(java.lang.String text, java.lang.String description, javax.swing.Icon icon)
CreateFromTemplateAction(java.util.function.Supplier<java.lang.String> dynamicText, java.util.function.Supplier<java.lang.String> dynamicDescription, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected abstract void	buildDialog(Project project, PsiDirectory directory, CreateFileFromTemplateDialog.Builder builder)
protected abstract T	createFile(java.lang.String name, java.lang.String templateName, PsiDirectory dir)
protected abstract java.lang.String	getActionName(PsiDirectory directory, java.lang.String newName, java.lang.String templateName)
protected java.lang.String	getDefaultTemplateName(PsiDirectory dir)
protected java.lang.String	getDefaultTemplateProperty()
protected java.lang.String	getErrorTitle()
protected boolean	isAvailable(DataContext dataContext)
static void	moveCaretAfterNameIdentifier(PsiNameIdentifierOwner createdElement)
protected void	postProcess(T createdElement, java.lang.String templateName, java.util.Map<java.lang.String,java.lang.String> customProperties)
void	update(AnActionEvent e) Updates the state of the action.

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setInjectedContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.application.WriteActionAware

startInWriteAction

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

CreateFromTemplateAction

public CreateFromTemplateAction(java.lang.String text,
                                java.lang.String description,
                                javax.swing.Icon icon)

CreateFromTemplateAction

public CreateFromTemplateAction(java.util.function.Supplier<java.lang.String> dynamicText,
                                java.util.function.Supplier<java.lang.String> dynamicDescription,
                                javax.swing.Icon icon)

Method Detail

actionPerformed

public final void actionPerformed(AnActionEvent e)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

postProcess

protected void postProcess(T createdElement,
                           java.lang.String templateName,
                           java.util.Map<java.lang.String,java.lang.String> customProperties)

createFile

protected abstract T createFile(java.lang.String name,
                                java.lang.String templateName,
                                PsiDirectory dir)

buildDialog

protected abstract void buildDialog(Project project,
                                    PsiDirectory directory,
                                    CreateFileFromTemplateDialog.Builder builder)

getDefaultTemplateName

protected java.lang.String getDefaultTemplateName(PsiDirectory dir)

getDefaultTemplateProperty

protected java.lang.String getDefaultTemplateProperty()

update

public void update(AnActionEvent e)

Description copied from class: AnAction

Updates the state of the action. Default implementation does nothing. Override this method to provide the ability to dynamically change action's state and(or) presentation depending on the context (For example when your action state depends on the selection you can check for selection and change the state accordingly).

This method can be called frequently, and on UI thread. This means that this method is supposed to work really fast, no real work should be done at this phase. For example, checking selection in a tree or a list, is considered valid, but working with a file system or PSI (especially resolve) is not. If you cannot determine the state of the action fast enough, you should do it in the AnAction.actionPerformed(AnActionEvent) method and notify the user that action cannot be executed if it's the case.

If the action is added to a toolbar, its "update" can be called twice a second, but only if there was any user activity or a focus transfer. If your action's availability is changed in absence of any of these events, please call ActivityTracker.getInstance().inc() to notify action subsystem to update all toolbar actions when your subsystem's determines that its actions' visibility might be affected.

Overrides:

update in class AnAction

Parameters:

e - Carries information on the invocation place and data available

isAvailable

protected boolean isAvailable(DataContext dataContext)

getActionName

protected abstract java.lang.String getActionName(PsiDirectory directory,
                                                  java.lang.String newName,
                                                  java.lang.String templateName)

getErrorTitle

protected java.lang.String getErrorTitle()

moveCaretAfterNameIdentifier

public static void moveCaretAfterNameIdentifier(PsiNameIdentifierOwner createdElement)