/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/JEditActionSet.html
# · HTML · 873 lines · 769 code · 90 blank · 14 comment · 0 complexity · 961f8767b0832228d9fa85ae09600b97 MD5 · raw file
- <!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:45 GMT-08:00 2008 -->
- <TITLE>
- JEditActionSet (jEdit API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.gjt.sp.jedit.JEditActionSet 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/JEditActionSet.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/JEditActionContext.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.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/JEditActionSet.html" target="_top"><B>FRAMES</B></A>
- <A HREF="JEditActionSet.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <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 JEditActionSet<E extends <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A>></H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.JEditActionSet<E></B>
- </PRE>
- <DL>
- <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/gjt/sp/jedit/input/InputHandlerProvider.html" title="interface in org.gjt.sp.jedit.input">InputHandlerProvider</A></DD>
- </DL>
- <DL>
- <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit">ActionSet</A></DD>
- </DL>
- <HR>
- <DL>
- <DT><PRE>public abstract class <B>JEditActionSet<E extends <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A>></B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/gjt/sp/jedit/input/InputHandlerProvider.html" title="interface in org.gjt.sp.jedit.input">InputHandlerProvider</A></DL>
- </PRE>
- <P>
- A set of actions, either loaded from an XML file, or constructed at runtime
- by a plugin. <p>
- <h3>Action sets loaded from XML files</h3>
- Action sets are read from these files inside the plugin JAR:
- <ul>
- <li><code>actions.xml</code> - actions made available for use in jEdit views,
- including the view's <b>Plugins</b> menu, the tool bar, etc.</li>
- <li><code>browser.actions.xml</code> - actions for the file system browser's
- <b>Plugins</b> menu.</li>
- </ul>
- An action definition file has the following form:
- <pre><?xml version="1.0"?>
- <!DOCTYPE ACTIONS SYSTEM "actions.dtd">
- <ACTIONS>
- <ACTION NAME="some-action">
- <CODE>
- // BeanShell code evaluated when the action is invoked
- </CODE>
- </ACTION>
- <ACTION NAME="some-toggle-action">
- <CODE>
- // BeanShell code evaluated when the action is invoked
- </CODE>
- <IS_SELECTED>
- // BeanShell code that should evaluate to true or false
- </IS_SELECTED>
- </ACTION>
- </ACTIONS></pre>
- The following elements are valid:
- <ul>
- <li>
- <code>ACTIONS</code> is the top-level element and refers
- to the set of actions used by the plugin.
- </li>
- <li>
- An <code>ACTION</code> contains the data for a particular action.
- It has three attributes: a required <code>NAME</code>;
- an optional <code>NO_REPEAT</code>, which is a flag
- indicating whether the action should not be repeated with the
- <b>C+ENTER</b> command; and an optional
- <code>NO_RECORD</code> which is a a flag indicating whether the
- action should be recorded if it is invoked while the user is recording a
- macro. The two flag attributes
- can have two possible values, "TRUE" or
- "FALSE". In both cases, "FALSE" is the
- default if the attribute is not specified.
- </li>
- <li>
- An <code>ACTION</code> can have two child elements
- within it: a required <code>CODE</code> element which
- specifies the
- BeanShell code that will be executed when the action is invoked,
- and an optional <code>IS_SELECTED</code> element, used for
- checkbox
- menu items. The <code>IS_SELECTED</code> element contains
- BeanShell code that returns a boolean flag that will
- determine the state of the checkbox.
- </li>
- </ul>
- Each action must have a property <code><i>name</i>.label</code> containing
- the action's menu item label.
- <h3>View actions</h3>
- Actions defined in <code>actions.xml</code> can be added to the view's
- <b>Plugins</b> menu; see <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit"><CODE>EditPlugin</CODE></A>.
- The action code may use any standard predefined
- BeanShell variable; see <A HREF="../../../../org/gjt/sp/jedit/BeanShell.html" title="class in org.gjt.sp.jedit"><CODE>BeanShell</CODE></A>.
- <h3>File system browser actions</h3>
- Actions defined in <code>actions.xml</code> can be added to the file
- system browser's <b>Plugins</b> menu; see <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit"><CODE>EditPlugin</CODE></A>.
- The action code may use any standard predefined
- BeanShell variable, in addition to a variable <code>browser</code> which
- contains a reference to the current
- <A HREF="../../../../org/gjt/sp/jedit/browser/VFSBrowser.html" title="class in org.gjt.sp.jedit.browser"><CODE>VFSBrowser</CODE></A> instance.<p>
- File system browser actions should not define
- <code><IS_SELECTED></code> blocks.
- <h3>Custom action sets</h3>
- Call <A HREF="../../../../org/gjt/sp/jedit/jEdit.html#addActionSet(org.gjt.sp.jedit.ActionSet)"><CODE>jEdit.addActionSet(ActionSet)</CODE></A> to add a custom action set to
- jEdit's action context. You must also call <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#initKeyBindings()"><CODE>initKeyBindings()</CODE></A> for new
- action sets. Don't forget to call <A HREF="../../../../org/gjt/sp/jedit/jEdit.html#removeActionSet(org.gjt.sp.jedit.ActionSet)"><CODE>jEdit.removeActionSet(ActionSet)</CODE></A>
- before your plugin is unloaded, too.
- <P>
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre13</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getActionContext()"><CODE>jEdit.getActionContext()</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/browser/VFSBrowser.html#getActionContext()"><CODE>VFSBrowser.getActionContext()</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/JEditActionContext.html#getActionNames()"><CODE>JEditActionContext.getActionNames()</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/ActionContext.html#getAction(java.lang.String)"><CODE>ActionContext.getAction(String)</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/jEdit.html#addActionSet(org.gjt.sp.jedit.ActionSet)"><CODE>jEdit.addActionSet(ActionSet)</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/jEdit.html#removeActionSet(org.gjt.sp.jedit.ActionSet)"><CODE>jEdit.removeActionSet(ActionSet)</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/PluginJAR.html#getActionSet()"><CODE>PluginJAR.getActionSet()</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/BeanShell.html" title="class in org.gjt.sp.jedit"><CODE>BeanShell</CODE></A>,
- <A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit"><CODE>View</CODE></A></DL>
- <HR>
- <P>
- <!-- =========== FIELD SUMMARY =========== -->
- <A NAME="field_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>Field Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected java.util.Hashtable<java.lang.String,java.lang.Object></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#actions">actions</A></B></CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#loaded">loaded</A></B></CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected static java.lang.Object</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#placeholder">placeholder</A></B></CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected java.net.URL</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#uri">uri</A></B></CODE>
- <BR>
- </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/JEditActionSet.html#JEditActionSet()">JEditActionSet</A></B>()</CODE>
- <BR>
- Creates a new action set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#JEditActionSet(java.lang.String[], java.net.URL)">JEditActionSet</A></B>(java.lang.String[] cachedActionNames,
- java.net.URL uri)</CODE>
- <BR>
- Creates a new action set.</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> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#addAction(E)">addAction</A></B>(<A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A> action)</CODE>
- <BR>
- Adds an action to the action set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#contains(java.lang.String)">contains</A></B>(java.lang.String action)</CODE>
- <BR>
- Returns if this action set contains the specified action.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected abstract <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#createBeanShellAction(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)">createBeanShellAction</A></B>(java.lang.String actionName,
- java.lang.String code,
- java.lang.String selected,
- boolean noRepeat,
- boolean noRecord,
- boolean noRememberLast)</CODE>
- <BR>
- This method should be implemented to return an action that will execute
- the given code</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getAction(java.lang.String)">getAction</A></B>(java.lang.String name)</CODE>
- <BR>
- Returns an action with the specified name.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getActionCount()">getActionCount</A></B>()</CODE>
- <BR>
- Returns the number of actions in the set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getActionNames()">getActionNames</A></B>()</CODE>
- <BR>
- Returns an array of all action names in this action set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getActions()">getActions</A></B>()</CODE>
- <BR>
- Returns an array of all actions in this action set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected abstract <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getArray(int)">getArray</A></B>(int size)</CODE>
- <BR>
- Returns an empty array E[].</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getCacheableActionNames()">getCacheableActionNames</A></B>()</CODE>
- <BR>
- Returns an array of all action names in this action set that should
- be cached; namely, <code>BeanShellAction</code>s.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected abstract java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String name)</CODE>
- <BR>
- Returns a property for the given name.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#initKeyBindings()">initKeyBindings</A></B>()</CODE>
- <BR>
- Initializes the action set's key bindings.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#load()">load</A></B>()</CODE>
- <BR>
- Forces the action set to be loaded.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#removeAction(java.lang.String)">removeAction</A></B>(java.lang.String name)</CODE>
- <BR>
- Removes an action from the action set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#removeAllActions()">removeAllActions</A></B>()</CODE>
- <BR>
- Removes all actions from the action set.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#size()">size</A></B>()</CODE>
- <BR>
- Returns the number of actions in this action set.</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>
- <A NAME="methods_inherited_from_class_org.gjt.sp.jedit.input.InputHandlerProvider"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from interface org.gjt.sp.jedit.input.<A HREF="../../../../org/gjt/sp/jedit/input/InputHandlerProvider.html" title="interface in org.gjt.sp.jedit.input">InputHandlerProvider</A></B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><A HREF="../../../../org/gjt/sp/jedit/input/InputHandlerProvider.html#getInputHandler()">getInputHandler</A></CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ FIELD DETAIL =========== -->
- <A NAME="field_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>Field Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="actions"><!-- --></A><H3>
- actions</H3>
- <PRE>
- protected java.util.Hashtable<java.lang.String,java.lang.Object> <B>actions</B></PRE>
- <DL>
- <DL>
- </DL>
- </DL>
- <HR>
- <A NAME="uri"><!-- --></A><H3>
- uri</H3>
- <PRE>
- protected java.net.URL <B>uri</B></PRE>
- <DL>
- <DL>
- </DL>
- </DL>
- <HR>
- <A NAME="loaded"><!-- --></A><H3>
- loaded</H3>
- <PRE>
- protected boolean <B>loaded</B></PRE>
- <DL>
- <DL>
- </DL>
- </DL>
- <HR>
- <A NAME="placeholder"><!-- --></A><H3>
- placeholder</H3>
- <PRE>
- protected static final java.lang.Object <B>placeholder</B></PRE>
- <DL>
- <DL>
- </DL>
- </DL>
- <!-- ========= 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="JEditActionSet()"><!-- --></A><H3>
- JEditActionSet</H3>
- <PRE>
- public <B>JEditActionSet</B>()</PRE>
- <DL>
- <DD>Creates a new action set.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre13</DD>
- </DL>
- </DL>
- <HR>
- <A NAME="JEditActionSet(java.lang.String[], java.net.URL)"><!-- --></A><H3>
- JEditActionSet</H3>
- <PRE>
- public <B>JEditActionSet</B>(java.lang.String[] cachedActionNames,
- java.net.URL uri)</PRE>
- <DL>
- <DD>Creates a new action set.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>cachedActionNames</CODE> - The list of cached action names<DD><CODE>uri</CODE> - The actions.xml URI<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre13</DD>
- </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="addAction(org.gjt.sp.jedit.JEditAbstractEditAction)"><!-- --></A><A NAME="addAction(E)"><!-- --></A><H3>
- addAction</H3>
- <PRE>
- public void <B>addAction</B>(<A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A> action)</PRE>
- <DL>
- <DD>Adds an action to the action set.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>action</CODE> - The action<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="removeAction(java.lang.String)"><!-- --></A><H3>
- removeAction</H3>
- <PRE>
- public void <B>removeAction</B>(java.lang.String name)</PRE>
- <DL>
- <DD>Removes an action from the action set.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>name</CODE> - The action name<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="removeAllActions()"><!-- --></A><H3>
- removeAllActions</H3>
- <PRE>
- public void <B>removeAllActions</B>()</PRE>
- <DL>
- <DD>Removes all actions from the action set.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getAction(java.lang.String)"><!-- --></A><H3>
- getAction</H3>
- <PRE>
- public <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A> <B>getAction</B>(java.lang.String name)</PRE>
- <DL>
- <DD>Returns an action with the specified name.<p>
- <b>Deferred loading:</b> this will load the action set if necessary.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>name</CODE> - The action name<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getActionCount()"><!-- --></A><H3>
- getActionCount</H3>
- <PRE>
- public int <B>getActionCount</B>()</PRE>
- <DL>
- <DD>Returns the number of actions in the set.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getActionNames()"><!-- --></A><H3>
- getActionNames</H3>
- <PRE>
- public java.lang.String[] <B>getActionNames</B>()</PRE>
- <DL>
- <DD>Returns an array of all action names in this action set.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getCacheableActionNames()"><!-- --></A><H3>
- getCacheableActionNames</H3>
- <PRE>
- public java.lang.String[] <B>getCacheableActionNames</B>()</PRE>
- <DL>
- <DD>Returns an array of all action names in this action set that should
- be cached; namely, <code>BeanShellAction</code>s.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getArray(int)"><!-- --></A><H3>
- getArray</H3>
- <PRE>
- protected abstract <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[] <B>getArray</B>(int size)</PRE>
- <DL>
- <DD>Returns an empty array E[].
- I know it is bad, if you find a method to instantiate a generic Array,
- tell me
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of the array
- <DT><B>Returns:</B><DD>the empty array</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getActions()"><!-- --></A><H3>
- getActions</H3>
- <PRE>
- public <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[] <B>getActions</B>()</PRE>
- <DL>
- <DD>Returns an array of all actions in this action set.<p>
- <b>Deferred loading:</b> this will load the action set if necessary.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="contains(java.lang.String)"><!-- --></A><H3>
- contains</H3>
- <PRE>
- public boolean <B>contains</B>(java.lang.String action)</PRE>
- <DL>
- <DD>Returns if this action set contains the specified action.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>action</CODE> - The action<DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="size()"><!-- --></A><H3>
- size</H3>
- <PRE>
- public int <B>size</B>()</PRE>
- <DL>
- <DD>Returns the number of actions in this action set.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="load()"><!-- --></A><H3>
- load</H3>
- <PRE>
- public void <B>load</B>()</PRE>
- <DL>
- <DD>Forces the action set to be loaded. Plugins and macros should not
- call this method.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="createBeanShellAction(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)"><!-- --></A><H3>
- createBeanShellAction</H3>
- <PRE>
- protected abstract <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A> <B>createBeanShellAction</B>(java.lang.String actionName,
- java.lang.String code,
- java.lang.String selected,
- boolean noRepeat,
- boolean noRecord,
- boolean noRememberLast)</PRE>
- <DL>
- <DD>This method should be implemented to return an action that will execute
- the given code
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>4.3pre13</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="initKeyBindings()"><!-- --></A><H3>
- initKeyBindings</H3>
- <PRE>
- public void <B>initKeyBindings</B>()</PRE>
- <DL>
- <DD>Initializes the action set's key bindings.
- jEdit calls this method for all registered action sets when the
- user changes key bindings in the <b>Global Options</b> dialog box.<p>
- Note if your plugin adds a custom action set to jEdit's collection,
- it must also call this method on the action set after adding it.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
- getProperty</H3>
- <PRE>
- protected abstract java.lang.String <B>getProperty</B>(java.lang.String name)</PRE>
- <DL>
- <DD>Returns a property for the given name.
- In jEdit it will returns a jEdit.getProperty(name), but it can
- return something else for a standalone textarea.
- <P>
- <DD><DL>
- </DL>
- </DD>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>name</CODE> - the property name
- <DT><B>Returns:</B><DD>the property value<DT><B>Since:</B></DT>
- <DD>4.3pre13</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/JEditActionSet.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/JEditActionContext.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.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/JEditActionSet.html" target="_top"><B>FRAMES</B></A>
- <A HREF="JEditActionSet.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <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>