Package com.intellij.largeFilesEditor.actions

Class LfeBaseProxyAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.largeFilesEditor.actions.LfeBaseProxyAction

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

LfeActionDisabled

public abstract class LfeBaseProxyAction
extends AnAction

Nested Class Summary

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

AnAction.TransparentUpdate

Field Summary

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

ACTIONS_KEY, EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected abstract void	actionPerformedForLfe(AnActionEvent e, LargeFileEditor largeFileEditor)
void	beforeActionPerformedUpdate(AnActionEvent e) Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard.
boolean	displayTextInToolbar() Override with true returned if your action has to display its text along with the icon when placed in the toolbar
boolean	isDefaultIcon() Returns true if the action has an internal, not user-customized icon.
boolean	isDumbAware()
boolean	isInInjectedContext()
boolean	isTransparentUpdate()
void	setDefaultIcon(boolean isDefaultIconSet) Sets the flag indicating whether the action has an internal or a user-customized icon.
void	setInjectedContext(boolean worksInInjected) Enables automatic detection of injected fragments in editor.
java.lang.String	toString()
void	update(AnActionEvent e) Updates the state of the action.
protected abstract void	updateForLfe(AnActionEvent e, LargeFileEditor largeFileEditor)

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

addTextOverride, applyTextOverride, copyFrom, copyShortcutFrom, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isEnabledInModalContext, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setEnabledInModalContext, setShortcutSet, startInTransaction, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Method Detail

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

actionPerformed

public 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

beforeActionPerformedUpdate

public void beforeActionPerformedUpdate(AnActionEvent e)

Description copied from class: AnAction

Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard. Default implementation delegates to AnAction.update(AnActionEvent).

Overrides:

beforeActionPerformedUpdate in class AnAction

Parameters:

e - Carries information on the invocation place and data available

displayTextInToolbar

public boolean displayTextInToolbar()

Description copied from class: AnAction

Override with true returned if your action has to display its text along with the icon when placed in the toolbar

Overrides:

displayTextInToolbar in class AnAction

setDefaultIcon

public void setDefaultIcon(boolean isDefaultIconSet)

Description copied from class: AnAction

Sets the flag indicating whether the action has an internal or a user-customized icon.

Overrides:

setDefaultIcon in class AnAction

Parameters:

isDefaultIconSet - true if the icon is internal, false if the icon is customized by the user.

isDefaultIcon

public boolean isDefaultIcon()

Description copied from class: AnAction

Returns true if the action has an internal, not user-customized icon.

Overrides:

isDefaultIcon in class AnAction

Returns:

true if the icon is internal, false if the icon is customized by the user.

setInjectedContext

public void setInjectedContext(boolean worksInInjected)

Description copied from class: AnAction

Enables automatic detection of injected fragments in editor. Values in DataContext, passed to the action, like EDITOR, PSI_FILE will refer to an injected fragment, if caret is currently positioned on it.

Overrides:

setInjectedContext in class AnAction

isInInjectedContext

public boolean isInInjectedContext()

Overrides:

isInInjectedContext in class AnAction

isTransparentUpdate

public boolean isTransparentUpdate()

Overrides:

isTransparentUpdate in class AnAction

isDumbAware

public boolean isDumbAware()

toString

public java.lang.String toString()

Overrides:

toString in class AnAction

updateForLfe

protected abstract void updateForLfe(AnActionEvent e,
                                     LargeFileEditor largeFileEditor)

actionPerformedForLfe

protected abstract void actionPerformedForLfe(AnActionEvent e,
                                              LargeFileEditor largeFileEditor)