[prev in list] [next in list] [prev in thread] [next in thread]
List: jedit-cvs
Subject: [ jEdit-commits ] SF.net SVN: jedit: [9864]
From: ezust () users ! sourceforge ! net
Date: 2007-06-28 4:10:59
Message-ID: E1I3lLP-0003Mk-E5 () sc8-pr-svn4 ! sourceforge ! net
[Download RAW message or body]
Revision: 9864
http://svn.sourceforge.net/jedit/?rev=9864&view=rev
Author: ezust
Date: 2007-06-27 21:10:59 -0700 (Wed, 27 Jun 2007)
Log Message:
-----------
Added some discussion of the EditBus in the plugin development guide.
Modified Paths:
--------------
jEdit/trunk/doc/users-guide/plugin-implement.xml
jEdit/trunk/doc/users-guide/text-edit.xml
Modified: jEdit/trunk/doc/users-guide/plugin-implement.xml
===================================================================
--- jEdit/trunk/doc/users-guide/plugin-implement.xml 2007-06-27 22:51:30 UTC (rev \
9863)
+++ jEdit/trunk/doc/users-guide/plugin-implement.xml 2007-06-28 04:10:59 UTC (rev \
9864) @@ -476,6 +476,20 @@
<sect1 id="plugin-implement-editbus"><title>The EditBus</title>
+<para> jEdit (and some plugins) generate several kinds of messages to alert plugins \
and other components of jedit-specific events. The message classes, all derived from \
<ulink url="../api/org/gjt/sp/jedit/EBMessage.html"> + \
<classname>EBMessage</classname></ulink> cover the opening + and closing of the \
application, changes in the status of buffers and views, + changes in user settings, \
as well as changes in the state of other program features. A full list of messages \
can be found in the + <ulink \
url="../api/org/gjt/sp/jedit/msg/package-summary.html">org.gjt.sp.jedit.msg</ulink> + \
package. +</para>
+
+<para> For example, the ViewUpdate messages are all related to the jEdit View, or \
the top-level window. If the user creates multiple Views, a plugin may need to when \
they are created or destroyed, so it would monitor ViewUpdate messages. +</para>
+
+<para> BufferUpdate messages are all related to jEdit buffers. They let plugins know \
when a buffer has become dirty, when it is about to be closed, after it is closed, \
created, loaded, or saved. Each of these messages are described in further detail in \
the API docs. +</para>
+
<para>
Plugins register <ulink url="../api/org/gjt/sp/jedit/EBComponent.html">
<function>EBComponent</function></ulink> instances with the
@@ -484,15 +498,6 @@
changes in jEdit's state.
</para>
-<para>
- The message
- classes derived from <ulink url="../api/org/gjt/sp/jedit/EBMessage.html">
- <classname>EBMessage</classname></ulink> cover the opening
- and closing of the application, changes in the status of buffers and views,
- changes in user settings, as well as changes in the state of other program \
features. A full list of messages can be found in the
- <ulink url="../api/org/gjt/sp/jedit/msg/package-summary.html">org.gjt.sp.jedit.msg</ulink>
- package.
-</para>
<para>
<ulink url="../api/org/gjt/sp/jedit/EBComponent.html">
@@ -532,6 +537,12 @@
plugin base class. Note that QuickNotepad uses the latter.
</para>
+<para> The Navigator plugin monitors two newly added (to jEdit 4.3) EBMessages of \
the kind <ulink url="../api/org/gjt/sp/jedit/CaretChanging.html">CaretChanging</ulink> \
and <ulink url="../api/org/gjt/sp/jedit/BufferChanging.html">BufferChanging</ulink>. \
The BufferChanging event provides Navigator enough advance notice to save the \
TextArea's caret just before current EditPane changes its active Buffer. The \
<literal>BufferChanged</literal> event, another <literal>EditPaneUpdate</literal> \
message, is thrown shortly afterward. This is not used by Navigator, but it could be \
handy for SideKick to determine when it is time to reparse. +</para>
+
+<para> The <literal>CaretChanging</literal> EBMessage is an odd one though. This was \
invented purely for the benefit of the Navigator plugin, although other plugins may \
choose to listen to these messages too. We don't want a CaretChanging event thrown \
every time the a cursor key was used in a TextArea, so the TextArea does not actually \
emit a <literal>CaretChanging</literal> message, even though this is a \
<literal>TextAreaUpdate</literal>. There are several plugins which all provide some \
kind of navigation ability and should emit this message for the benefit of the \
<literal>Navigator</literal> and other interested plugins. +</para>
+
</sect1>
<sect1 id="plugin-implement-actions"><title>The Actions Catalog</title>
Modified: jEdit/trunk/doc/users-guide/text-edit.xml
===================================================================
--- jEdit/trunk/doc/users-guide/text-edit.xml 2007-06-27 22:51:30 UTC (rev 9863)
+++ jEdit/trunk/doc/users-guide/text-edit.xml 2007-06-28 04:10:59 UTC (rev 9864)
@@ -846,6 +846,12 @@
Regular expression syntax is described in
<xref linkend="regexps" />.
</para>
+
+ <note> <title> On regex search</title>
+ <para> There are some known issues with the <literal>java.util.regex</literal> \
library, as it stands in Sun's Java 1.5 and 1.6. In particular, it is possible to \
create regular expressions that hang the JVM, or cause stack overflow errors, which \
was not as easy to accomplish using the legacy <literal>gnu.regexp</literal> library. \
If you find that <literal>gnu.regexp</literal>, used in jEdit 4.2 and earlier, is \
more suitable for your search/replace needs, you can try the <emphasis \
role="bold">XSearch plugin</emphasis>, which still uses it and can provide a \
replacement to the built-in search dialog. + </para>
+ </note>
+
<para>
The <guibutton>Backward</guibutton> and <guibutton>Forward</guibutton>
buttons specify the search direction.
This was sent by the SourceForge.net collaborative development platform, the world's \
largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
jEdit-CVS mailing list
jEdit-CVS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jedit-cvs
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic