/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/Macros.html
HTML | 813 lines | 719 code | 81 blank | 13 comment | 0 complexity | 6380537666d8f0bb6e757d9bd3884d2c 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:46 GMT-08:00 2008 -->
6<TITLE>
7Macros (jEdit API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.Macros 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> </TD>
33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
34 <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Macros.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>
51 <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.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.html" target="_top"><B>FRAMES</B></A>
54 <A HREF="Macros.html" target="_top"><B>NO FRAMES</B></A>
55
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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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</H2>
80<PRE>
81java.lang.Object
82 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.Macros</B>
83</PRE>
84<HR>
85<DL>
86<DT><PRE>public class <B>Macros</B><DT>extends java.lang.Object</DL>
87</PRE>
88
89<P>
90This class records and runs macros.<p>
91
92 It also contains a few methods useful for displaying output messages
93 or obtaining input from a macro:
94
95 <ul>
96 <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#confirm(java.awt.Component, java.lang.String, int)"><CODE>confirm(Component,String,int)</CODE></A></li>
97 <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#confirm(java.awt.Component, java.lang.String, int, int)"><CODE>confirm(Component,String,int,int)</CODE></A></li>
98 <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#error(java.awt.Component, java.lang.String)"><CODE>error(Component,String)</CODE></A></li>
99 <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#input(java.awt.Component, java.lang.String)"><CODE>input(Component,String)</CODE></A></li>
100 <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#input(java.awt.Component, java.lang.String, java.lang.String)"><CODE>input(Component,String,String)</CODE></A></li>
101 <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#message(java.awt.Component, java.lang.String)"><CODE>message(Component,String)</CODE></A></li>
102 </ul>
103
104 Note that plugins should not use the above methods. Call
105 the methods in the <A HREF="../../../../org/gjt/sp/jedit/GUIUtilities.html" title="class in org.gjt.sp.jedit"><CODE>GUIUtilities</CODE></A> class instead.
106<P>
107
108<P>
109<HR>
110
111<P>
112<!-- ======== NESTED CLASS SUMMARY ======== -->
113
114<A NAME="nested_class_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>Nested Class 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>static class</CODE></FONT></TD>
123<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A></B></CODE>
124
125<BR>
126 Encapsulates creating and invoking macros in arbitrary scripting languages</TD>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130<CODE>static class</CODE></FONT></TD>
131<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></B></CODE>
132
133<BR>
134 Encapsulates the macro's label, name and path.</TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>static class</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Recorder.html" title="class in org.gjt.sp.jedit">Macros.Recorder</A></B></CODE>
140
141<BR>
142 Handles macro recording.</TD>
143</TR>
144</TABLE>
145
146<!-- ======== CONSTRUCTOR SUMMARY ======== -->
147
148<A NAME="constructor_summary"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
151<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
152<B>Constructor Summary</B></FONT></TH>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#Macros()">Macros</A></B>()</CODE>
156
157<BR>
158 </TD>
159</TR>
160</TABLE>
161
162<!-- ========== METHOD SUMMARY =========== -->
163
164<A NAME="method_summary"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
168<B>Method Summary</B></FONT></TH>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE>static int</CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#confirm(java.awt.Component, java.lang.String, int)">confirm</A></B>(java.awt.Component comp,
174 java.lang.String prompt,
175 int buttons)</CODE>
176
177<BR>
178 Utility method that can be used to ask for confirmation in a macro.</TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182<CODE>static int</CODE></FONT></TD>
183<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#confirm(java.awt.Component, java.lang.String, int, int)">confirm</A></B>(java.awt.Component comp,
184 java.lang.String prompt,
185 int buttons,
186 int type)</CODE>
187
188<BR>
189 Utility method that can be used to ask for confirmation in a macro.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>static void</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#error(java.awt.Component, java.lang.String)">error</A></B>(java.awt.Component comp,
195 java.lang.String message)</CODE>
196
197<BR>
198 Utility method that can be used to display an error dialog in a macro.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A></CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getHandler(java.lang.String)">getHandler</A></B>(java.lang.String name)</CODE>
204
205<BR>
206 Returns the macro handler with the specified name, or null if
207 there is no registered handler with that name.</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A></CODE></FONT></TD>
212<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getHandlerForPathName(java.lang.String)">getHandlerForPathName</A></B>(java.lang.String pathName)</CODE>
213
214<BR>
215 Returns the macro handler suitable for running the specified file
216 name, or null if there is no suitable handler.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A>[]</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getHandlers()">getHandlers</A></B>()</CODE>
222
223<BR>
224 Returns an array containing the list of registered macro handlers</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getLastMacro()">getLastMacro</A></B>()</CODE>
230
231<BR>
232 </TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getMacro(java.lang.String)">getMacro</A></B>(java.lang.String macro)</CODE>
238
239<BR>
240 Returns the macro with the specified name.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>static <A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit">ActionSet</A></CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getMacroActionSet()">getMacroActionSet</A></B>()</CODE>
246
247<BR>
248 Returns an action set with all known macros in it.</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>static java.util.Vector</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getMacroHierarchy()">getMacroHierarchy</A></B>()</CODE>
254
255<BR>
256 Returns a vector hierarchy with all known macros in it.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>static java.lang.String</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#input(java.awt.Component, java.lang.String)">input</A></B>(java.awt.Component comp,
262 java.lang.String prompt)</CODE>
263
264<BR>
265 Utility method that can be used to prompt for input in a macro.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>static java.lang.String</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#input(java.awt.Component, java.lang.String, java.lang.String)">input</A></B>(java.awt.Component comp,
271 java.lang.String prompt,
272 java.lang.String defaultValue)</CODE>
273
274<BR>
275 Utility method that can be used to prompt for input in a macro.</TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279<CODE>static void</CODE></FONT></TD>
280<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#loadMacros()">loadMacros</A></B>()</CODE>
281
282<BR>
283 Rebuilds the macros list, and sends a MacrosChanged message
284 (views update their Macros menu upon receiving it)</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<CODE>static void</CODE></FONT></TD>
289<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#message(java.awt.Component, java.lang.String)">message</A></B>(java.awt.Component comp,
290 java.lang.String message)</CODE>
291
292<BR>
293 Utility method that can be used to display a message dialog in a macro.</TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297<CODE>static void</CODE></FONT></TD>
298<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#recordMacro(org.gjt.sp.jedit.View)">recordMacro</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</CODE>
299
300<BR>
301 Starts recording a macro.</TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>static void</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#recordTemporaryMacro(org.gjt.sp.jedit.View)">recordTemporaryMacro</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</CODE>
307
308<BR>
309 Starts recording a temporary macro.</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>static void</CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#registerHandler(org.gjt.sp.jedit.Macros.Handler)">registerHandler</A></B>(<A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A> handler)</CODE>
315
316<BR>
317 Adds a macro handler to the handlers list</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>static void</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#runScript(org.gjt.sp.jedit.View, java.lang.String, boolean)">runScript</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
323 java.lang.String path,
324 boolean ignoreUnknown)</CODE>
325
326<BR>
327 Runs the specified script.</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>static void</CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#runTemporaryMacro(org.gjt.sp.jedit.View)">runTemporaryMacro</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</CODE>
333
334<BR>
335 Runs the temporary macro.</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>static void</CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#setLastMacro(org.gjt.sp.jedit.Macros.Macro)">setLastMacro</A></B>(<A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A> macro)</CODE>
341
342<BR>
343 </TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>static void</CODE></FONT></TD>
348<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#showRunScriptDialog(org.gjt.sp.jedit.View)">showRunScriptDialog</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</CODE>
349
350<BR>
351 Prompts for one or more files to run as macros</TD>
352</TR>
353<TR BGCOLOR="white" CLASS="TableRowColor">
354<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355<CODE>static void</CODE></FONT></TD>
356<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#stopRecording(org.gjt.sp.jedit.View)">stopRecording</A></B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</CODE>
357
358<BR>
359 Stops a recording currently in progress.</TD>
360</TR>
361</TABLE>
362 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
363<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
364<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
365<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
366</TR>
367<TR BGCOLOR="white" CLASS="TableRowColor">
368<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
369</TR>
370</TABLE>
371
372<P>
373
374<!-- ========= CONSTRUCTOR DETAIL ======== -->
375
376<A NAME="constructor_detail"><!-- --></A>
377<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
378<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
379<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
380<B>Constructor Detail</B></FONT></TH>
381</TR>
382</TABLE>
383
384<A NAME="Macros()"><!-- --></A><H3>
385Macros</H3>
386<PRE>
387public <B>Macros</B>()</PRE>
388<DL>
389</DL>
390
391<!-- ============ METHOD DETAIL ========== -->
392
393<A NAME="method_detail"><!-- --></A>
394<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
395<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
396<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
397<B>Method Detail</B></FONT></TH>
398</TR>
399</TABLE>
400
401<A NAME="showRunScriptDialog(org.gjt.sp.jedit.View)"><!-- --></A><H3>
402showRunScriptDialog</H3>
403<PRE>
404public static void <B>showRunScriptDialog</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
405<DL>
406<DD>Prompts for one or more files to run as macros
407<P>
408<DD><DL>
409<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
410 <DD>jEdit 4.0pre7</DD>
411</DL>
412</DD>
413</DL>
414<HR>
415
416<A NAME="runScript(org.gjt.sp.jedit.View, java.lang.String, boolean)"><!-- --></A><H3>
417runScript</H3>
418<PRE>
419public static void <B>runScript</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
420 java.lang.String path,
421 boolean ignoreUnknown)</PRE>
422<DL>
423<DD>Runs the specified script.
424 Unlike the <A HREF="../../../../org/gjt/sp/jedit/BeanShell.html#runScript(org.gjt.sp.jedit.View, java.lang.String, java.io.Reader, boolean)"><CODE>BeanShell.runScript(View,String,Reader,boolean)</CODE></A>
425 method, this method can run scripts supported
426 by any registered macro handler.
427<P>
428<DD><DL>
429<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DD><CODE>path</CODE> - The VFS path of the script<DD><CODE>ignoreUnknown</CODE> - If true, then unknown file types will be
430 ignored; otherwise, a warning message will be printed and they will
431 be evaluated as BeanShell scripts.<DT><B>Since:</B></DT>
432 <DD>jEdit 4.1pre2</DD>
433</DL>
434</DD>
435</DL>
436<HR>
437
438<A NAME="message(java.awt.Component, java.lang.String)"><!-- --></A><H3>
439message</H3>
440<PRE>
441public static void <B>message</B>(java.awt.Component comp,
442 java.lang.String message)</PRE>
443<DL>
444<DD>Utility method that can be used to display a message dialog in a macro.
445<P>
446<DD><DL>
447<DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
448 will usually be a view instance<DD><CODE>message</CODE> - The message<DT><B>Since:</B></DT>
449 <DD>jEdit 2.7pre2</DD>
450</DL>
451</DD>
452</DL>
453<HR>
454
455<A NAME="error(java.awt.Component, java.lang.String)"><!-- --></A><H3>
456error</H3>
457<PRE>
458public static void <B>error</B>(java.awt.Component comp,
459 java.lang.String message)</PRE>
460<DL>
461<DD>Utility method that can be used to display an error dialog in a macro.
462<P>
463<DD><DL>
464<DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
465 will usually be a view instance<DD><CODE>message</CODE> - The message<DT><B>Since:</B></DT>
466 <DD>jEdit 2.7pre2</DD>
467</DL>
468</DD>
469</DL>
470<HR>
471
472<A NAME="input(java.awt.Component, java.lang.String)"><!-- --></A><H3>
473input</H3>
474<PRE>
475public static java.lang.String <B>input</B>(java.awt.Component comp,
476 java.lang.String prompt)</PRE>
477<DL>
478<DD>Utility method that can be used to prompt for input in a macro.
479<P>
480<DD><DL>
481<DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
482 will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DT><B>Since:</B></DT>
483 <DD>jEdit 2.7pre2</DD>
484</DL>
485</DD>
486</DL>
487<HR>
488
489<A NAME="input(java.awt.Component, java.lang.String, java.lang.String)"><!-- --></A><H3>
490input</H3>
491<PRE>
492public static java.lang.String <B>input</B>(java.awt.Component comp,
493 java.lang.String prompt,
494 java.lang.String defaultValue)</PRE>
495<DL>
496<DD>Utility method that can be used to prompt for input in a macro.
497<P>
498<DD><DL>
499<DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
500 will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DT><B>Since:</B></DT>
501 <DD>jEdit 3.1final</DD>
502</DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="confirm(java.awt.Component, java.lang.String, int)"><!-- --></A><H3>
508confirm</H3>
509<PRE>
510public static int <B>confirm</B>(java.awt.Component comp,
511 java.lang.String prompt,
512 int buttons)</PRE>
513<DL>
514<DD>Utility method that can be used to ask for confirmation in a macro.
515<P>
516<DD><DL>
517<DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
518 will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DD><CODE>buttons</CODE> - The buttons to display - for example,
519 JOptionPane.YES_NO_CANCEL_OPTION<DT><B>Since:</B></DT>
520 <DD>jEdit 4.0pre2</DD>
521</DL>
522</DD>
523</DL>
524<HR>
525
526<A NAME="confirm(java.awt.Component, java.lang.String, int, int)"><!-- --></A><H3>
527confirm</H3>
528<PRE>
529public static int <B>confirm</B>(java.awt.Component comp,
530 java.lang.String prompt,
531 int buttons,
532 int type)</PRE>
533<DL>
534<DD>Utility method that can be used to ask for confirmation in a macro.
535<P>
536<DD><DL>
537<DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
538 will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DD><CODE>buttons</CODE> - The buttons to display - for example,
539 JOptionPane.YES_NO_CANCEL_OPTION<DD><CODE>type</CODE> - The dialog type - for example,
540 JOptionPane.WARNING_MESSAGE</DL>
541</DD>
542</DL>
543<HR>
544
545<A NAME="loadMacros()"><!-- --></A><H3>
546loadMacros</H3>
547<PRE>
548public static void <B>loadMacros</B>()</PRE>
549<DL>
550<DD>Rebuilds the macros list, and sends a MacrosChanged message
551 (views update their Macros menu upon receiving it)
552<P>
553<DD><DL>
554<DT><B>Since:</B></DT>
555 <DD>jEdit 2.2pre4</DD>
556</DL>
557</DD>
558</DL>
559<HR>
560
561<A NAME="registerHandler(org.gjt.sp.jedit.Macros.Handler)"><!-- --></A><H3>
562registerHandler</H3>
563<PRE>
564public static void <B>registerHandler</B>(<A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A> handler)</PRE>
565<DL>
566<DD>Adds a macro handler to the handlers list
567<P>
568<DD><DL>
569<DT><B>Since:</B></DT>
570 <DD>jEdit 4.0pre6</DD>
571</DL>
572</DD>
573</DL>
574<HR>
575
576<A NAME="getHandlers()"><!-- --></A><H3>
577getHandlers</H3>
578<PRE>
579public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A>[] <B>getHandlers</B>()</PRE>
580<DL>
581<DD>Returns an array containing the list of registered macro handlers
582<P>
583<DD><DL>
584<DT><B>Since:</B></DT>
585 <DD>jEdit 4.0pre6</DD>
586</DL>
587</DD>
588</DL>
589<HR>
590
591<A NAME="getHandlerForPathName(java.lang.String)"><!-- --></A><H3>
592getHandlerForPathName</H3>
593<PRE>
594public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A> <B>getHandlerForPathName</B>(java.lang.String pathName)</PRE>
595<DL>
596<DD>Returns the macro handler suitable for running the specified file
597 name, or null if there is no suitable handler.
598<P>
599<DD><DL>
600<DT><B>Since:</B></DT>
601 <DD>jEdit 4.1pre3</DD>
602</DL>
603</DD>
604</DL>
605<HR>
606
607<A NAME="getHandler(java.lang.String)"><!-- --></A><H3>
608getHandler</H3>
609<PRE>
610public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A> <B>getHandler</B>(java.lang.String name)</PRE>
611<DL>
612<DD>Returns the macro handler with the specified name, or null if
613 there is no registered handler with that name.
614<P>
615<DD><DL>
616<DT><B>Since:</B></DT>
617 <DD>jEdit 4.0pre6</DD>
618</DL>
619</DD>
620</DL>
621<HR>
622
623<A NAME="getMacroHierarchy()"><!-- --></A><H3>
624getMacroHierarchy</H3>
625<PRE>
626public static java.util.Vector <B>getMacroHierarchy</B>()</PRE>
627<DL>
628<DD>Returns a vector hierarchy with all known macros in it.
629 Each element of this vector is either a macro name string,
630 or another vector. If it is a vector, the first element is a
631 string label, the rest are again, either macro name strings
632 or vectors.
633<P>
634<DD><DL>
635<DT><B>Since:</B></DT>
636 <DD>jEdit 2.6pre1</DD>
637</DL>
638</DD>
639</DL>
640<HR>
641
642<A NAME="getMacroActionSet()"><!-- --></A><H3>
643getMacroActionSet</H3>
644<PRE>
645public static <A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit">ActionSet</A> <B>getMacroActionSet</B>()</PRE>
646<DL>
647<DD>Returns an action set with all known macros in it.
648<P>
649<DD><DL>
650<DT><B>Since:</B></DT>
651 <DD>jEdit 4.0pre1</DD>
652</DL>
653</DD>
654</DL>
655<HR>
656
657<A NAME="getMacro(java.lang.String)"><!-- --></A><H3>
658getMacro</H3>
659<PRE>
660public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A> <B>getMacro</B>(java.lang.String macro)</PRE>
661<DL>
662<DD>Returns the macro with the specified name.
663<P>
664<DD><DL>
665<DT><B>Parameters:</B><DD><CODE>macro</CODE> - The macro's name<DT><B>Since:</B></DT>
666 <DD>jEdit 2.6pre1</DD>
667</DL>
668</DD>
669</DL>
670<HR>
671
672<A NAME="getLastMacro()"><!-- --></A><H3>
673getLastMacro</H3>
674<PRE>
675public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A> <B>getLastMacro</B>()</PRE>
676<DL>
677<DD><DL>
678<DT><B>Since:</B></DT>
679 <DD>jEdit 4.3pre1</DD>
680</DL>
681</DD>
682</DL>
683<HR>
684
685<A NAME="setLastMacro(org.gjt.sp.jedit.Macros.Macro)"><!-- --></A><H3>
686setLastMacro</H3>
687<PRE>
688public static void <B>setLastMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A> macro)</PRE>
689<DL>
690<DD><DL>
691<DT><B>Since:</B></DT>
692 <DD>jEdit 4.3pre1</DD>
693</DL>
694</DD>
695</DL>
696<HR>
697
698<A NAME="recordTemporaryMacro(org.gjt.sp.jedit.View)"><!-- --></A><H3>
699recordTemporaryMacro</H3>
700<PRE>
701public static void <B>recordTemporaryMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
702<DL>
703<DD>Starts recording a temporary macro.
704<P>
705<DD><DL>
706<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
707 <DD>jEdit 2.7pre2</DD>
708</DL>
709</DD>
710</DL>
711<HR>
712
713<A NAME="recordMacro(org.gjt.sp.jedit.View)"><!-- --></A><H3>
714recordMacro</H3>
715<PRE>
716public static void <B>recordMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
717<DL>
718<DD>Starts recording a macro.
719<P>
720<DD><DL>
721<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
722 <DD>jEdit 2.7pre2</DD>
723</DL>
724</DD>
725</DL>
726<HR>
727
728<A NAME="stopRecording(org.gjt.sp.jedit.View)"><!-- --></A><H3>
729stopRecording</H3>
730<PRE>
731public static void <B>stopRecording</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
732<DL>
733<DD>Stops a recording currently in progress.
734<P>
735<DD><DL>
736<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
737 <DD>jEdit 2.7pre2</DD>
738</DL>
739</DD>
740</DL>
741<HR>
742
743<A NAME="runTemporaryMacro(org.gjt.sp.jedit.View)"><!-- --></A><H3>
744runTemporaryMacro</H3>
745<PRE>
746public static void <B>runTemporaryMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
747<DL>
748<DD>Runs the temporary macro.
749<P>
750<DD><DL>
751<DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
752 <DD>jEdit 2.7pre2</DD>
753</DL>
754</DD>
755</DL>
756<!-- ========= END OF CLASS DATA ========= -->
757<HR>
758
759
760<!-- ======= START OF BOTTOM NAVBAR ====== -->
761<A NAME="navbar_bottom"><!-- --></A>
762<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
763<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
764<TR>
765<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
766<A NAME="navbar_bottom_firstrow"><!-- --></A>
767<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
768 <TR ALIGN="center" VALIGN="top">
769 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
770 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
771 <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
772 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Macros.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
773 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
774 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
775 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
776 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
777 </TR>
778</TABLE>
779</TD>
780<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
781</EM>
782</TD>
783</TR>
784
785<TR>
786<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
787 <A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>
788 <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
789<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
790 <A HREF="../../../../index.html?org/gjt/sp/jedit/Macros.html" target="_top"><B>FRAMES</B></A>
791 <A HREF="Macros.html" target="_top"><B>NO FRAMES</B></A>
792
793<NOSCRIPT>
794 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
795</NOSCRIPT>
796
797
798</FONT></TD>
799</TR>
800<TR>
801<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
802 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
803<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
804DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
805</TR>
806</TABLE>
807<A NAME="skip-navbar_bottom"></A>
808<!-- ======== END OF BOTTOM NAVBAR ======= -->
809
810<HR>
811
812</BODY>
813</HTML>