org.gjt.sp.jedit

See EditPlugin for information on how jEdit obtains and constructs option pane instances.

Most option panes extend this implementation of OptionPane , instead of implementing OptionPane directly.

In a BeanShell script, you can obtain the current buffer instance from the buffer variable.

This class does not have a public constructor. Buffers can be opened and closed using methods in the jEdit class.

This class is partially thread-safe, however you must pay attention to two very important guidelines:

• Changes to a buffer can only be made from the AWT thread.
• When accessing the buffer from another thread, you must grab a read lock if you plan on performing more than one call, to ensure that the buffer contents are not changed by the AWT thread for the duration of the lock.

Message classes extending this class typically add other data members and methods to provide subscribers with whatever is needed to handle the message appropriately.

Message types sent by jEdit can be found in the org.gjt.sp.jedit.msg package.

Plugins register with the EditBus to receive messages reflecting changes in the application's state, including changes in buffers, views and edit panes, changes in the set of properties maintained by the application, and the closing of the application.

The EditBus maintains a list of objects that have requested to receive messages.

In a BeanShell script, you can obtain the current edit pane from the editPane variable.

Each View can have multiple editPanes, one is active at a time. Each EditPane has a single JEditTextArea, and is operating on single buffer. The EditPane also can switch buffers.

Basic plugin information properties

The following properties are required for jEdit to load the plugin:

• plugin.className.activate - set this to defer if your plugin only needs to be loaded when it is first invoked; set it to startup if your plugin must be loaded at startup regardless; set it to a whitespace-separated list of property names if your plugin should be loaded if at least one of these properties is set. Note that if this property is not set, the plugin will not work with jEdit 4.3final.
• plugin.className.name
• plugin.className.version
• plugin.className.jars - only needed if your plugin bundles external JAR files.

The edit server protocol is very simple.

It also contains a few methods useful for displaying output messages or obtaining input from a macro:

• Macros.confirm(Component,String,int)
• Macros.confirm(Component,String,int,int)
• Macros.error(Component,String)
• Macros.input(Component,String)
• Macros.input(Component,String,String)
• Macros.message(Component,String)

A Marker has three key attributes: the Buffer to which it relates, the line number to which the marker refers, and an optional shortcut character.

Plugins should not create instances of this class directly.

See EditPlugin for information on how jEdit obtains and constructs option pane instances.

Note that in most cases it is much easier to extend AbstractOptionPane instead.

JAR file contents

• A file named actions.xml defining plugin actions. Only one such file per plugin is allowed.

A Registers.Register is string of text indexed by a single character.

Services are loaded from files named services.xml inside the plugin JAR.

In a BeanShell script, you can obtain the current view instance from the view variable.

The largest component it contains is an EditPane that in turn contains a org.gjt.sp.jedit.textarea.JEditTextArea that displays a Buffer . A view can have more than one edit pane in a split window configuration. A view also contains a menu bar, an optional toolbar and other window decorations, as well as docked windows.

The View class performs two important operations dealing with plugins: creating plugin menu items, and managing dockable windows.

• When a view is being created, its initialization routine iterates through the collection of loaded plugins and constructs the Plugins menu using the properties as specified in the EditPlugin class.
• The view also creates and initializes a org.gjt.sp.jedit.gui.DockableWindowManager object.