PageRenderTime 49ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

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

#
HTML | 214 lines | 174 code | 30 blank | 10 comment | 0 complexity | de7843e977a86d654664653bfc79e84c 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. EBComponent (jEdit API)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="org.gjt.sp.jedit.EBComponent interface">
  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/EBComponent.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/Debug.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
  42. &nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBMessage.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/EBComponent.html" target="_top"><B>FRAMES</B></A> &nbsp;
  45. &nbsp;<A HREF="EBComponent.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;CONSTR&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;CONSTR&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. Interface EBComponent</H2>
  68. <DL>
  69. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/gjt/sp/jedit/bufferset/BufferSetManager.html" title="class in org.gjt.sp.jedit.bufferset">BufferSetManager</A>, <A HREF="../../../../org/gjt/sp/jedit/gui/DockableWindowManager.html" title="class in org.gjt.sp.jedit.gui">DockableWindowManager</A>, <A HREF="../../../../org/gjt/sp/jedit/EBPlugin.html" title="class in org.gjt.sp.jedit">EBPlugin</A>, <A HREF="../../../../org/gjt/sp/jedit/EditPane.html" title="class in org.gjt.sp.jedit">EditPane</A>, <A HREF="../../../../org/gjt/sp/jedit/help/HelpViewer.html" title="class in org.gjt.sp.jedit.help">HelpViewer</A>, <A HREF="../../../../org/gjt/sp/jedit/search/HyperSearchResults.html" title="class in org.gjt.sp.jedit.search">HyperSearchResults</A>, <A HREF="../../../../org/gjt/sp/jedit/gui/LogViewer.html" title="class in org.gjt.sp.jedit.gui">LogViewer</A>, <A HREF="../../../../org/gjt/sp/jedit/Macros.Recorder.html" title="class in org.gjt.sp.jedit">Macros.Recorder</A>, <A HREF="../../../../org/gjt/sp/jedit/gui/MarkerViewer.html" title="class in org.gjt.sp.jedit.gui">MarkerViewer</A>, <A HREF="../../../../org/gjt/sp/jedit/pluginmgr/PluginManager.html" title="class in org.gjt.sp.jedit.pluginmgr">PluginManager</A>, <A HREF="../../../../org/gjt/sp/jedit/gui/RegisterViewer.html" title="class in org.gjt.sp.jedit.gui">RegisterViewer</A>, <A HREF="../../../../org/gjt/sp/jedit/search/SearchDialog.html" title="class in org.gjt.sp.jedit.search">SearchDialog</A>, <A HREF="../../../../org/gjt/sp/jedit/browser/VFSBrowser.html" title="class in org.gjt.sp.jedit.browser">VFSBrowser</A>, <A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A></DD>
  70. </DL>
  71. <HR>
  72. <DL>
  73. <DT><PRE>public interface <B>EBComponent</B></DL>
  74. </PRE>
  75. <P>
  76. A component on the EditBus. Every plugin class that uses the EditBus for
  77. receiving messages must implement this interface.
  78. <P>
  79. <P>
  80. <DL>
  81. <DT><B>Since:</B></DT>
  82. <DD>jEdit 2.2pre6</DD>
  83. <DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit"><CODE>EBMessage</CODE></A></DL>
  84. <HR>
  85. <P>
  86. <!-- ========== METHOD SUMMARY =========== -->
  87. <A NAME="method_summary"><!-- --></A>
  88. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  89. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  90. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  91. <B>Method Summary</B></FONT></TH>
  92. </TR>
  93. <TR BGCOLOR="white" CLASS="TableRowColor">
  94. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  95. <CODE>&nbsp;void</CODE></FONT></TD>
  96. <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/EBComponent.html#handleMessage(org.gjt.sp.jedit.EBMessage)">handleMessage</A></B>(<A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">EBMessage</A>&nbsp;message)</CODE>
  97. <BR>
  98. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a message sent on the EditBus.</TD>
  99. </TR>
  100. </TABLE>
  101. &nbsp;
  102. <P>
  103. <!-- ============ METHOD DETAIL ========== -->
  104. <A NAME="method_detail"><!-- --></A>
  105. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  106. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  107. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  108. <B>Method Detail</B></FONT></TH>
  109. </TR>
  110. </TABLE>
  111. <A NAME="handleMessage(org.gjt.sp.jedit.EBMessage)"><!-- --></A><H3>
  112. handleMessage</H3>
  113. <PRE>
  114. void <B>handleMessage</B>(<A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">EBMessage</A>&nbsp;message)</PRE>
  115. <DL>
  116. <DD>Handles a message sent on the EditBus.
  117. This method must specify the type of responses the plugin will have
  118. for various subclasses of the <A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit"><CODE>EBMessage</CODE></A> class. Typically
  119. this is done with one or more <code>if</code> blocks that test
  120. whether the message is an instance of a derived message class in
  121. which the component has an interest. For example:
  122. <pre> if(msg instanceof BufferUpdate) {
  123. // a buffer's state has changed!
  124. }
  125. else if(msg instanceof ViewUpdate) {
  126. // a view's state has changed!
  127. }
  128. // ... and so on</pre>
  129. <P>
  130. <DD><DL>
  131. <DT><B>Parameters:</B><DD><CODE>message</CODE> - The message</DL>
  132. </DD>
  133. </DL>
  134. <!-- ========= END OF CLASS DATA ========= -->
  135. <HR>
  136. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  137. <A NAME="navbar_bottom"><!-- --></A>
  138. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  139. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  140. <TR>
  141. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  142. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  143. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  144. <TR ALIGN="center" VALIGN="top">
  145. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  146. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  147. <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  148. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EBComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  149. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  150. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  151. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  152. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  153. </TR>
  154. </TABLE>
  155. </TD>
  156. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  157. </EM>
  158. </TD>
  159. </TR>
  160. <TR>
  161. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  162. &nbsp;<A HREF="../../../../org/gjt/sp/jedit/Debug.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
  163. &nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
  164. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  165. <A HREF="../../../../index.html?org/gjt/sp/jedit/EBComponent.html" target="_top"><B>FRAMES</B></A> &nbsp;
  166. &nbsp;<A HREF="EBComponent.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  167. &nbsp;
  168. <NOSCRIPT>
  169. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  170. </NOSCRIPT>
  171. </FONT></TD>
  172. </TR>
  173. <TR>
  174. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  175. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  176. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  177. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  178. </TR>
  179. </TABLE>
  180. <A NAME="skip-navbar_bottom"></A>
  181. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  182. <HR>
  183. </BODY>
  184. </HTML>