PageRenderTime 34ms CodeModel.GetById 21ms app.highlight 9ms RepoModel.GetById 1ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/EBMessage.html

#
HTML | 327 lines | 274 code | 41 blank | 12 comment | 0 complexity | 6796b8aa4a5ff1cab7d181d89afd59a0 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<!--NewPage-->
  3<HTML>
  4<HEAD>
  5<!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:13:44 GMT-08:00 2008 -->
  6<TITLE>
  7EBMessage (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.EBMessage class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EBMessage.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBComponent.html" title="interface in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBPlugin.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
 52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 53  <A HREF="../../../../index.html?org/gjt/sp/jedit/EBMessage.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="EBMessage.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit</FONT>
 78<BR>
 79Class EBMessage</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.EBMessage</B>
 83</PRE>
 84<DL>
 85<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/gjt/sp/jedit/msg/BufferUpdate.html" title="class in org.gjt.sp.jedit.msg">BufferUpdate</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/DockableWindowUpdate.html" title="class in org.gjt.sp.jedit.msg">DockableWindowUpdate</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/DynamicMenuChanged.html" title="class in org.gjt.sp.jedit.msg">DynamicMenuChanged</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/EditorExiting.html" title="class in org.gjt.sp.jedit.msg">EditorExiting</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/EditorExitRequested.html" title="class in org.gjt.sp.jedit.msg">EditorExitRequested</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/EditorStarted.html" title="class in org.gjt.sp.jedit.msg">EditorStarted</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/EditPaneUpdate.html" title="class in org.gjt.sp.jedit.msg">EditPaneUpdate</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/PluginUpdate.html" title="class in org.gjt.sp.jedit.msg">PluginUpdate</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/PropertiesChanged.html" title="class in org.gjt.sp.jedit.msg">PropertiesChanged</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/PropertiesChanging.html" title="class in org.gjt.sp.jedit.msg">PropertiesChanging</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/RegisterChanged.html" title="class in org.gjt.sp.jedit.msg">RegisterChanged</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/SearchSettingsChanged.html" title="class in org.gjt.sp.jedit.msg">SearchSettingsChanged</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/TextAreaUpdate.html" title="class in org.gjt.sp.jedit.msg">TextAreaUpdate</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/VFSPathSelected.html" title="class in org.gjt.sp.jedit.msg">VFSPathSelected</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/VFSUpdate.html" title="class in org.gjt.sp.jedit.msg">VFSUpdate</A>, <A HREF="../../../../org/gjt/sp/jedit/msg/ViewUpdate.html" title="class in org.gjt.sp.jedit.msg">ViewUpdate</A></DD>
 86</DL>
 87<HR>
 88<DL>
 89<DT><PRE>public abstract class <B>EBMessage</B><DT>extends java.lang.Object</DL>
 90</PRE>
 91
 92<P>
 93The base class of all EditBus messages.<p>
 94
 95 Message classes extending this class typically add
 96 other data members and methods to provide subscribers with whatever is
 97 needed to handle the message appropriately.<p>
 98
 99 Message types sent by jEdit can be found in the
100 <A HREF="../../../../org/gjt/sp/jedit/msg/package-summary.html"><CODE>org.gjt.sp.jedit.msg</CODE></A> package.
101<P>
102
103<P>
104<DL>
105<DT><B>Since:</B></DT>
106  <DD>jEdit 2.2pre6</DD>
107</DL>
108<HR>
109
110<P>
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122<CODE>protected </CODE></FONT></TD>
123<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EBMessage.html#EBMessage(org.gjt.sp.jedit.EBComponent)">EBMessage</A></B>(<A HREF="../../../../org/gjt/sp/jedit/EBComponent.html" title="interface in org.gjt.sp.jedit">EBComponent</A>&nbsp;source)</CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new message.</TD>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130<CODE>protected </CODE></FONT></TD>
131<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EBMessage.html#EBMessage(java.lang.Object)">EBMessage</A></B>(java.lang.Object&nbsp;source)</CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new message.</TD>
135</TR>
136</TABLE>
137&nbsp;
138<!-- ========== METHOD SUMMARY =========== -->
139
140<A NAME="method_summary"><!-- --></A>
141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
144<B>Method Summary</B></FONT></TH>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EBMessage.html#getSource()">getSource</A></B>()</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sender of this message.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EBMessage.html#paramString()">paramString</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this message's parameters.</TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EBMessage.html#toString()">toString</A></B>()</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string representation of this message.</TD>
169</TR>
170</TABLE>
171&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
174<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
178</TR>
179</TABLE>
180&nbsp;
181<P>
182
183<!-- ========= CONSTRUCTOR DETAIL ======== -->
184
185<A NAME="constructor_detail"><!-- --></A>
186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
188<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
189<B>Constructor Detail</B></FONT></TH>
190</TR>
191</TABLE>
192
193<A NAME="EBMessage(java.lang.Object)"><!-- --></A><H3>
194EBMessage</H3>
195<PRE>
196protected <B>EBMessage</B>(java.lang.Object&nbsp;source)</PRE>
197<DL>
198<DD>Creates a new message.
199<P>
200<DL>
201<DT><B>Parameters:</B><DD><CODE>source</CODE> - The message source<DT><B>Since:</B></DT>
202  <DD>jEdit 4.2pre1</DD>
203</DL>
204</DL>
205<HR>
206
207<A NAME="EBMessage(org.gjt.sp.jedit.EBComponent)"><!-- --></A><H3>
208EBMessage</H3>
209<PRE>
210protected <B>EBMessage</B>(<A HREF="../../../../org/gjt/sp/jedit/EBComponent.html" title="interface in org.gjt.sp.jedit">EBComponent</A>&nbsp;source)</PRE>
211<DL>
212<DD>Creates a new message.
213<P>
214<DL>
215<DT><B>Parameters:</B><DD><CODE>source</CODE> - The message source</DL>
216</DL>
217
218<!-- ============ METHOD DETAIL ========== -->
219
220<A NAME="method_detail"><!-- --></A>
221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
223<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
224<B>Method Detail</B></FONT></TH>
225</TR>
226</TABLE>
227
228<A NAME="getSource()"><!-- --></A><H3>
229getSource</H3>
230<PRE>
231public java.lang.Object <B>getSource</B>()</PRE>
232<DL>
233<DD>Returns the sender of this message.
234<P>
235<DD><DL>
236<DT><B>Since:</B></DT>
237  <DD>jEdit 4.2pre1</DD>
238</DL>
239</DD>
240</DL>
241<HR>
242
243<A NAME="toString()"><!-- --></A><H3>
244toString</H3>
245<PRE>
246public java.lang.String <B>toString</B>()</PRE>
247<DL>
248<DD>Returns a string representation of this message.
249<P>
250<DD><DL>
251<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
252</DD>
253<DD><DL>
254</DL>
255</DD>
256</DL>
257<HR>
258
259<A NAME="paramString()"><!-- --></A><H3>
260paramString</H3>
261<PRE>
262public java.lang.String <B>paramString</B>()</PRE>
263<DL>
264<DD>Returns a string representation of this message's parameters.
265<P>
266<DD><DL>
267</DL>
268</DD>
269</DL>
270<!-- ========= END OF CLASS DATA ========= -->
271<HR>
272
273
274<!-- ======= START OF BOTTOM NAVBAR ====== -->
275<A NAME="navbar_bottom"><!-- --></A>
276<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
277<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
278<TR>
279<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
280<A NAME="navbar_bottom_firstrow"><!-- --></A>
281<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
282  <TR ALIGN="center" VALIGN="top">
283  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
284  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
285  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
286  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EBMessage.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
287  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
288  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
289  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
290  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
291  </TR>
292</TABLE>
293</TD>
294<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
295</EM>
296</TD>
297</TR>
298
299<TR>
300<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
301&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBComponent.html" title="interface in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
302&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBPlugin.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
303<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
304  <A HREF="../../../../index.html?org/gjt/sp/jedit/EBMessage.html" target="_top"><B>FRAMES</B></A>  &nbsp;
305&nbsp;<A HREF="EBMessage.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
306&nbsp;
307<NOSCRIPT>
308  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
309</NOSCRIPT>
310
311
312</FONT></TD>
313</TR>
314<TR>
315<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
316  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
317<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
318DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
319</TR>
320</TABLE>
321<A NAME="skip-navbar_bottom"></A>
322<!-- ======== END OF BOTTOM NAVBAR ======= -->
323
324<HR>
325
326</BODY>
327</HTML>