Child pages
  • IntelliJ IDEA Action System

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
xml
xml
    <!-- Actions -->
    <actions>
        <!-- The <action> element defines an action to register.
               The mandatory "id" attribute specifies an unique identifier for the action.
               The mandatory "class" attribute specifies the full-qualified name of the class implementing the action.
               The mandatory "text" attribute specifies the text of the action (tooltip for toolbar button or text for menu item).
              The optional "use-shortcut-of" attribute specifies the ID of the action whose keyboard shortcut this action will use.  
              The optional "description" attribute specifies the text which is displayed in the status bar when the action is focused.
               The optional "icon" attribute specifies the icon which is displayed on the toolbar button or next to the menu item. -->
        <action id="VssIntegration.GarbageCollection" class="com.foo.impl.CollectGarbage" text="Collect _Garbage" description="Run garbage collector"
                icon="icons/garbage.png">
             <!-- The <add-to-group> node specifies that the action should be added to an existing group. An action can be added to several groups.
                    The mandatory "group-id" attribute specifies the ID of the group to which the action is added.
                    The group must be implemented by an instance of the DefaultActionGroup class.
                    The mandatory "anchor" attribute specifies the position of the action in the group relative to other actions. It can have the values
                    "first", "last", "before" and "after".
                    The "relative-to-action" attribute is mandatory if the anchor is set to "before" and "after", and specifies the action before or after which
                    the current action is inserted. -->
            <add-to-group group-id="ToolsMenu" relative-to-action="GenerateJavadoc" anchor="after"/>
             <!-- The <keyboard-shortcut> node specifies the keyboard shortcut for the action. An action can have several keyboard shortcuts.
                    The mandatory "first-keystroke" attribute specifies the first keystroke of the action. The key strokes are specified according to the regular Swing rules.
                    The optional "second-keystroke" attribute specifies the second keystroke of the action.
                    The mandatory "keymap" attribute specifies the keymap for which the action is active. IDs of the standard keymaps are defined as
                    constants in the com.intellij.openapi.keymap.KeymapManager class. -->
            <keyboard-shortcut first-keystroke="control alt G" second-keystroke="C" keymap="$default"/>
             <!-- The <mouse-shortcut> node specifies the mouse shortcut for the action. An action can have several mouse shortcuts.
                    The mandatory "keystroke" attribute specifies the clicks and modifiers for the action. It is defined as a sequence of words separated by spaces:
                    "button1", "button2", "button3" for the mouse buttons; "shift", "control", "meta", "alt", "altGraph" for the modifier keys;
                    "doubleClick" if the action is activated by a double-click of the button.
                    The mandatory "keymap" attribute specifies the keymap for which the action is active. IDs of the standard keymaps are defined as
                    constants in the com.intellij.openapi.keymap.KeymapManager class. -->
            <mouse-shortcut keystroke="control button3 doubleClick" keymap="$default"/>
        </action>
        <!-- The <group> element defines an action group. <action>, <group> and <separator> elements defined within it are automatically included in the group.
               The mandatory "id" attribute specifies an unique identifier for the action.
               The optional "class" attribute specifies the full-qualified name of the class implementing the group. If not specified,
               com.intellij.openapi.actionSystem.DefaultActionGroup is used.
               The optional "text" attribute specifies the text of the group (text for the menu item showing the submenu).
               The optional "description" attribute specifies the text which is displayed in the status bar when the group is focused.
               The optional "icon" attribute specifies the icon which is displayed on the toolbar button or next to the group.
               The optional "popup" attribute specifies how the group is presented in the menu. If a group has popup="true", actions in it
               are placed in a submenu; for popup="false", actions are displayed as a section of the same menu delimited by separators. -->
        <group class="com.foo.impl.MyActionGroup" id="TestActionGroup" text="Test Group" description="Group with test actions"
               icon="icons/testgroup.png" popup="true">
            <action id="VssIntegration.TestAction" class="com.foo.impl.TestAction" text="My Test Action" description="My test action"/>
            <!-- The <separator> element defines a separator between actions. It can also have an <add-to-group> child element. -->
            <separator/>
            <group id="TestActionGroupTestActionSubGroup"/>
             <!-- The <reference> element allows to add an existing action to the group. The mandatory "ref" attribute specifies the ID of the action to add. -->
            <reference ref="EditorCopy"/>
            <add-to-group group-id="MainMenu" relative-to-action="HelpMenu" anchor="before"/>
        </group>
    </actions>

...