|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Class Summary | |
Action | An action defines an action to be taken when the user presses some menu item in the tree's context menu or a button on the toolbar. |
ActionSeparator | Small hack to enable a separator to be shown when some other action is also shown. |
ArchiveAction | Opens the search dialog for the selected directory/project. |
CollapseAllAction | Expands all nodes of the current tree. |
EditGroupAction | Action that when executed creates a new group or edits an existing one. |
EditProjectAction | Action that when executed creates a new project or edits an existing one. |
ExpandAllAction | Expands all nodes of the current tree. |
FileImportAction | Action that when executed imports files into a node. |
LaunchBrowserAction | Opens the selected file in the configured web-browser. |
LaunchBrowserAction.Helper | Class to hold references to classes that may not be available, so this class can behave well when called from a BeanShell script. |
MoveNodeAction | Action to move a project or group into another group. |
NodeRemoverAction | Action that when executed removes nodes from the trees. |
NodeRenamerAction | Action for renaming files, directories and projects. |
OldStyleAddFileAction | Imports files in the style of the old version of the plugin. |
OpenWithAppAction | Opens a file with a registered app, or ask for an application in case none is configured for the file type. |
OpenWithEncodingAction | Opens a node in jEdit using a specific character encoding. |
ReimportAction | Removes all the files below the root from a project, and then calls the initial project importer. |
SearchAction | Opens the search dialog for the selected directory/project. |
SearchAction.NodeFileSet | Implements a SearchFileSet representing files that are children of a given node and its children. |
UpAction | |
VFSFileImportAction | Action that when executed imports files from jEdit's VFS into a node. |
ProjectViewer allows other plugin developers too interact with the file trees by creating custom actions to be executed on the nodes. Actions can be added to the tree's context menu or to the viewer's toolbar. It's recommended to extend the context menu, since there's only so much useful space in the toolbar for new actions.
Creating a new action is very simple:
Action
.actionPerformed()
method to execute the desired operations.registerAction()
)
or in the toolbar
(registerAction()
)
by calling the appropriate method.It's recommended to use the new API to register actions. Create the following properties to automatically register actions with ProjectViewer:
Action
s that
will be added to the toolbar of the ProjectViewer dockable. One instance is
created for each class, and for each jEdit view the instance is cloned,
and then the "projectViewer" instance is set for the cloned object.Action
s that
will be added to the tree's context menu. One instance is created for each
class, and for each jEdit view the instance is cloned, and then the
"projectViewer" instance is set for the cloned object.The menu item show in the context menu is provided by the
getMenuItem()
of the Action
class. Subclasses are welcome to override this method to provide other kinds
of menu items (a sub-menu, for example). For the toolbar button, the
getButton()
method is used.
Before showing the menu item in the context menu, ProjectViewer will call
the prepareForNode()
method in all actions registered in the context menu. This allows each action to
decide if it should be shown for the given node and what message to show, for
example. For the toolbar buttons, this method is never called, so the
toolbar buttons should be able to be executed regardless of the current tree
selection. If your action depends on a certain kind of node, add it to the
context menu, and not to the toolbar. If you want to add it to the toolbar,
check for the node type in your actionPerformed()
implementation.
Another important thing to notice in the prepareForNode() method is that the actions should check is the node is of a certain type, and not if the node is not of a certain type. For example, use "node.isFile()" and not "!node.isDirectory()". This ensures that the action will not do anything wrong if a different node type is added in the future to PV, or if another plugin adds a custom node type to PV.
It's important to notice that the instance given to the registerAction
methods is not the instance used by the viewer instances. Those instances are
used as prototypes, and the viewers use clone()
to get instances for the specific viewer. After the cloning, the
setViewer()
method
is called, so the actions have a reference to the viewers where they are being
used. This also means that you should not use the constructor of your Action
implementation to instantiate GUI components. Instantiations of GUI components
should be done lazily in the getMenuItem()
or getButton()
methods. The default implementation already does this, so you should only worry
about this if you are overriding one of these methods.
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |