Package com.intellij.codeInsight.generation

Class GenerateMembersHandlerBase

java.lang.Object

com.intellij.codeInsight.generation.GenerateMembersHandlerBase

All Implemented Interfaces:

CodeInsightActionHandler, FileModifier, ContextAwareActionHandler, WriteActionAware

Direct Known Subclasses:

GenerateConstructorHandler, GenerateEqualsHandler, GenerateFieldOrPropertyHandler, GenerateGetterSetterHandlerBase, GroovyGenerateEqualsHandler, GroovyGenerateMethodMissingHandler, GroovyGeneratePropertyMissingHandler

public abstract class GenerateMembersHandlerBase
extends java.lang.Object
implements CodeInsightActionHandler, ContextAwareActionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	myToCopyJavaDoc

Constructor Summary

Constructors

Constructor and Description
GenerateMembersHandlerBase(java.lang.String chooserTitle)

Method Summary

Modifier and Type	Method and Description
protected ClassMember []	chooseMembers(ClassMember[] members, boolean allowEmptySelection, boolean copyJavadocCheckbox, Project project, Editor editor)
protected ClassMember []	chooseOriginalMembers(PsiClass aClass, Project project)
protected ClassMember []	chooseOriginalMembers(PsiClass aClass, Project project, Editor editor)
protected void	cleanup()
protected MemberChooser<ClassMember>	createMembersChooser(ClassMember[] members, boolean allowEmptySelection, boolean copyJavadocCheckbox, Project project)
protected abstract GenerationInfo[]	generateMemberPrototypes(PsiClass aClass, ClassMember originalMember)
protected java.util.List<? extends GenerationInfo>	generateMemberPrototypes(PsiClass aClass, ClassMember[] members)
protected abstract ClassMember[]	getAllOriginalMembers(PsiClass aClass)
protected javax.swing.JComponent	getHeaderPanel(Project project)
protected java.lang.String	getHelpId()
protected java.lang.String	getNothingFoundMessage()
protected javax.swing.JComponent []	getOptionControls()
protected boolean	hasMembers(PsiClass aClass)
void	invoke(Project project, Editor editor, PsiFile file)
boolean	isAvailableForQuickList(Editor editor, PsiFile file, DataContext dataContext) Handlers could provide useful hints when they are actually not available, e.g.
protected void	notifyOnSuccess(Editor editor, ClassMember[] members, java.util.List<? extends GenerationInfo> generatedMembers)
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.codeInsight.intention.FileModifier

getElementToMakeWritable

Field Detail

myToCopyJavaDoc

protected boolean myToCopyJavaDoc

Constructor Detail

GenerateMembersHandlerBase

public GenerateMembersHandlerBase(java.lang.String chooserTitle)

Method Detail

isAvailableForQuickList

public boolean isAvailableForQuickList(Editor editor,
                                       PsiFile file,
                                       DataContext dataContext)

Description copied from interface: ContextAwareActionHandler

Handlers could provide useful hints when they are actually not available, e.g. 'No methods to implement', 'Selected block should represent ...', 'Caret should be positioned at the name of ...', etc. At the same time, when the action is invoked through refactorings quick list popup, generate popup or in another manner but not through main menu (shortcut or find action are treated the same), it's better to hide the action: it would pollute menu with one more choice but can't do anything.

Specified by:

isAvailableForQuickList in interface ContextAwareActionHandler

Returns:

It's assumed that handler is valid for file. Still should be lightweight, because is invoked from action update. false - if action won't proceed

hasMembers

protected boolean hasMembers(PsiClass aClass)

invoke

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

Specified by:

invoke in interface CodeInsightActionHandler

cleanup

protected void cleanup()

notifyOnSuccess

protected void notifyOnSuccess(Editor editor,
                               ClassMember[] members,
                               java.util.List<? extends GenerationInfo> generatedMembers)

getNothingFoundMessage

protected java.lang.String getNothingFoundMessage()

chooseOriginalMembers

protected ClassMember [] chooseOriginalMembers(PsiClass aClass,
                                               Project project)

chooseOriginalMembers

protected ClassMember [] chooseOriginalMembers(PsiClass aClass,
                                               Project project,
                                               Editor editor)

chooseMembers

protected ClassMember [] chooseMembers(ClassMember[] members,
                                       boolean allowEmptySelection,
                                       boolean copyJavadocCheckbox,
                                       Project project,
                                       Editor editor)

createMembersChooser

protected MemberChooser<ClassMember> createMembersChooser(ClassMember[] members,
                                                          boolean allowEmptySelection,
                                                          boolean copyJavadocCheckbox,
                                                          Project project)

getHeaderPanel

protected javax.swing.JComponent getHeaderPanel(Project project)

getOptionControls

protected javax.swing.JComponent [] getOptionControls()

getHelpId

protected java.lang.String getHelpId()

generateMemberPrototypes

protected java.util.List<? extends GenerationInfo> generateMemberPrototypes(PsiClass aClass,
                                                                            ClassMember[] members)
                                                                     throws IncorrectOperationException

Throws:

IncorrectOperationException

getAllOriginalMembers

protected abstract ClassMember[] getAllOriginalMembers(PsiClass aClass)

generateMemberPrototypes

protected abstract GenerationInfo[] generateMemberPrototypes(PsiClass aClass,
                                                             ClassMember originalMember)
                                                      throws IncorrectOperationException

Throws:

IncorrectOperationException

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: WriteActionAware

Indicate whether this action should be invoked inside write action.

Should return false if e.g. 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 WriteActionAware

Returns:

true if the action requires a write action (default), false otherwise.