PageRenderTime 112ms CodeModel.GetById 30ms app.highlight 55ms RepoModel.GetById 16ms app.codeStats 0ms

/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
  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:45 GMT-08:00 2008 -->
  6<TITLE>
  7JEditActionSet (jEdit API)
  8</TITLE>
  9
 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.JEditActionSet class">
 11
 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 13
 14
 15<NOSCRIPT>
 16</NOSCRIPT>
 17
 18</HEAD>
 19
 20<BODY BGCOLOR="white" >
 21
 22
 23<!-- ========= START OF TOP NAVBAR ======= -->
 24<A NAME="navbar_top"><!-- --></A>
 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 27<TR>
 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 29<A NAME="navbar_top_firstrow"><!-- --></A>
 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 31  <TR ALIGN="center" VALIGN="top">
 32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 34  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 35  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JEditActionSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 36  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 37  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 39  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 40  </TR>
 41</TABLE>
 42</TD>
 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 44</EM>
 45</TD>
 46</TR>
 47
 48<TR>
 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 50&nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditActionContext.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
 51&nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.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/JEditActionSet.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 54&nbsp;<A HREF="JEditActionSet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 55&nbsp;
 56<NOSCRIPT>
 57  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 58</NOSCRIPT>
 59
 60
 61</FONT></TD>
 62</TR>
 63<TR>
 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 65  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 67DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 68</TR>
 69</TABLE>
 70<A NAME="skip-navbar_top"></A>
 71<!-- ========= END OF TOP NAVBAR ========= -->
 72
 73<HR>
 74<!-- ======== START OF CLASS DATA ======== -->
 75<H2>
 76<FONT SIZE="-1">
 77org.gjt.sp.jedit</FONT>
 78<BR>
 79Class JEditActionSet&lt;E extends <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A>&gt;</H2>
 80<PRE>
 81java.lang.Object
 82  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.JEditActionSet&lt;E&gt;</B>
 83</PRE>
 84<DL>
 85<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>
 86</DL>
 87<DL>
 88<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>
 89</DL>
 90<HR>
 91<DL>
 92<DT><PRE>public abstract class <B>JEditActionSet&lt;E extends <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A>&gt;</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>
 93</PRE>
 94
 95<P>
 96A set of actions, either loaded from an XML file, or constructed at runtime
 97 by a plugin. <p>
 98
 99 <h3>Action sets loaded from XML files</h3>
