/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
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:13:46 GMT-08:00 2008 -->
- <TITLE>
- Macros (jEdit API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.gjt.sp.jedit.Macros class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" >
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Macros.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/gjt/sp/jedit/Macros.html" target="_top"><B>FRAMES</B></A>
- <A HREF="Macros.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.gjt.sp.jedit</FONT>
- <BR>
- Class Macros</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.Macros</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE>public class <B>Macros</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- This class records and runs macros.<p>
- It also contains a few methods useful for displaying output messages
- or obtaining input from a macro:
- <ul>
- <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>
- <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>
- <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#error(java.awt.Component, java.lang.String)"><CODE>error(Component,String)</CODE></A></li>
- <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#input(java.awt.Component, java.lang.String)"><CODE>input(Component,String)</CODE></A></li>
- <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>
- <li><A HREF="../../../../org/gjt/sp/jedit/Macros.html#message(java.awt.Component, java.lang.String)"><CODE>message(Component,String)</CODE></A></li>
- </ul>
- Note that plugins should not use the above methods. Call
- 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.
- <P>
- <P>
- <HR>
- <P>
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <A NAME="nested_class_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Nested Class Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static class</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A></B></CODE>
- <BR>
- Encapsulates creating and invoking macros in arbitrary scripting languages</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static class</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></B></CODE>
- <BR>
- Encapsulates the macro's label, name and path.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static class</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.Recorder.html" title="class in org.gjt.sp.jedit">Macros.Recorder</A></B></CODE>
- <BR>
- Handles macro recording.</TD>
- </TR>
- </TABLE>
-
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#Macros()">Macros</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <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,
- java.lang.String prompt,
- int buttons)</CODE>
- <BR>
- Utility method that can be used to ask for confirmation in a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <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,
- java.lang.String prompt,
- int buttons,
- int type)</CODE>
- <BR>
- Utility method that can be used to ask for confirmation in a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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,
- java.lang.String message)</CODE>
- <BR>
- Utility method that can be used to display an error dialog in a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getHandler(java.lang.String)">getHandler</A></B>(java.lang.String name)</CODE>
- <BR>
- Returns the macro handler with the specified name, or null if
- there is no registered handler with that name.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getHandlerForPathName(java.lang.String)">getHandlerForPathName</A></B>(java.lang.String pathName)</CODE>
- <BR>
- Returns the macro handler suitable for running the specified file
- name, or null if there is no suitable handler.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A>[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getHandlers()">getHandlers</A></B>()</CODE>
- <BR>
- Returns an array containing the list of registered macro handlers</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getLastMacro()">getLastMacro</A></B>()</CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getMacro(java.lang.String)">getMacro</A></B>(java.lang.String macro)</CODE>
- <BR>
- Returns the macro with the specified name.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit">ActionSet</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getMacroActionSet()">getMacroActionSet</A></B>()</CODE>
- <BR>
- Returns an action set with all known macros in it.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.util.Vector</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#getMacroHierarchy()">getMacroHierarchy</A></B>()</CODE>
- <BR>
- Returns a vector hierarchy with all known macros in it.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <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,
- java.lang.String prompt)</CODE>
- <BR>
- Utility method that can be used to prompt for input in a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <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,
- java.lang.String prompt,
- java.lang.String defaultValue)</CODE>
- <BR>
- Utility method that can be used to prompt for input in a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/Macros.html#loadMacros()">loadMacros</A></B>()</CODE>
- <BR>
- Rebuilds the macros list, and sends a MacrosChanged message
- (views update their Macros menu upon receiving it)</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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,
- java.lang.String message)</CODE>
- <BR>
- Utility method that can be used to display a message dialog in a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- Starts recording a macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- Starts recording a temporary macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- Adds a macro handler to the handlers list</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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,
- java.lang.String path,
- boolean ignoreUnknown)</CODE>
- <BR>
- Runs the specified script.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- Runs the temporary macro.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- Prompts for one or more files to run as macros</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <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>
- <BR>
- Stops a recording currently in progress.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="Macros()"><!-- --></A><H3>
- Macros</H3>
- <PRE>
- public <B>Macros</B>()</PRE>
- <DL>
- </DL>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="showRunScriptDialog(org.gjt.sp.jedit.View)"><!-- --></A><H3>
- showRunScriptDialog</H3>
- <PRE>
- public static void <B>showRunScriptDialog</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
- <DL>
- <DD>Prompts for one or more files to run as macros
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre7</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="runScript(org.gjt.sp.jedit.View, java.lang.String, boolean)"><!-- --></A><H3>
- runScript</H3>
- <PRE>
- public static void <B>runScript</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- java.lang.String path,
- boolean ignoreUnknown)</PRE>
- <DL>
- <DD>Runs the specified script.
- 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>
- method, this method can run scripts supported
- by any registered macro handler.
- <P>
- <DD><DL>
- <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
- ignored; otherwise, a warning message will be printed and they will
- be evaluated as BeanShell scripts.<DT><B>Since:</B></DT>
- <DD>jEdit 4.1pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="message(java.awt.Component, java.lang.String)"><!-- --></A><H3>
- message</H3>
- <PRE>
- public static void <B>message</B>(java.awt.Component comp,
- java.lang.String message)</PRE>
- <DL>
- <DD>Utility method that can be used to display a message dialog in a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
- will usually be a view instance<DD><CODE>message</CODE> - The message<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="error(java.awt.Component, java.lang.String)"><!-- --></A><H3>
- error</H3>
- <PRE>
- public static void <B>error</B>(java.awt.Component comp,
- java.lang.String message)</PRE>
- <DL>
- <DD>Utility method that can be used to display an error dialog in a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
- will usually be a view instance<DD><CODE>message</CODE> - The message<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="input(java.awt.Component, java.lang.String)"><!-- --></A><H3>
- input</H3>
- <PRE>
- public static java.lang.String <B>input</B>(java.awt.Component comp,
- java.lang.String prompt)</PRE>
- <DL>
- <DD>Utility method that can be used to prompt for input in a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
- will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="input(java.awt.Component, java.lang.String, java.lang.String)"><!-- --></A><H3>
- input</H3>
- <PRE>
- public static java.lang.String <B>input</B>(java.awt.Component comp,
- java.lang.String prompt,
- java.lang.String defaultValue)</PRE>
- <DL>
- <DD>Utility method that can be used to prompt for input in a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
- will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DT><B>Since:</B></DT>
- <DD>jEdit 3.1final</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="confirm(java.awt.Component, java.lang.String, int)"><!-- --></A><H3>
- confirm</H3>
- <PRE>
- public static int <B>confirm</B>(java.awt.Component comp,
- java.lang.String prompt,
- int buttons)</PRE>
- <DL>
- <DD>Utility method that can be used to ask for confirmation in a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
- will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DD><CODE>buttons</CODE> - The buttons to display - for example,
- JOptionPane.YES_NO_CANCEL_OPTION<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="confirm(java.awt.Component, java.lang.String, int, int)"><!-- --></A><H3>
- confirm</H3>
- <PRE>
- public static int <B>confirm</B>(java.awt.Component comp,
- java.lang.String prompt,
- int buttons,
- int type)</PRE>
- <DL>
- <DD>Utility method that can be used to ask for confirmation in a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>comp</CODE> - The component to show the dialog on behalf of, this
- will usually be a view instance<DD><CODE>prompt</CODE> - The prompt string<DD><CODE>buttons</CODE> - The buttons to display - for example,
- JOptionPane.YES_NO_CANCEL_OPTION<DD><CODE>type</CODE> - The dialog type - for example,
- JOptionPane.WARNING_MESSAGE</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="loadMacros()"><!-- --></A><H3>
- loadMacros</H3>
- <PRE>
- public static void <B>loadMacros</B>()</PRE>
- <DL>
- <DD>Rebuilds the macros list, and sends a MacrosChanged message
- (views update their Macros menu upon receiving it)
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.2pre4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="registerHandler(org.gjt.sp.jedit.Macros.Handler)"><!-- --></A><H3>
- registerHandler</H3>
- <PRE>
- public 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>
- <DL>
- <DD>Adds a macro handler to the handlers list
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre6</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getHandlers()"><!-- --></A><H3>
- getHandlers</H3>
- <PRE>
- public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit">Macros.Handler</A>[] <B>getHandlers</B>()</PRE>
- <DL>
- <DD>Returns an array containing the list of registered macro handlers
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre6</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getHandlerForPathName(java.lang.String)"><!-- --></A><H3>
- getHandlerForPathName</H3>
- <PRE>
- public 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>
- <DL>
- <DD>Returns the macro handler suitable for running the specified file
- name, or null if there is no suitable handler.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.1pre3</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getHandler(java.lang.String)"><!-- --></A><H3>
- getHandler</H3>
- <PRE>
- public 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>
- <DL>
- <DD>Returns the macro handler with the specified name, or null if
- there is no registered handler with that name.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre6</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getMacroHierarchy()"><!-- --></A><H3>
- getMacroHierarchy</H3>
- <PRE>
- public static java.util.Vector <B>getMacroHierarchy</B>()</PRE>
- <DL>
- <DD>Returns a vector hierarchy with all known macros in it.
- Each element of this vector is either a macro name string,
- or another vector. If it is a vector, the first element is a
- string label, the rest are again, either macro name strings
- or vectors.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getMacroActionSet()"><!-- --></A><H3>
- getMacroActionSet</H3>
- <PRE>
- public static <A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit">ActionSet</A> <B>getMacroActionSet</B>()</PRE>
- <DL>
- <DD>Returns an action set with all known macros in it.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getMacro(java.lang.String)"><!-- --></A><H3>
- getMacro</H3>
- <PRE>
- public 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>
- <DL>
- <DD>Returns the macro with the specified name.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>macro</CODE> - The macro's name<DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getLastMacro()"><!-- --></A><H3>
- getLastMacro</H3>
- <PRE>
- public static <A HREF="../../../../org/gjt/sp/jedit/Macros.Macro.html" title="class in org.gjt.sp.jedit">Macros.Macro</A> <B>getLastMacro</B>()</PRE>
- <DL>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setLastMacro(org.gjt.sp.jedit.Macros.Macro)"><!-- --></A><H3>
- setLastMacro</H3>
- <PRE>
- public 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>
- <DL>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="recordTemporaryMacro(org.gjt.sp.jedit.View)"><!-- --></A><H3>
- recordTemporaryMacro</H3>
- <PRE>
- public static void <B>recordTemporaryMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
- <DL>
- <DD>Starts recording a temporary macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="recordMacro(org.gjt.sp.jedit.View)"><!-- --></A><H3>
- recordMacro</H3>
- <PRE>
- public static void <B>recordMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
- <DL>
- <DD>Starts recording a macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="stopRecording(org.gjt.sp.jedit.View)"><!-- --></A><H3>
- stopRecording</H3>
- <PRE>
- public static void <B>stopRecording</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
- <DL>
- <DD>Stops a recording currently in progress.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="runTemporaryMacro(org.gjt.sp.jedit.View)"><!-- --></A><H3>
- runTemporaryMacro</H3>
- <PRE>
- public static void <B>runTemporaryMacro</B>(<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view)</PRE>
- <DL>
- <DD>Runs the temporary macro.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre2</DD>
- </DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Macros.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/gjt/sp/jedit/Macros.Handler.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/gjt/sp/jedit/Macros.html" target="_top"><B>FRAMES</B></A>
- <A HREF="Macros.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- </BODY>
- </HTML>