Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.gjt.mm.* (1)org.gjt.sp.* (292)

Package Samples:

org.gjt.sp.jedit.browser: This package contains jEdit's core classes.  
org.gjt.sp.jedit.help: This package contains jEdit's core classes.  
org.gjt.sp.jedit.menu: This package contains jEdit's core classes.  
org.gjt.sp.jedit.gui
org.gjt.sp.util
org.gjt.sp.jedit
org.gjt.sp.jedit.buffer
org.gjt.sp.jedit.io
org.gjt.sp.jedit.msg
org.gjt.sp.jedit.options
org.gjt.sp.jedit.pluginmgr
org.gjt.sp.jedit.print
org.gjt.sp.jedit.proto.jeditresource
org.gjt.sp.jedit.search
org.gjt.sp.jedit.syntax
org.gjt.sp.jedit.textarea
org.gjt.mm.mysql

Classes:

EditPlugin: The abstract base class that every plugin must implement. Alternatively, instead of extending this class, a plugin core class can extend EBPlugin to automatically receive EditBus messages. Basic plugin information properties Note that in all cases above where a class name is needed, the fully qualified class name, including the package name, if any, must be used. The following properties are required for jEdit to load the plugin: plugin. class name .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 ...
ActionSet: A set of actions, either loaded from an XML file, or constructed at runtime by a plugin. Action sets loaded from XML files Action sets are read from these files inside the plugin JAR: actions.xml - actions made available for use in jEdit views, including the view's Plugins menu, the tool bar, etc. browser.actions.xml - actions for the file system browser's Plugins menu. An action definition file has the following form: <?xml version="1.0"?> <!DOCTYPE ACTIONS SYSTEM "actions.dtd"> <ACTIONS> <ACTION NAME="some-action"> <CODE> // BeanShell code evaluated when the action ...
DockableWindowManager: The DockableWindowManager keeps track of dockable windows. Each org.gjt.sp.jedit.View has an instance of this class. dockables.xml: Dockable window definitions are read from dockables.xml files contained inside plugin JARs. A dockable definition file has the following form: <?xml version="1.0"?> <!DOCTYPE DOCKABLES SYSTEM "dockables.dtd"> <DOCKABLES> <DOCKABLE NAME="name"> // Code to create the dockable </DOCKABLE> </DOCKABLES> More than one <DOCKABLE> tag may be present. The code that creates the dockable can reference any BeanShell built-in variable (see ...
VFS: A virtual filesystem implementation. Plugins can provide virtual file systems by defining entries in their services.xml files like so: <SERVICE CLASS="org.gjt.sp.jedit.io.VFS" NAME=" name "> new MyVFS (); </SERVICE> URLs of the form name : path will then be handled by the VFS named name . See org.gjt.sp.jedit.ServiceManager for details. Session objects: A session is used to persist things like login information, any network sockets, etc. File system implementations that do not need this kind of persistence return a dummy object as a session. Methods whose names are prefixed with "_" ...
PluginJAR: Loads and unloads plugins. JAR file contents When loading a plugin, jEdit looks for the following resources: A file named actions.xml defining plugin actions. Only one such file per plugin is allowed. See ActionSet for syntax. A file named browser.actions.xml defining file system browser actions. Only one such file per plugin is allowed. See ActionSet for syntax. A file named dockables.xml defining dockable windows. Only one such file per plugin is allowed. See org.gjt.sp.jedit.gui.DockableWindowManager for syntax. A file named services.xml defining additional services offered by the plugin, such ...
EditBus: jEdit's global event notification mechanism. 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. When a message is sent using this class, all registered components receive it in turn. Classes for objects that subscribe to the EditBus must implement the EBComponent interface, which defines the single method EBComponent.handleMessage(EBMessage) ...
AbstractOptionPane: The default implementation of the option pane interface. 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. This class provides a convenient default framework for laying out configuration options. It is derived from Java's JPanel class and uses a GridBagLayout object for component management. Since GridBagLayout can be a bit cumbersome to use, this class contains shortcut methods to simplify layout: addComponent(Component) 55 addComponent(String,Component) ...
ServiceManager: A generic way for plugins to provide various API extensions. Services are loaded from files named services.xml inside the plugin JAR. A service definition file has the following form: <?xml version="1.0"?> <!DOCTYPE SERVICES SYSTEM "services.dtd"> <SERVICES> <SERVICE NAME="service name" CLASS="fully qualified class name"> // BeanShell code evaluated when the sevice is first activated </SERVICE> </SERVICES> The following elements are valid: SERVICES is the top-level element and refers to the set of services offered by the plugin. A SERVICE contains the data for ...
Registers: jEdit's registers are an extension of the clipboard metaphor. A Registers.Register is string of text indexed by a single character. Typically the text is taken from selected buffer text and the index character is a keyboard character selected by the user. This class defines a number of static methods that give each register the properties of a virtual clipboard. Two classes implement the Registers.Register interface. A Registers.ClipboardRegister is tied to the contents of the system clipboard. jEdit assigns a Registers.ClipboardRegister to the register indexed under the character $ . A Registers.StringRegister ...
MiscUtilities: Path name manipulation, string manipulation, and more. The most frequently used members of this class are: Some path name methods: getFileName(String) 55 getParentOfPath(String) 55 constructPath(String,String) 55 String comparison: A compareStrings(String,String,boolean) 55 method that unlike String.compareTo() , correctly recognizes and handles embedded numbers. This class also defines several inner classes for use with the sorting features of the Java collections API: MiscUtilities.StringCompare MiscUtilities.StringICaseCompare MiscUtilities.MenuItemCompare For example, you might call: Arrays.sort(myListOfStrings, ...
VariableGridLayout: The VariableGridLayout class is a layout manager that lays out a container's components in a rectangular grid with variable cell sizes. The container is divided into rectangles, and one component is placed in each rectangle. Each row is as large as the largest component in that row, and each column is as wide as the widest component in that column. This behavior is basically the same as in java.awt.GridLayout , but with different row heights and column widths for each row/column. For example, the following is an applet that lays out six buttons into three rows and two columns: import java.awt.*; ...
View: A View is jEdit's top-level frame window. 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 ...
GUIUtilities: Various GUI functions. The most frequently used members of this class are: loadIcon(String) 55 confirm(Component,String,Object[],int,int) 55 error(Component,String,Object[]) 55 message(Component,String,Object[]) 55 showPopupMenu(JPopupMenu,Component,int,int) 55 showVFSFileDialog(View,String,int,boolean) 55 loadGeometry(Window,String) 55 saveGeometry(Window,String) 55
Macros: This class records and runs macros. It also contains a few methods useful for displaying output messages or obtaining input from a macro: confirm(Component,String,int) 55 confirm(Component,String,int,int) 55 error(Component,String) 55 input(Component,String) 55 input(Component,String,String) 55 message(Component,String) 55 Note that plugins should not use the above methods. Call the methods in the GUIUtilities class instead.
EditServer: Inter-process communication. The edit server protocol is very simple. $HOME/.jedit/server is an ASCII file containing two lines, the first being the port number, the second being the authorization key. You connect to that port on the local machine, sending the authorization key as four bytes in network byte order, followed by the length of the BeanShell script as two bytes in network byte order, followed by the script in UTF8 encoding. After the socked is closed, the BeanShell script will be executed by jEdit. The snippet is executed in the AWT thread. None of the usual BeanShell variables (view, ...
SearchAndReplace: Class that implements regular expression and literal search within jEdit buffers. There are two main groups of methods in this class: Property accessors - for changing search and replace settings. Actions - for performing search and replace. The "HyperSearch" and "Keep dialog" features, as reflected in checkbox options in the search dialog, are not handled from within this class. If you wish to have these options set before the search dialog appears, make a prior call to either or both of the following: jEdit.setBooleanProperty("search.hypersearch.toggle",true); jEdit.setBooleanProperty("search.keepDialog.toggle",true); ...
BeanShell: BeanShell is jEdit's extension language. When run from jEdit, BeanShell code has access to the following predefined variables: view - the currently active View . editPane - the currently active EditPane . textArea - the edit pane's org.gjt.sp.jedit.textarea.JEditTextArea . buffer - the edit pane's Buffer . wm - the view's org.gjt.sp.jedit.gui.DockableWindowManager . scriptPath - the path name of the currently executing BeanShell script.
JEditTextArea: jEdit's text area component. It is more suited for editing program source code than JEditorPane, because it drops the unnecessary features (images, variable-width lines, and so on) and adds a whole bunch of useful goodies such as: More flexible key binding scheme Supports macro recorders Rectangular selection Bracket highlighting Syntax highlighting Command repetition Block caret can be enabled It is also faster and doesn't have as many problems. It can be used in other applications; the only other part of jEdit it depends on is the syntax package. To use it in your app, treat it like any other ...
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). 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 ...
FortranTokenMarker: Custom TokenMarker for UNISYS's ASCII FORTRAN 77 . Characteristics of this dialect are: Fixed column format, with comment character ( 'C'|'c'|'*' ) in column 1, labels (numeric) in column 1-5, continuation character ( any nonblank ) in column 6, logical end of line after column 72. Nonstandard block comment character ( '@' ) in any column, Some nonstandard functions: BITS , BOOL , INDEX , TRMLEN It should be easy enough to adapt this class for minor variations in the dialect so long as the format is the classic fixed column format. As this scanner is highly optimized for the fixed column format, ...
FoldVisibilityManager: Manages fold visibility. This class contains methods for translating between physical and virtual line numbers, for determining which lines are visible and which aren't, and for expanding and collapsing folds. When jEdit's folding or narrowing features are used to hide portions of a buffer, the "virtual" line count visible in the text area is generally not equal to the "physical" line count of the buffer represented by the gutter's display. You can use the physicalToVirtual(int) 55 and virtualToPhysical(int) 55 methods to convert one type of line number to another.
StatusBar: The status bar used to display various information to the user. Currently, it is used for the following: Displaying caret position information Displaying InputHandler.readNextChar(String,String) 55 prompts Displaying setMessage(String) 55 messages Displaying I/O progress Displaying various editor settings Displaying memory status
Selection: An abstract class that holds data on a region of selected text. As an abstract class, it cannot be used directly, but instead serves as a parent class for two specific types of selection structures: Selection.Range - represents an ordinary range of selected text. Selection.Rect - represents a rectangular selection.
TokenMarkerContext: This class contains the Context of a Token Marker that can be passed along nested Token Markers through a method like markTokensImpl(MyToken token, TokenMarkerContext ctx) : MyToken where MyToken represents the token state at the end of the marked line. It contains useful infos such as last offset and last keyword and the pos in the marked line It also provides utility functions that are often used in TokenMarkers such as addTokenToPos, addTokenToEnd doKeywordToPos, doKeywordToEnd

Home | Contact Us | Privacy Policy | Terms of Service