PageRenderTime 36ms CodeModel.GetById 15ms app.highlight 16ms RepoModel.GetById 1ms app.codeStats 0ms

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

#
HTML | 359 lines | 304 code | 43 blank | 12 comment | 0 complexity | 5b18b75c3ca897eead02d44ff6f0a809 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:46 GMT-08:00 2008 -->
  6<TITLE>
  7Macros.Handler (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.Macros.Handler 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/Macros.Handler.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/Macros.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.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/Macros.Handler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="Macros.Handler.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 Macros.Handler</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.Macros.Handler</B>
 83</PRE>
 84<DL>
 85<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/gjt/sp/jedit/Macros.html" title="class in org.gjt.sp.jedit">Macros</A></DD>
 86</DL>
 87<HR>
 88<DL>
 89<DT><PRE>public abstract static class <B>Macros.Handler</B><DT>extends java.lang.Object</DL>
 90</PRE>
 91
 92<P>
 93Encapsulates creating and invoking macros in arbitrary scripting languages
 94<P>
 95
 96<P>
 97<DL>
 98<DT><B>Since:</B></DT>
 99  <DD>jEdit 4.0pre6</DD>
100</DL>
101<HR>
102
103<P>
104
105<!-- ======== CONSTRUCTOR SUMMARY ======== -->
106
107<A NAME="constructor_summary"><!-- --></A>
108<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
109<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
110<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
111<B>Constructor Summary</B></FONT></TH>
112</TR>
113<TR BGCOLOR="white" CLASS="TableRowColor">
114<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115<CODE>protected </CODE></FONT></TD>
116<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#Macros.Handler(java.lang.String)">Macros.Handler</A></B>(java.lang.String&nbsp;name)</CODE>
117
118<BR>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
120</TR>
121</TABLE>
122&nbsp;
123<!-- ========== METHOD SUMMARY =========== -->
124
125<A NAME="method_summary"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
129<B>Method Summary</B></FONT></TH>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;boolean</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#accept(java.lang.String)">accept</A></B>(java.lang.String&nbsp;path)</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>abstract &nbsp;<A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#createMacro(java.lang.String, java.lang.String)">createMacro</A></B>(java.lang.String&nbsp;macroName,
143            java.lang.String&nbsp;path)</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#getLabel()">getLabel</A></B>()</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#getName()">getName</A></B>()</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>abstract &nbsp;void</CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#runMacro(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Macros.Macro)">runMacro</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A>&nbsp;view,
168         <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A>&nbsp;macro)</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Runs the specified macro.</TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;void</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#runMacro(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Macros.Macro, boolean)">runMacro</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A>&nbsp;view,
177         <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A>&nbsp;macro,
178         boolean&nbsp;ownNamespace)</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Runs the specified macro.</TD>
182</TR>
183</TABLE>
184&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
187<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
191</TR>
192</TABLE>
193&nbsp;
194<P>
195
196<!-- ========= CONSTRUCTOR DETAIL ======== -->
197
198<A NAME="constructor_detail"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
202<B>Constructor Detail</B></FONT></TH>
203</TR>
204</TABLE>
205
206<A NAME="Macros.Handler(java.lang.String)"><!-- --></A><H3>
207Macros.Handler</H3>
208<PRE>
209protected <B>Macros.Handler</B>(java.lang.String&nbsp;name)</PRE>
210<DL>
211</DL>
212
213<!-- ============ METHOD DETAIL ========== -->
214
215<A NAME="method_detail"><!-- --></A>
216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
218<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
219<B>Method Detail</B></FONT></TH>
220</TR>
221</TABLE>
222
223<A NAME="getName()"><!-- --></A><H3>
224getName</H3>
225<PRE>
226public java.lang.String <B>getName</B>()</PRE>
227<DL>
228<DD><DL>
229</DL>
230</DD>
231</DL>
232<HR>
233
234<A NAME="getLabel()"><!-- --></A><H3>
235getLabel</H3>
236<PRE>
237public java.lang.String <B>getLabel</B>()</PRE>
238<DL>
239<DD><DL>
240</DL>
241</DD>
242</DL>
243<HR>
244
245<A NAME="accept(java.lang.String)"><!-- --></A><H3>
246accept</H3>
247<PRE>
248public boolean <B>accept</B>(java.lang.String&nbsp;path)</PRE>
249<DL>
250<DD><DL>
251</DL>
252</DD>
253</DL>
254<HR>
255
256<A NAME="createMacro(java.lang.String, java.lang.String)"><!-- --></A><H3>
257createMacro</H3>
258<PRE>
259public abstract <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A> <B>createMacro</B>(java.lang.String&nbsp;macroName,
260                                         java.lang.String&nbsp;path)</PRE>
261<DL>
262<DD><DL>
263</DL>
264</DD>
265</DL>
266<HR>
267
268<A NAME="runMacro(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Macros.Macro)"><!-- --></A><H3>
269runMacro</H3>
270<PRE>
271public abstract void <B>runMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A>&nbsp;view,
272                              <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A>&nbsp;macro)</PRE>
273<DL>
274<DD>Runs the specified macro.
275<P>
276<DD><DL>
277<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view - may be null.<DD><CODE>macro</CODE> - The macro.</DL>
278</DD>
279</DL>
280<HR>
281
282<A NAME="runMacro(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Macros.Macro, boolean)"><!-- --></A><H3>
283runMacro</H3>
284<PRE>
285public void <B>runMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A>&nbsp;view,
286                     <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A>&nbsp;macro,
287                     boolean&nbsp;ownNamespace)</PRE>
288<DL>
289<DD>Runs the specified macro. This method is optional; it is
290 called if the specified macro is a startup script. The
291 default behavior is to simply call <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html#runMacro(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Macros.Macro)"><CODE>runMacro(View,Macros.Macro)</CODE></A>.
292<P>
293<DD><DL>
294<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view - may be null.<DD><CODE>macro</CODE> - The macro.<DD><CODE>ownNamespace</CODE> - A hint indicating whenever functions and
295 variables defined in the script are to be self-contained, or
296 made available to other scripts. The macro handler may ignore
297 this parameter.<DT><B>Since:</B></DT>
298  <DD>jEdit 4.1pre3</DD>
299</DL>
300</DD>
301</DL>
302<!-- ========= END OF CLASS DATA ========= -->
303<HR>
304
305
306<!-- ======= START OF BOTTOM NAVBAR ====== -->
307<A NAME="navbar_bottom"><!-- --></A>
308<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
309<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
310<TR>
311<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
312<A NAME="navbar_bottom_firstrow"><!-- --></A>
313<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
314  <TR ALIGN="center" VALIGN="top">
315  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
316  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
317  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
318  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Macros.Handler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
319  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
320  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
321  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
322  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
323  </TR>
324</TABLE>
325</TD>
326<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
327</EM>
328</TD>
329</TR>
330
331<TR>
332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
333&nbsp;<A HREF="../../../../org/gjt/sp/jedit/Macros.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
334&nbsp;<A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
335<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
336  <A HREF="../../../../index.html?org/gjt/sp/jedit/Macros.Handler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
337&nbsp;<A HREF="Macros.Handler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
338&nbsp;
339<NOSCRIPT>
340  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
341</NOSCRIPT>
342
343
344</FONT></TD>
345</TR>
346<TR>
347<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
348  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
349<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
350DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
351</TR>
352</TABLE>
353<A NAME="skip-navbar_bottom"></A>
354<!-- ======== END OF BOTTOM NAVBAR ======= -->
355
356<HR>
357
358</BODY>
359</HTML>