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

Incorporated Yann's feedback.

Browse Source
This commit is contained in:
JohnHake 2019-05-20 22:53:25 -07:00
parent 864a45c579
commit f089a2574c
4 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
action_basics/build.gradle
View File

@ -1,6 +1,6 @@
plugins { plugins {
id 'java' id 'java'
id 'org.jetbrains.intellij' version '0.4.7' id 'org.jetbrains.intellij' version '0.4.8'
} }
sourceCompatibility = 1.8 sourceCompatibility = 1.8

9
action_basics/src/main/java/org/intellij/sdk/action/DynamicActionGroup.java
View File

@ -2,7 +2,6 @@
package org.intellij.sdk.action; package org.intellij.sdk.action;
import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.ActionGroup; import com.intellij.openapi.actionSystem.ActionGroup;
import com.intellij.openapi.actionSystem.AnAction; import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.openapi.actionSystem.AnActionEvent;
@ -24,14 +23,14 @@ public class DynamicActionGroup extends ActionGroup {
/** /**
* Returns an array of menu actions for the group. * Returns an array of menu actions for the group.
* *
* @param anActionEvent Event received when the associated group-id menu is chosen. * @param e Event received when the associated group-id menu is chosen.
* @return AnAction[] An instance of AnAction, in this case containing a single instance of the * @return AnAction[] An instance of AnAction, in this case containing a single instance of the
* PopDialogAction class. * PopupDialogAction class.
*/ */
@NotNull @NotNull
@Override @Override
public AnAction[] getChildren(AnActionEvent anActionEvent) { public AnAction[] getChildren(AnActionEvent e) {
return new AnAction[]{ new PopDialogAction("Action Added at Runtime", return new AnAction[]{ new PopupDialogAction("Action Added at Runtime",
"Dynamic Action Demo", "Dynamic Action Demo",
ActionBasicsIcons.Sdk_default_icon) ActionBasicsIcons.Sdk_default_icon)
}; };

24
action_basics/src/main/java/org/intellij/sdk/action/PopDialogAction.java → action_basics/src/main/java/org/intellij/sdk/action/PopupDialogAction.java
View File

@ -19,15 +19,15 @@ import javax.swing.*;
* Typically this class is instantiated by the IntelliJ Platform framework based on declarations * Typically this class is instantiated by the IntelliJ Platform framework based on declarations
* in the plugin.xml file. But when added at runtime this class is instantiated by an action group. * in the plugin.xml file. But when added at runtime this class is instantiated by an action group.
*/ */
public class PopDialogAction extends AnAction { public class PopupDialogAction extends AnAction {
/** /**
* This default constructor is used by the IntelliJ Platform framework to * This default constructor is used by the IntelliJ Platform framework to
* instantiate this class based on plugin.xml declarations. Only needed in PopDialogAction * instantiate this class based on plugin.xml declarations. Only needed in PopupDialogAction
* class because a second constructor is overridden. * class because a second constructor is overridden.
* @see AnAction#AnAction() * @see AnAction#AnAction()
*/ */
public PopDialogAction() { public PopupDialogAction() {
super(); super();
} }
@ -35,12 +35,12 @@ public class PopDialogAction extends AnAction {
* This constructor is used to support dynamically added menu actions. * This constructor is used to support dynamically added menu actions.
* It sets the text, description to be displayed for the menu item. * It sets the text, description to be displayed for the menu item.
* Otherwise, the default AnAction constructor is used by the IntelliJ Platform. * Otherwise, the default AnAction constructor is used by the IntelliJ Platform.
* @param menuText The text to be displayed as a menu item. * @param text The text to be displayed as a menu item.
* @param menuDescription The description of the menu item. * @param description The description of the menu item.
* @param menuIcon The icon to be used with the menu item. * @param icon The icon to be used with the menu item.
*/ */
public PopDialogAction(@Nullable String menuText, @Nullable String menuDescription, @Nullable Icon menuIcon) { public PopupDialogAction(@Nullable String text, @Nullable String description, @Nullable Icon icon) {
super(menuText, menuDescription, menuIcon); super(text, description, icon);
} }
/** /**
@ -66,13 +66,13 @@ public class PopDialogAction extends AnAction {
/** /**
* Determines whether this menu item is available for the current context. * Determines whether this menu item is available for the current context.
* Requires a project to be open. * Requires a project to be open.
* @param evnt Event received when the associated group-id menu is chosen. * @param e Event received when the associated group-id menu is chosen.
*/ */
@Override @Override
public void update(AnActionEvent evnt) { public void update(AnActionEvent e) {
// Set the availability based on whether a project is open // Set the availability based on whether a project is open
Project project = evnt.getProject(); Project project = e.getProject();
evnt.getPresentation().setEnabledAndVisible(project != null); e.getPresentation().setEnabledAndVisible(project != null);
} }
} }

10
action_basics/src/main/resources/META-INF/plugin.xml
View File

@ -40,7 +40,7 @@
The optional "use-shortcut-of" attribute specifies the ID of the action whose keyboard shortcut this action will use. 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 "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. --> The optional "icon" attribute specifies the icon which is displayed on the toolbar button or next to the menu item. -->
<action id="org.intellij.sdk.action.PopDialogAction" class="org.intellij.sdk.action.PopDialogAction" <action id="org.intellij.sdk.action.PopupDialogAction" class="org.intellij.sdk.action.PopupDialogAction"
text="Pop Dialog Action" description="SDK Action Example" icon="ActionBasicsIcons.Sdk_default_icon"> text="Pop Dialog Action" description="SDK Action Example" icon="ActionBasicsIcons.Sdk_default_icon">
<!-- The <keyboard-shortcut> node specifies the keyboard shortcut for the action. An action can have several keyboard shortcuts. <!-- 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 mandatory "first-keystroke" attribute specifies the first keystroke of the action. The key strokes are specified according to the regular Swing rules.
@ -80,12 +80,12 @@
<!-- All off the following menu groups add the action SimplePopDialogAction to menus in different ways. <!-- All off the following menu groups add the action SimplePopDialogAction to menus in different ways.
Note the action ids are unique. --> Note the action ids are unique. -->
<!-- GroupedActions demonstrates declaring an action group using the default ActionGroup implementation provided by the <!-- GroupedActions demonstrates declaring an action group using the default ActionGroup implementation provided by the
IntelliJ Platform framework. (Note the lack of a "class" attribute.) GroupedActions gets inserted after PopDialogAction IntelliJ Platform framework. (Note the lack of a "class" attribute.) GroupedActions gets inserted after PopupDialogAction
in the Tools menu. Because the group's implementation is default, it cannot impose enable/disable conditions. Instead it in the Tools menu. Because the group's implementation is default, it cannot impose enable/disable conditions. Instead it
must rely on the conditions imposed by the parent menu where it is inserted. It declares one action in the group. --> must rely on the conditions imposed by the parent menu where it is inserted. It declares one action in the group. -->
<group id="org.intellij.sdk.action.GroupedActions" text="Static Grouped Actions" popup="true" icon="ActionBasicsIcons.Sdk_default_icon"> <group id="org.intellij.sdk.action.GroupedActions" text="Static Grouped Actions" popup="true" icon="ActionBasicsIcons.Sdk_default_icon">
<add-to-group group-id="ToolsMenu" anchor="after" relative-to-action="org.intellij.sdk.action.PopDialogAction"/> <add-to-group group-id="ToolsMenu" anchor="after" relative-to-action="org.intellij.sdk.action.PopupDialogAction"/>
<action class="org.intellij.sdk.action.PopDialogAction" id="org.intellij.sdk.action.GroupPopDialogAction" <action class="org.intellij.sdk.action.PopupDialogAction" id="org.intellij.sdk.action.GroupPopDialogAction"
text="A Group Action" description="SDK Static Grouped Action Example" icon="ActionBasicsIcons.Sdk_default_icon"> text="A Group Action" description="SDK Static Grouped Action Example" icon="ActionBasicsIcons.Sdk_default_icon">
</action> </action>
</group> </group>
@ -94,7 +94,7 @@
<group id="org.intellij.sdk.action.CustomDefaultActionGroup" class="org.intellij.sdk.action.CustomDefaultActionGroup" popup="true" <group id="org.intellij.sdk.action.CustomDefaultActionGroup" class="org.intellij.sdk.action.CustomDefaultActionGroup" popup="true"
text="Popup Grouped Actions" description="Custom DefaultActionGroup Demo" icon="ActionBasicsIcons.Sdk_default_icon"> text="Popup Grouped Actions" description="Custom DefaultActionGroup Demo" icon="ActionBasicsIcons.Sdk_default_icon">
<add-to-group group-id="EditorPopupMenu" anchor="first"/> <add-to-group group-id="EditorPopupMenu" anchor="first"/>
<action class="org.intellij.sdk.action.PopDialogAction" id="org.intellij.sdk.action.CustomGroupedAction" <action class="org.intellij.sdk.action.PopupDialogAction" id="org.intellij.sdk.action.CustomGroupedAction"
text="A Popup Action" description="SDK Popup Grouped Action Example" icon="ActionBasicsIcons.Sdk_default_icon"/> text="A Popup Action" description="SDK Popup Grouped Action Example" icon="ActionBasicsIcons.Sdk_default_icon"/>
</group> </group>
<!-- DynamicActionGroup demonstrates declaring an action group without a static action declaration. <!-- DynamicActionGroup demonstrates declaring an action group without a static action declaration.