org.gjt.sp.jedit (jEdit API Documentation)
Date: 2015-02-03

# Package org.gjt.sp.jedit

This package contains jEdit's core classes.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  EBComponent | A component on the EditBus.
  IPropertyManager | Interface for class that returns properties.
  OptionPane | The interface all option panes must implement.
  Registers.Register | A register.
  RegisterSaver | An interface to delegate save/load operations of registers.
  RegistersListener | An interface to listen some events about registers.

- Class Summary
  Class | Description
  --- | ---
  Abbrevs | Abbreviation manager.
  AbstractOptionPane | The default implementation of the option pane interface.
  ActionContext | Manages a collection of action sets.
  ActionSet | A set of actions, either loaded from an XML file, or constructed at runtime by a plugin.
  BeanShell | BeanShell is jEdit's extension language.
  BeanShellAction | An action that evaluates BeanShell code when invoked.
  BeanShellFacade<T> | This class will be the interface for beanshell interaction.
  Buffer | A `Buffer` represents the contents of an open text file as it is maintained in the computer's memory (as opposed to how it may be stored on a disk).
  BufferHistory | Recent file list.
  BufferHistory.Entry | Recent file list entry.
  Debug | This class contains various debugging flags (mainly useful for core development) and debugging routines.
  EBMessage | The base class of all EditBus messages.
  EBPlugin | Plugins extending this class are automatically added to the EditBus.
  EditAction | An action that can be bound to a menu item, tool bar button or keystroke.
  EditAction.Wrapper | 'Wrap' EditActions in this class to turn them into AWT ActionListeners, that can be attached to buttons, menu items, etc.
  EditBus | jEdit's global event notification mechanism.
  EditPane | A panel containing a text area.
  EditPlugin | The abstract base class that every plugin must implement.
  EditPlugin.Broken | A placeholder for a plugin that didn't load.
  EditPlugin.Deferred | A placeholder for a plugin that hasn't been loaded yet.
  EditServer | Inter-process communication.
  GUIUtilities | Various GUI utility functions related to icons, menus, toolbars, keyboard shortcuts, etc.
  GUIUtilities.UnixWorkaround |
  JARClassLoader | A class loader implementation that loads classes from JAR files.
  jEdit | The main class of the jEdit text editor.
  jEdit.JEditPropertyManager |
  JEditAbstractEditAction<E> | An action that can be bound to a menu item, tool bar button or keystroke.
  JEditActionContext<F extends JEditAbstractEditAction,E extends JEditActionSet<F>> | Manages a collection of action sets.
  JEditActionSet<E extends JEditAbstractEditAction> | A set of actions, either loaded from an XML file, or constructed at runtime by a plugin.
  JEditBeanShellAction | An action that evaluates BeanShell code when invoked.
  Macros | This class records and runs macros.
  Macros.Handler | Encapsulates creating and invoking macros in arbitrary scripting languages
  Macros.Macro | Encapsulates the macro's label, name and path.
  Macros.Recorder | Handles macro recording.
  Marker | Buffers may contain one or more markers which serve as textual bookmarks.
  MiscUtilities | Path, URL name manipulation, string manipulation, and more.
  Mode | An edit mode defines specific settings for editing some type of file.
  OperatingSystem | Operating system detection routines.
  OptionGroup | A set of option panes shown in one branch in the options dialog.
  PerspectiveManager | Manages persistence of open buffers and views across jEdit sessions.
  PluginJAR | Loads and unloads plugins.
  PluginJAR.PluginCacheEntry | Used by the `DockableWindowManager` and `ServiceManager` to handle caching.
  Registers | jEdit's registers are an extension of the clipboard metaphor.
  Registers.ClipboardRegister | A clipboard register.
  ServiceManager | A generic way for plugins (and core) to provide various API extensions.
  ServiceManager.ServiceFoldHandlerProvider | A FoldHandler based on the ServiceManager
  SettingsXML | A XML file in the settings directory.
  SplitConfigParser | Class used by PerspectiveManager to parse SplitConfig strings.
  TextUtilities | Contains several text manipulation methods.
  View | A `View` is jEdit's top-level frame window.
  View.ViewConfig |

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  EditBus.EBHandler | This annotation should be used in methods that are to be considered "edit bus message handlers".

## Package org.gjt.sp.jedit Description

This package contains jEdit's core classes.

For plugin development, start by looking at PluginJAR and EditPlugin, which describe the basics of jEdit's plugin API. Then, browse the following classes:

- jEdit
- Buffer
- EditPane
- GUIUtilities
- JEditTextArea
- MiscUtilities
- VFSManager
- View

The EditBus framework is used to receive notification of various editor state changes:

- EditBus
- EBComponent
- EBMessage
- EBPlugin
- org.gjt.sp.jedit.msg package