hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 02:07:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

action.update description and example

Browse Source
This commit is contained in:
Anna Bulenkova 2014-12-04 16:02:31 +01:00
parent 7bde3b3df4
commit 54f82832e4
1 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
tutorials/action_system.md
View File

@ -8,6 +8,8 @@ The object of type [AnActionEvent] (https://github.com/JetBrains/intellij-commun
passed to this method carries the information about the current context for the action, passed to this method carries the information about the current context for the action,
and in particular, the specific presentation which needs to be updated. and in particular, the specific presentation which needs to be updated.
----------------
#How create a new menu item and bidn an action to it? #How create a new menu item and bidn an action to it?
To register an action as a menu item, an <action> attribute should be added to the <actions> section of the plugin configuration file To register an action as a menu item, an <action> attribute should be added to the <actions> section of the plugin configuration file
[plugin.xml] (https://github.com/JetBrains/intellij-sdk/blob/master/code_samples/plugin_sample/META-INF/plugin.xml) [plugin.xml] (https://github.com/JetBrains/intellij-sdk/blob/master/code_samples/plugin_sample/META-INF/plugin.xml)
@ -52,3 +54,45 @@ To register an action as a menu item, an <action> attribute should be added to t
[Link to source code] (https://github.com/JetBrains/intellij-sdk/blob/master/code_samples/plugin_sample/META-INF/plugin.xml) [Link to source code] (https://github.com/JetBrains/intellij-sdk/blob/master/code_samples/plugin_sample/META-INF/plugin.xml)
-----------
#How to make an action available and visible?
You need to override
AnAction.update
Default implementation of this method 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, for instance, if an action is added to a toolbar, it will be updated twice a second.
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 is not.
If you cannot understand the state of
the action fast you should do it in the [AnActionEvent] (https://github.com/JetBrains/intellij-community/blob/ff16ce78a1e0ddb6e67fd1dbc6e6a597e20d483a/platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnActionEvent.java)
method and notify
the user that action cannot be executed if it's the case.
Parameter e carries information on the invocation place and data available
public class SimpleAction extends AnAction {
@Override
public void actionPerformed(@NotNull AnActionEvent anActionEvent) {
}
@Override
public void update(@NotNull AnActionEvent e) {
e.getPresentation().setVisible(true);
e.getPresentation().setEnabled(true);
}
}
[Link to source code] (https://github.com/JetBrains/intellij-sdk/blob/master/code_samples/plugin_sample/src/org/jetbrains/plugins/sample/SimpleAction.java)
-------------