PageRenderTime 65ms CodeModel.GetById 21ms app.highlight 14ms RepoModel.GetById 16ms 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
  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>
  7EBComponent (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.EBComponent interface">
 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/EBComponent.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/Debug.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBMessage.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/EBComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="EBComponent.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>
 79Interface EBComponent</H2>
 80<DL>
 81<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>
 82</DL>
 83<HR>
 84<DL>
 85<DT><PRE>public interface <B>EBComponent</B></DL>
 86</PRE>
 87
 88<P>
 89A component on the EditBus. Every plugin class that uses the EditBus for
 90 receiving messages must implement this interface.
 91<P>
 92
 93<P>
 94<DL>
 95<DT><B>Since:</B></DT>
 96  <DD>jEdit 2.2pre6</DD>
 97<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>
 98<HR>
 99
100<P>
101
102<!-- ========== METHOD SUMMARY =========== -->
103
104<A NAME="method_summary"><!-- --></A>
105<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
106<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
107<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
108<B>Method Summary</B></FONT></TH>
109</TR>
110<TR BGCOLOR="white" CLASS="TableRowColor">
111<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
112<CODE>&nbsp;void</CODE></FONT></TD>
113<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>
114
115<BR>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles a message sent on the EditBus.</TD>
117</TR>
118</TABLE>
119&nbsp;
120<P>
121
122<!-- ============ METHOD DETAIL ========== -->
123
124<A NAME="method_detail"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
128<B>Method Detail</B></FONT></TH>
129</TR>
130</TABLE>
131
132<A NAME="handleMessage(org.gjt.sp.jedit.EBMessage)"><!-- --></A><H3>
133handleMessage</H3>
134<PRE>
135void <B>handleMessage</B>(<A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit">EBMessage</A>&nbsp;message)</PRE>
136<DL>
137<DD>Handles a message sent on the EditBus.
138
139 This method must specify the type of responses the plugin will have
140 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
141 this is done with one or more <code>if</code> blocks that test
142 whether the message is an instance of a derived message class in
143 which the component has an interest. For example:
144
145 <pre> if(msg instanceof BufferUpdate) {
146     // a buffer's state has changed!
147 }
148 else if(msg instanceof ViewUpdate) {
149     // a view's state has changed!
150 }
151 // ... and so on</pre>
152<P>
153<DD><DL>
154<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message</DL>
155</DD>
156</DL>
157<!-- ========= END OF CLASS DATA ========= -->
158<HR>
159
160
161<!-- ======= START OF BOTTOM NAVBAR ====== -->
162<A NAME="navbar_bottom"><!-- --></A>
163<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
164<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
165<TR>
166<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
167<A NAME="navbar_bottom_firstrow"><!-- --></A>
168<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
169  <TR ALIGN="center" VALIGN="top">
170  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
171  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
172  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
173  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EBComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
174  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
175  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
176  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
177  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
178  </TR>
179</TABLE>
180</TD>
181<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
182</EM>
183</TD>
184</TR>
185
186<TR>
187<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
188&nbsp;<A HREF="../../../../org/gjt/sp/jedit/Debug.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
189&nbsp;<A HREF="../../../../org/gjt/sp/jedit/EBMessage.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
190<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
191  <A HREF="../../../../index.html?org/gjt/sp/jedit/EBComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
192&nbsp;<A HREF="EBComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
193&nbsp;
194<NOSCRIPT>
195  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
196</NOSCRIPT>
197
198
199</FONT></TD>
200</TR>
201<TR>
202<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
203  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
204<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
205DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
206</TR>
207</TABLE>
208<A NAME="skip-navbar_bottom"></A>
209<!-- ======== END OF BOTTOM NAVBAR ======= -->
210
211<HR>
212
213</BODY>
214</HTML>