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