/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/JEditBeanShellAction.html
HTML | 389 lines | 333 code | 43 blank | 13 comment | 0 complexity | 4e5f2fe89957d237109116c05cbb7582 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> 7JEditBeanShellAction (jEdit API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="org.gjt.sp.jedit.JEditBeanShellAction class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 13 14 15<NOSCRIPT> 16</NOSCRIPT> 17 18</HEAD> 19 20<BODY BGCOLOR="white" > 21 22 23<!-- ========= START OF TOP NAVBAR ======= --> 24<A NAME="navbar_top"><!-- --></A> 25<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 26<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 27<TR> 28<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 29<A NAME="navbar_top_firstrow"><!-- --></A> 30<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 31 <TR ALIGN="center" VALIGN="top"> 32 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 33 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 34 <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JEditBeanShellAction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 40 </TR> 41</TABLE> 42</TD> 43<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 44</EM> 45</TD> 46</TR> 47 48<TR> 49<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 50 <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A> 51 <A HREF="../../../../org/gjt/sp/jedit/Macros.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/JEditBeanShellAction.html" target="_top"><B>FRAMES</B></A> 54 <A HREF="JEditBeanShellAction.html" target="_top"><B>NO FRAMES</B></A> 55 56<NOSCRIPT> 57 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 58</NOSCRIPT> 59 60 61</FONT></TD> 62</TR> 63<TR> 64<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 65 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.gjt.sp.jedit.JEditAbstractEditAction">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 66<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 67DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 68</TR> 69</TABLE> 70<A NAME="skip-navbar_top"></A> 71<!-- ========= END OF TOP NAVBAR ========= --> 72 73<HR> 74<!-- ======== START OF CLASS DATA ======== --> 75<H2> 76<FONT SIZE="-1"> 77org.gjt.sp.jedit</FONT> 78<BR> 79Class JEditBeanShellAction</H2> 80<PRE> 81java.lang.Object 82 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">org.gjt.sp.jedit.JEditAbstractEditAction</A><<A HREF="../../../../org/gjt/sp/jedit/textarea/TextArea.html" title="class in org.gjt.sp.jedit.textarea">TextArea</A>> 83 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.JEditBeanShellAction</B> 84</PRE> 85<HR> 86<DL> 87<DT><PRE>public class <B>JEditBeanShellAction</B><DT>extends <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A><<A HREF="../../../../org/gjt/sp/jedit/textarea/TextArea.html" title="class in org.gjt.sp.jedit.textarea">TextArea</A>></DL> 88</PRE> 89 90<P> 91An action that evaluates BeanShell code when invoked. BeanShell actions are 92 usually loaded from <code>actions.xml</code> and 93 <code>browser.actions.xml</code> files; see <A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit"><CODE>ActionSet</CODE></A> for syntax 94 information. 95<P> 96 97<P> 98<DL> 99<DT><B>See Also:</B><DD><A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getAction(java.lang.String)"><CODE>jEdit.getAction(String)</CODE></A>, 100<A HREF="../../../../org/gjt/sp/jedit/jEdit.html#getActionNames()"><CODE>jEdit.getActionNames()</CODE></A>, 101<A HREF="../../../../org/gjt/sp/jedit/ActionSet.html" title="class in org.gjt.sp.jedit"><CODE>ActionSet</CODE></A></DL> 102<HR> 103 104<P> 105<!-- =========== FIELD SUMMARY =========== --> 106 107<A NAME="field_summary"><!-- --></A> 108<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 109<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 110<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 111<B>Field Summary</B></FONT></TH> 112</TR> 113</TABLE> 114 <A NAME="fields_inherited_from_class_org.gjt.sp.jedit.JEditAbstractEditAction"><!-- --></A> 115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 116<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 117<TH ALIGN="left"><B>Fields inherited from class org.gjt.sp.jedit.<A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A></B></TH> 118</TR> 119<TR BGCOLOR="white" CLASS="TableRowColor"> 120<TD><CODE><A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#args">args</A>, <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#name">name</A></CODE></TD> 121</TR> 122</TABLE> 123 124<!-- ======== CONSTRUCTOR SUMMARY ======== --> 125 126<A NAME="constructor_summary"><!-- --></A> 127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 129<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 130<B>Constructor Summary</B></FONT></TH> 131</TR> 132<TR BGCOLOR="white" CLASS="TableRowColor"> 133<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#JEditBeanShellAction(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)">JEditBeanShellAction</A></B>(java.lang.String name, 134 java.lang.String code, 135 java.lang.String isSelected, 136 boolean noRepeat, 137 boolean noRecord, 138 boolean noRememberLast)</CODE> 139 140<BR> 141 </TD> 142</TR> 143</TABLE> 144 145<!-- ========== METHOD SUMMARY =========== --> 146 147<A NAME="method_summary"><!-- --></A> 148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 149<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 150<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 151<B>Method Summary</B></FONT></TH> 152</TR> 153<TR BGCOLOR="white" CLASS="TableRowColor"> 154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 155<CODE> java.lang.String</CODE></FONT></TD> 156<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#getCode()">getCode</A></B>()</CODE> 157 158<BR> 159 </TD> 160</TR> 161<TR BGCOLOR="white" CLASS="TableRowColor"> 162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 163<CODE> void</CODE></FONT></TD> 164<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#invoke(org.gjt.sp.jedit.textarea.TextArea)">invoke</A></B>(<A HREF="../../../../org/gjt/sp/jedit/textarea/TextArea.html" title="class in org.gjt.sp.jedit.textarea">TextArea</A> textArea)</CODE> 165 166<BR> 167 Invokes the action.</TD> 168</TR> 169<TR BGCOLOR="white" CLASS="TableRowColor"> 170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 171<CODE> boolean</CODE></FONT></TD> 172<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#isSelected(java.awt.Component)">isSelected</A></B>(java.awt.Component comp)</CODE> 173 174<BR> 175 </TD> 176</TR> 177<TR BGCOLOR="white" CLASS="TableRowColor"> 178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 179<CODE> boolean</CODE></FONT></TD> 180<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#noRecord()">noRecord</A></B>()</CODE> 181 182<BR> 183 </TD> 184</TR> 185<TR BGCOLOR="white" CLASS="TableRowColor"> 186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 187<CODE> boolean</CODE></FONT></TD> 188<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#noRememberLast()">noRememberLast</A></B>()</CODE> 189 190<BR> 191 Returns if this edit action should not be remembered as the most 192 recently invoked action.</TD> 193</TR> 194<TR BGCOLOR="white" CLASS="TableRowColor"> 195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 196<CODE> boolean</CODE></FONT></TD> 197<TD><CODE><B><A HREF="../../../../org/gjt/sp/jedit/JEditBeanShellAction.html#noRepeat()">noRepeat</A></B>()</CODE> 198 199<BR> 200 </TD> 201</TR> 202</TABLE> 203 <A NAME="methods_inherited_from_class_org.gjt.sp.jedit.JEditAbstractEditAction"><!-- --></A> 204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 205<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 206<TH ALIGN="left"><B>Methods inherited from class org.gjt.sp.jedit.<A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A></B></TH> 207</TR> 208<TR BGCOLOR="white" CLASS="TableRowColor"> 209<TD><CODE><A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#getName()">getName</A>, <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#invoke(E, java.lang.Object[])">invoke</A>, <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#toString()">toString</A></CODE></TD> 210</TR> 211</TABLE> 212 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 214<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 215<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 216</TR> 217<TR BGCOLOR="white" CLASS="TableRowColor"> 218<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> 219</TR> 220</TABLE> 221 222<P> 223 224<!-- ========= CONSTRUCTOR DETAIL ======== --> 225 226<A NAME="constructor_detail"><!-- --></A> 227<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 228<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 229<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 230<B>Constructor Detail</B></FONT></TH> 231</TR> 232</TABLE> 233 234<A NAME="JEditBeanShellAction(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, boolean)"><!-- --></A><H3> 235JEditBeanShellAction</H3> 236<PRE> 237public <B>JEditBeanShellAction</B>(java.lang.String name, 238 java.lang.String code, 239 java.lang.String isSelected, 240 boolean noRepeat, 241 boolean noRecord, 242 boolean noRememberLast)</PRE> 243<DL> 244</DL> 245 246<!-- ============ METHOD DETAIL ========== --> 247 248<A NAME="method_detail"><!-- --></A> 249<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 250<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 251<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 252<B>Method Detail</B></FONT></TH> 253</TR> 254</TABLE> 255 256<A NAME="invoke(org.gjt.sp.jedit.textarea.TextArea)"><!-- --></A><H3> 257invoke</H3> 258<PRE> 259public void <B>invoke</B>(<A HREF="../../../../org/gjt/sp/jedit/textarea/TextArea.html" title="class in org.gjt.sp.jedit.textarea">TextArea</A> textArea)</PRE> 260<DL> 261<DD><B>Description copied from class: <CODE><A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#invoke(E)">JEditAbstractEditAction</A></CODE></B></DD> 262<DD>Invokes the action. This is an implementation of the Command pattern, 263 and concrete actions should override this. 264<P> 265<DD><DL> 266<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html#invoke(E)">invoke</A></CODE> in class <CODE><A HREF="../../../../org/gjt/sp/jedit/JEditAbstractEditAction.html" title="class in org.gjt.sp.jedit">JEditAbstractEditAction</A><<A HREF="../../../../org/gjt/sp/jedit/textarea/TextArea.html" title="class in org.gjt.sp.jedit.textarea">TextArea</A>></CODE></DL> 267</DD> 268<DD><DL> 269<DT><B>Parameters:</B><DD><CODE>textArea</CODE> - the argument</DL> 270</DD> 271</DL> 272<HR> 273 274<A NAME="isSelected(java.awt.Component)"><!-- --></A><H3> 275isSelected</H3> 276<PRE> 277public boolean <B>isSelected</B>(java.awt.Component comp)</PRE> 278<DL> 279<DD><DL> 280</DL> 281</DD> 282</DL> 283<HR> 284 285<A NAME="noRepeat()"><!-- --></A><H3> 286noRepeat</H3> 287<PRE> 288public boolean <B>noRepeat</B>()</PRE> 289<DL> 290<DD><DL> 291</DL> 292</DD> 293</DL> 294<HR> 295 296<A NAME="noRecord()"><!-- --></A><H3> 297noRecord</H3> 298<PRE> 299public boolean <B>noRecord</B>()</PRE> 300<DL> 301<DD><DL> 302</DL> 303</DD> 304</DL> 305<HR> 306 307<A NAME="noRememberLast()"><!-- --></A><H3> 308noRememberLast</H3> 309<PRE> 310public boolean <B>noRememberLast</B>()</PRE> 311<DL> 312<DD>Returns if this edit action should not be remembered as the most 313 recently invoked action. 314<P> 315<DD><DL> 316<DT><B>Since:</B></DT> 317 <DD>jEdit 4.2pre1</DD> 318</DL> 319</DD> 320</DL> 321<HR> 322 323<A NAME="getCode()"><!-- --></A><H3> 324getCode</H3> 325<PRE> 326public java.lang.String <B>getCode</B>()</PRE> 327<DL> 328<DD><DL> 329</DL> 330</DD> 331</DL> 332<!-- ========= END OF CLASS DATA ========= --> 333<HR> 334 335 336<!-- ======= START OF BOTTOM NAVBAR ====== --> 337<A NAME="navbar_bottom"><!-- --></A> 338<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 339<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 340<TR> 341<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 342<A NAME="navbar_bottom_firstrow"><!-- --></A> 343<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 344 <TR ALIGN="center" VALIGN="top"> 345 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 347 <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JEditBeanShellAction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 350 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 351 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 352 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 353 </TR> 354</TABLE> 355</TD> 356<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 357</EM> 358</TD> 359</TR> 360 361<TR> 362<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 363 <A HREF="../../../../org/gjt/sp/jedit/JEditActionSet.html" title="class in org.gjt.sp.jedit"><B>PREV CLASS</B></A> 364 <A HREF="../../../../org/gjt/sp/jedit/Macros.html" title="class in org.gjt.sp.jedit"><B>NEXT CLASS</B></A></FONT></TD> 365<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 366 <A HREF="../../../../index.html?org/gjt/sp/jedit/JEditBeanShellAction.html" target="_top"><B>FRAMES</B></A> 367 <A HREF="JEditBeanShellAction.html" target="_top"><B>NO FRAMES</B></A> 368 369<NOSCRIPT> 370 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 371</NOSCRIPT> 372 373 374</FONT></TD> 375</TR> 376<TR> 377<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 378 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.gjt.sp.jedit.JEditAbstractEditAction">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 379<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 380DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 381</TR> 382</TABLE> 383<A NAME="skip-navbar_bottom"></A> 384<!-- ======== END OF BOTTOM NAVBAR ======= --> 385 386<HR> 387 388</BODY> 389</HTML>