100
101 Action sets are read from these files inside the plugin JAR:
102 <ul>
103 <li><code>actions.xml</code> - actions made available for use in jEdit views,
104 including the view's <b>Plugins</b> menu, the tool bar, etc.</li>
105 <li><code>browser.actions.xml</code> - actions for the file system browser's
106 <b>Plugins</b> menu.</li>
107 </ul>
108
109 An action definition file has the following form:
110
111 <pre>&lt;?xml version="1.0"?&gt;
112&lt;!DOCTYPE ACTIONS SYSTEM "actions.dtd"&gt;
113&lt;ACTIONS&gt;
114    &lt;ACTION NAME="some-action"&gt;
115        &lt;CODE&gt;
116            // BeanShell code evaluated when the action is invoked
117        &lt;/CODE&gt;
118    &lt;/ACTION&gt;
119    &lt;ACTION NAME="some-toggle-action"&gt;
120        &lt;CODE&gt;
121            // BeanShell code evaluated when the action is invoked
122        &lt;/CODE&gt;
123        &lt;IS_SELECTED&gt;
124            // BeanShell code that should evaluate to true or false
125        &lt;/IS_SELECTED&gt;
126    &lt;/ACTION&gt;
127&lt;/ACTIONS&gt;</pre>
128
129 The following elements are valid:
130
131 <ul>
132 <li>
133 <code>ACTIONS</code> is the top-level element and refers
134 to the set of actions used by the plugin.
135 </li>
136 <li>
137 An <code>ACTION</code> contains the data for a particular action.
138 It has three attributes: a required <code>NAME</code>;
139 an optional <code>NO_REPEAT</code>, which is a flag
140 indicating whether the action should not be repeated with the
141 <b>C+ENTER</b> command; and an optional
142 <code>NO_RECORD</code> which is a a flag indicating whether the
143 action should be recorded if it is invoked while the user is recording a
144 macro. The two flag attributes
145 can have two possible values, "TRUE" or
146 "FALSE". In both cases, "FALSE" is the
147 default if the attribute is not specified.
148 </li>
149 <li>
150 An <code>ACTION</code> can have two child elements
151 within it: a required <code>CODE</code> element which
152 specifies the
153 BeanShell code that will be executed when the action is invoked,
154 and an optional <code>IS_SELECTED</code> element, used for
155 checkbox
156 menu items.  The <code>IS_SELECTED</code> element contains
157 BeanShell code that returns a boolean flag that will
158 determine the state of the checkbox.
159 </li>
160 </ul>
161
162 Each action must have a property <code><i>name</i>.label</code> containing
163 the action's menu item label.
164
165 <h3>View actions</h3>
166
167 Actions defined in <code>actions.xml</code> can be added to the view's
168 <b>Plugins</b> menu; see <A HREF="../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit"><CODE>EditPlugin</CODE></A>.
169 The action code may use any standard predefined
170 BeanShell variable; see <A HREF="../../../../org/gjt/sp/jedit/BeanShell.html" title="class in org.gjt.sp.jedit"><CODE>BeanShell</CODE></A>.
171
172 <h3>File system browser actions</h3>
173
174 Actions defined in <code>actions.xml</code> can be added to the file
175 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>.
176 The action code may use any standard predefined
177 BeanShell variable, in addition to a variable <code>browser</code> which
178 contains a reference to the current
179 <A HREF="../../../../org/gjt/sp/jedit/browser/VFSBrowser.html" title="class in org.gjt.sp.jedit.browser"><CODE>VFSBrowser</CODE></A> instance.<p>
180
181 File system browser actions should not define
182 <code>&lt;IS_SELECTED&gt;</code> blocks.
183
184 <h3>Custom action sets</h3>
185
186 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
187 jEdit's action context. You must also call <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#initKeyBindings()"><CODE>initKeyBindings()</CODE></A> for new
188 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>
189 before your plugin is unloaded, too.
190<P>
191
192<P>
193<DL>
194<DT><B>Since:</B></DT>
195  <DD>jEdit 4.3pre13</DD>
196<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getActionContext()"><CODE>jEdit.getActionContext()</CODE></A>, 
197<A HREF="../../../../org/gjt/sp/jedit/browser/VFSBrowser.html#getActionContext()"><CODE>VFSBrowser.getActionContext()</CODE></A>, 
198<A HREF="../../../../org/gjt/sp/jedit/JEditActionContext.html#getActionNames()"><CODE>JEditActionContext.getActionNames()</CODE></A>, 
199<A HREF="../../../../org/gjt/sp/jedit/ActionContext.html#getAction(java.lang.String)"><CODE>ActionContext.getAction(String)</CODE></A>, 
200<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#addActionSet(org.gjt.sp.jedit.ActionSet)"><CODE>jEdit.addActionSet(ActionSet)</CODE></A>, 
201<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#removeActionSet(org.gjt.sp.jedit.ActionSet)"><CODE>jEdit.removeActionSet(ActionSet)</CODE></A>, 
202<A HREF="../../../../org/gjt/sp/jedit/PluginJAR.html#getActionSet()"><CODE>PluginJAR.getActionSet()</CODE></A>, 
203<A HREF="../../../../org/gjt/sp/jedit/BeanShell.html" title="class in org.gjt.sp.jedit"><CODE>BeanShell</CODE></A>, 
204<A HREF="../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit"><CODE>View</CODE></A></DL>
205<HR>
206
207<P>
208<!-- =========== FIELD SUMMARY =========== -->
209
210<A NAME="field_summary"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
214<B>Field Summary</B></FONT></TH>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>protected &nbsp;java.util.Hashtable&lt;java.lang.String,java.lang.Object&gt;</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#actions">actions</A></B></CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>protected &nbsp;boolean</CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#loaded">loaded</A></B></CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>protected static&nbsp;java.lang.Object</CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#placeholder">placeholder</A></B></CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
239</TR>
240<TR BGCOLOR="white" CLASS="TableRowColor">
241<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242<CODE>protected &nbsp;java.net.URL</CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#uri">uri</A></B></CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
247</TR>
248</TABLE>
249&nbsp;
250<!-- ======== CONSTRUCTOR SUMMARY ======== -->
251
252<A NAME="constructor_summary"><!-- --></A>
253<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
254<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
255<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
256<B>Constructor Summary</B></FONT></TH>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#JEditActionSet()">JEditActionSet</A></B>()</CODE>
260
261<BR>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new action set.</TD>
263</TR>
264<TR BGCOLOR="white" CLASS="TableRowColor">
265<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#JEditActionSet(java.lang.String[], java.net.URL)">JEditActionSet</A></B>(java.lang.String[]&nbsp;cachedActionNames,
266               java.net.URL&nbsp;uri)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new action set.</TD>
270</TR>
271</TABLE>
272&nbsp;
273<!-- ========== METHOD SUMMARY =========== -->
274
275<A NAME="method_summary"><!-- --></A>
276<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
278<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
279<B>Method Summary</B></FONT></TH>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>&nbsp;void</CODE></FONT></TD>
284<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>&nbsp;action)</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an action to the action set.</TD>
288</TR>
289<TR BGCOLOR="white" CLASS="TableRowColor">
290<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291<CODE>&nbsp;boolean</CODE></FONT></TD>
292<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#contains(java.lang.String)">contains</A></B>(java.lang.String&nbsp;action)</CODE>
293
294<BR>
295&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns if this action set contains the specified action.</TD>
296</TR>
297<TR BGCOLOR="white" CLASS="TableRowColor">
298<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299<CODE>protected abstract &nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A></CODE></FONT></TD>
300<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&nbsp;actionName,
301                      java.lang.String&nbsp;code,
302                      java.lang.String&nbsp;selected,
303                      boolean&nbsp;noRepeat,
304                      boolean&nbsp;noRecord,
305                      boolean&nbsp;noRememberLast)</CODE>
306
307<BR>
308&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method should be implemented to return an action that will execute
309 the given code</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>&nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A></CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getAction(java.lang.String)">getAction</A></B>(java.lang.String&nbsp;name)</CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an action with the specified name.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;int</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getActionCount()">getActionCount</A></B>()</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of actions in the set.</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getActionNames()">getActionNames</A></B>()</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all action names in this action set.</TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<CODE>&nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[]</CODE></FONT></TD>
338<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getActions()">getActions</A></B>()</CODE>
339
340<BR>
341&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all actions in this action set.</TD>
342</TR>
343<TR BGCOLOR="white" CLASS="TableRowColor">
344<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345<CODE>protected abstract &nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[]</CODE></FONT></TD>
346<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getArray(int)">getArray</A></B>(int&nbsp;size)</CODE>
347
348<BR>
349&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an empty array E[].</TD>
350</TR>
351<TR BGCOLOR="white" CLASS="TableRowColor">
352<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
354<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getCacheableActionNames()">getCacheableActionNames</A></B>()</CODE>
355
356<BR>
357&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all action names in this action set that should
358 be cached; namely, <code>BeanShellAction</code>s.</TD>
359</TR>
360<TR BGCOLOR="white" CLASS="TableRowColor">
361<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
362<CODE>protected abstract &nbsp;java.lang.String</CODE></FONT></TD>
363<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String&nbsp;name)</CODE>
364
365<BR>
366&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a property for the given name.</TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370<CODE>&nbsp;void</CODE></FONT></TD>
371<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#initKeyBindings()">initKeyBindings</A></B>()</CODE>
372
373<BR>
374&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the action set's key bindings.</TD>
375</TR>
376<TR BGCOLOR="white" CLASS="TableRowColor">
377<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378<CODE>&nbsp;void</CODE></FONT></TD>
379<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#load()">load</A></B>()</CODE>
380
381<BR>
382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Forces the action set to be loaded.</TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<CODE>&nbsp;void</CODE></FONT></TD>
387<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#removeAction(java.lang.String)">removeAction</A></B>(java.lang.String&nbsp;name)</CODE>
388
389<BR>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes an action from the action set.</TD>
391</TR>
392<TR BGCOLOR="white" CLASS="TableRowColor">
393<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394<CODE>&nbsp;void</CODE></FONT></TD>
395<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#removeAllActions()">removeAllActions</A></B>()</CODE>
396
397<BR>
398&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all actions from the action set.</TD>
399</TR>
400<TR BGCOLOR="white" CLASS="TableRowColor">
401<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402<CODE>&nbsp;int</CODE></FONT></TD>
403<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html#size()">size</A></B>()</CODE>
404
405<BR>
406&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of actions in this action set.</TD>
407</TR>
408</TABLE>
409&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
410<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
411<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
412<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
413</TR>
414<TR BGCOLOR="white" CLASS="TableRowColor">
415<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
416</TR>
417</TABLE>
418&nbsp;<A NAME="methods_inherited_from_class_org.gjt.sp.jedit.input.InputHandlerProvider"><!-- --></A>
419<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
420<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
421<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>
422</TR>
423<TR BGCOLOR="white" CLASS="TableRowColor">
424<TD><CODE><A HREF="../../../../org/gjt/sp/jedit/input/InputHandlerProvider.html#getInputHandler()">getInputHandler</A></CODE></TD>
425</TR>
426</TABLE>
427&nbsp;
428<P>
429
430<!-- ============ FIELD DETAIL =========== -->
431
432<A NAME="field_detail"><!-- --></A>
433<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
434<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
435<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
436<B>Field Detail</B></FONT></TH>
437</TR>
438</TABLE>
439
440<A NAME="actions"><!-- --></A><H3>
441actions</H3>
442<PRE>
443protected java.util.Hashtable&lt;java.lang.String,java.lang.Object&gt; <B>actions</B></PRE>
444<DL>
445<DL>
446</DL>
447</DL>
448<HR>
449
450<A NAME="uri"><!-- --></A><H3>
451uri</H3>
452<PRE>
453protected java.net.URL <B>uri</B></PRE>
454<DL>
455<DL>
456</DL>
457</DL>
458<HR>
459
460<A NAME="loaded"><!-- --></A><H3>
461loaded</H3>
462<PRE>
463protected boolean <B>loaded</B></PRE>
464<DL>
465<DL>
466</DL>
467</DL>
468<HR>
469
470<A NAME="placeholder"><!-- --></A><H3>
471placeholder</H3>
472<PRE>
473protected static final java.lang.Object <B>placeholder</B></PRE>
474<DL>
475<DL>
476</DL>
477</DL>
478
479<!-- ========= CONSTRUCTOR DETAIL ======== -->
480
481<A NAME="constructor_detail"><!-- --></A>
482<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
483<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
484<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
485<B>Constructor Detail</B></FONT></TH>
486</TR>
487</TABLE>
488
489<A NAME="JEditActionSet()"><!-- --></A><H3>
490JEditActionSet</H3>
491<PRE>
492public <B>JEditActionSet</B>()</PRE>
493<DL>
494<DD>Creates a new action set.
495<P>
496<DL>
497<DT><B>Since:</B></DT>
498  <DD>jEdit 4.3pre13</DD>
499</DL>
500</DL>
501<HR>
502
503<A NAME="JEditActionSet(java.lang.String[], java.net.URL)"><!-- --></A><H3>
504JEditActionSet</H3>
505<PRE>
506public <B>JEditActionSet</B>(java.lang.String[]&nbsp;cachedActionNames,
507                      java.net.URL&nbsp;uri)</PRE>
508<DL>
509<DD>Creates a new action set.
510<P>
511<DL>
512<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>
513  <DD>jEdit 4.3pre13</DD>
514</DL>
515</DL>
516
517<!-- ============ METHOD DETAIL ========== -->
518
519<A NAME="method_detail"><!-- --></A>
520<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
521<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
522<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
523<B>Method Detail</B></FONT></TH>
524</TR>
525</TABLE>
526
527<A NAME="addAction(org.gjt.sp.jedit.JEditAbstractEditAction)"><!-- --></A><A NAME="addAction(E)"><!-- --></A><H3>
528addAction</H3>
529<PRE>
530public void <B>addAction</B>(<A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>&nbsp;action)</PRE>
531<DL>
532<DD>Adds an action to the action set.
533<P>
534<DD><DL>
535</DL>
536</DD>
537<DD><DL>
538<DT><B>Parameters:</B><DD><CODE>action</CODE> - The action<DT><B>Since:</B></DT>
539  <DD>jEdit 4.0pre1</DD>
540</DL>
541</DD>
542</DL>
543<HR>
544
545<A NAME="removeAction(java.lang.String)"><!-- --></A><H3>
546removeAction</H3>
547<PRE>
548public void <B>removeAction</B>(java.lang.String&nbsp;name)</PRE>
549<DL>
550<DD>Removes an action from the action set.
551<P>
552<DD><DL>
553</DL>
554</DD>
555<DD><DL>
556<DT><B>Parameters:</B><DD><CODE>name</CODE> - The action name<DT><B>Since:</B></DT>
557  <DD>jEdit 4.0pre1</DD>
558</DL>
559</DD>
560</DL>
561<HR>
562
563<A NAME="removeAllActions()"><!-- --></A><H3>
564removeAllActions</H3>
565<PRE>
566public void <B>removeAllActions</B>()</PRE>
567<DL>
568<DD>Removes all actions from the action set.
569<P>
570<DD><DL>
571</DL>
572</DD>
573<DD><DL>
574<DT><B>Since:</B></DT>
575  <DD>jEdit 4.0pre1</DD>
576</DL>
577</DD>
578</DL>
579<HR>
580
581<A NAME="getAction(java.lang.String)"><!-- --></A><H3>
582getAction</H3>
583<PRE>
584public <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A> <B>getAction</B>(java.lang.String&nbsp;name)</PRE>
585<DL>
586<DD>Returns an action with the specified name.<p>
587
588 <b>Deferred loading:</b> this will load the action set if necessary.
589<P>
590<DD><DL>
591</DL>
592</DD>
593<DD><DL>
594<DT><B>Parameters:</B><DD><CODE>name</CODE> - The action name<DT><B>Since:</B></DT>
595  <DD>jEdit 4.0pre1</DD>
596</DL>
597</DD>
598</DL>
599<HR>
600
601<A NAME="getActionCount()"><!-- --></A><H3>
602getActionCount</H3>
603<PRE>
604public int <B>getActionCount</B>()</PRE>
605<DL>
606<DD>Returns the number of actions in the set.
607<P>
608<DD><DL>
609</DL>
610</DD>
611<DD><DL>
612<DT><B>Since:</B></DT>
613  <DD>jEdit 4.0pre1</DD>
614</DL>
615</DD>
616</DL>
617<HR>
618
619<A NAME="getActionNames()"><!-- --></A><H3>
620getActionNames</H3>
621<PRE>
622public java.lang.String[] <B>getActionNames</B>()</PRE>
623<DL>
624<DD>Returns an array of all action names in this action set.
625<P>
626<DD><DL>
627</DL>
628</DD>
629<DD><DL>
630<DT><B>Since:</B></DT>
631  <DD>jEdit 4.2pre1</DD>
632</DL>
633</DD>
634</DL>
635<HR>
636
637<A NAME="getCacheableActionNames()"><!-- --></A><H3>
638getCacheableActionNames</H3>
639<PRE>
640public java.lang.String[] <B>getCacheableActionNames</B>()</PRE>
641<DL>
642<DD>Returns an array of all action names in this action set that should
643 be cached; namely, <code>BeanShellAction</code>s.
644<P>
645<DD><DL>
646</DL>
647</DD>
648<DD><DL>
649<DT><B>Since:</B></DT>
650  <DD>jEdit 4.2pre1</DD>
651</DL>
652</DD>
653</DL>
654<HR>
655
656<A NAME="getArray(int)"><!-- --></A><H3>
657getArray</H3>
658<PRE>
659protected abstract <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[] <B>getArray</B>(int&nbsp;size)</PRE>
660<DL>
661<DD>Returns an empty array E[].
662 I know it is bad, if you find a method to instantiate a generic Array,
663 tell me
664<P>
665<DD><DL>
666</DL>
667</DD>
668<DD><DL>
669<DT><B>Parameters:</B><DD><CODE>size</CODE> - the size of the array
670<DT><B>Returns:</B><DD>the empty array</DL>
671</DD>
672</DL>
673<HR>
674
675<A NAME="getActions()"><!-- --></A><H3>
676getActions</H3>
677<PRE>
678public <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="type parameter in JEditActionSet">E</A>[] <B>getActions</B>()</PRE>
679<DL>
680<DD>Returns an array of all actions in this action set.<p>
681
682 <b>Deferred loading:</b> this will load the action set if necessary.
683<P>
684<DD><DL>
685</DL>
686</DD>
687<DD><DL>
688<DT><B>Since:</B></DT>
689  <DD>jEdit 4.0pre1</DD>
690</DL>
691</DD>
692</DL>
693<HR>
694
695<A NAME="contains(java.lang.String)"><!-- --></A><H3>
696contains</H3>
697<PRE>
698public boolean <B>contains</B>(java.lang.String&nbsp;action)</PRE>
699<DL>
700<DD>Returns if this action set contains the specified action.
701<P>
702<DD><DL>
703</DL>
704</DD>
705<DD><DL>
706<DT><B>Parameters:</B><DD><CODE>action</CODE> - The action<DT><B>Since:</B></DT>
707  <DD>jEdit 4.2pre1</DD>
708</DL>
709</DD>
710</DL>
711<HR>
712
713<A NAME="size()"><!-- --></A><H3>
714size</H3>
715<PRE>
716public int <B>size</B>()</PRE>
717<DL>
718<DD>Returns the number of actions in this action set.
719<P>
720<DD><DL>
721</DL>
722</DD>
723<DD><DL>
724<DT><B>Since:</B></DT>
725  <DD>jEdit 4.2pre2</DD>
726</DL>
727</DD>
728</DL>
729<HR>
730
731<A NAME="load()"><!-- --></A><H3>
732load</H3>
733<PRE>
734public void <B>load</B>()</PRE>
735<DL>
736<DD>Forces the action set to be loaded. Plugins and macros should not
737 call this method.
738<P>
739<DD><DL>
740</DL>
741</DD>
742<DD><DL>
743<DT><B>Since:</B></DT>
744  <DD>jEdit 4.2pre1</DD>
745</DL>
746</DD>
747</DL>
748<HR>
749
750<A NAME="createBeanShellAction(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)"><!-- --></A><H3>
751createBeanShellAction</H3>
752<PRE>
753protected abstract <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A> <B>createBeanShellAction</B>(java.lang.String&nbsp;actionName,
754                                                                 java.lang.String&nbsp;code,
755                                                                 java.lang.String&nbsp;selected,
756                                                                 boolean&nbsp;noRepeat,
757                                                                 boolean&nbsp;noRecord,
758                                                                 boolean&nbsp;noRememberLast)</PRE>
759<DL>
760<DD>This method should be implemented to return an action that will execute
761 the given code
762<P>
763<DD><DL>
764</DL>
765</DD>
766<DD><DL>
767<DT><B>Since:</B></DT>
768  <DD>4.3pre13</DD>
769</DL>
770</DD>
771</DL>
772<HR>
773
774<A NAME="initKeyBindings()"><!-- --></A><H3>
775initKeyBindings</H3>
776<PRE>
777public void <B>initKeyBindings</B>()</PRE>
778<DL>
779<DD>Initializes the action set's key bindings.
780 jEdit calls this method for all registered action sets when the
781 user changes key bindings in the <b>Global Options</b> dialog box.<p>
782
783 Note if your plugin adds a custom action set to jEdit's collection,
784 it must also call this method on the action set after adding it.
785<P>
786<DD><DL>
787</DL>
788</DD>
789<DD><DL>
790<DT><B>Since:</B></DT>
791  <DD>jEdit 4.2pre1</DD>
792</DL>
793</DD>
794</DL>
795<HR>
796
797<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
798getProperty</H3>
799<PRE>
800protected abstract java.lang.String <B>getProperty</B>(java.lang.String&nbsp;name)</PRE>
801<DL>
802<DD>Returns a property for the given name.
803 In jEdit it will returns a jEdit.getProperty(name), but it can
804 return something else for a standalone textarea.
805<P>
806<DD><DL>
807</DL>
808</DD>
809<DD><DL>
810<DT><B>Parameters:</B><DD><CODE>name</CODE> - the property name
811<DT><B>Returns:</B><DD>the property value<DT><B>Since:</B></DT>
812  <DD>4.3pre13</DD>
813</DL>
814</DD>
815</DL>
816<!-- ========= END OF CLASS DATA ========= -->
817<HR>
818
819
820<!-- ======= START OF BOTTOM NAVBAR ====== -->
821<A NAME="navbar_bottom"><!-- --></A>
822<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
823<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
824<TR>
825<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
826<A NAME="navbar_bottom_firstrow"><!-- --></A>
827<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
828  <TR ALIGN="center" VALIGN="top">
829  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
830  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
831  <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
832  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JEditActionSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
833  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
834  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
835  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
836  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
837  </TR>
838</TABLE>
839</TD>
840<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
841</EM>
842</TD>
843</TR>
844
845<TR>
846<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
847&nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditActionContext.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A>&nbsp;
848&nbsp;<A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD>
849<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
850  <A HREF="../../../../index.html?org/gjt/sp/jedit/JEditActionSet.html" target="_top"><B>FRAMES</B></A>  &nbsp;
851&nbsp;<A HREF="JEditActionSet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
852&nbsp;
853<NOSCRIPT>
854  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
855</NOSCRIPT>
856
857
858</FONT></TD>
859</TR>
860<TR>
861<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
862  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
863<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
864DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
865</TR>
866</TABLE>
867<A NAME="skip-navbar_bottom"></A>
868<!-- ======== END OF BOTTOM NAVBAR ======= -->
869
870<HR>
871
872</BODY>
873</HTML>