| <!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.6.0_04) on Mon Dec 15 08:38:53 PST 2008 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <TITLE> | |
| EventCartridge (Apache Velocity 1.6.1 API) | |
| </TITLE> | |
| <META NAME="date" CONTENT="2008-12-15"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| if (location.href.indexOf('is-external=true') == -1) { | |
| parent.document.title="EventCartridge (Apache Velocity 1.6.1 API)"; | |
| } | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <HR> | |
| <!-- ========= 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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EventCartridge.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-all.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"> | |
| PREV CLASS | |
| <A HREF="../../../../../org/apache/velocity/app/event/EventHandler.html" title="interface in org.apache.velocity.app.event"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/app/event/EventCartridge.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="EventCartridge.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <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 | 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.apache.velocity.app.event</FONT> | |
| <BR> | |
| Class EventCartridge</H2> | |
| <PRE> | |
| <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.app.event.EventCartridge</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>EventCartridge</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> | |
| </PRE> | |
| <P> | |
| Stores the event handlers. Event handlers can be assigned on a per | |
| VelocityEngine instance basis by specifying the class names in the | |
| velocity.properties file. Event handlers may also be assigned on a per-page | |
| basis by creating a new instance of EventCartridge, adding the event | |
| handlers, and then calling attachToContext. For clarity, it's recommended | |
| that one approach or the other be followed, as the second method is primarily | |
| presented for backwards compatibility. | |
| <P> | |
| Note that Event Handlers follow a filter pattern, with multiple event | |
| handlers allowed for each event. When the appropriate event occurs, all the | |
| appropriate event handlers are called in the sequence they were added to the | |
| Event Cartridge. See the javadocs of the specific event handler interfaces | |
| for more details. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: EventCartridge.java 685685 2008-08-13 21:43:27Z nbubna $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD><a href="mailto:wglass@wglass@forio.com">Will Glass-Husain </a>, <a href="mailto:geirm@optonline.net">Geir Magnusson Jr. </a>, <a href="mailto:j_a_fernandez@yahoo.com">Jose Alberto Fernandez </a></DD> | |
| </DL> | |
| <HR> | |
| <P> | |
| <!-- ======== 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/apache/velocity/app/event/EventCartridge.html#EventCartridge()">EventCartridge</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> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/app/event/EventCartridge.html#addEventHandler(org.apache.velocity.app.event.EventHandler)">addEventHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/EventHandler.html" title="interface in org.apache.velocity.app.event">EventHandler</A> ev)</CODE> | |
| <BR> | |
| Adds an event handler(s) to the Cartridge.</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/apache/velocity/app/event/EventCartridge.html#addIncludeEventHandler(org.apache.velocity.app.event.IncludeEventHandler)">addIncludeEventHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/IncludeEventHandler.html" title="interface in org.apache.velocity.app.event">IncludeEventHandler</A> ev)</CODE> | |
| <BR> | |
| Add an include event handler to the Cartridge.</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/apache/velocity/app/event/EventCartridge.html#addInvalidReferenceEventHandler(org.apache.velocity.app.event.InvalidReferenceEventHandler)">addInvalidReferenceEventHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/InvalidReferenceEventHandler.html" title="interface in org.apache.velocity.app.event">InvalidReferenceEventHandler</A> ev)</CODE> | |
| <BR> | |
| Add an invalid reference event handler to the Cartridge.</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/apache/velocity/app/event/EventCartridge.html#addMethodExceptionHandler(org.apache.velocity.app.event.MethodExceptionEventHandler)">addMethodExceptionHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/MethodExceptionEventHandler.html" title="interface in org.apache.velocity.app.event">MethodExceptionEventHandler</A> ev)</CODE> | |
| <BR> | |
| Add a method exception event handler to the Cartridge.</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/apache/velocity/app/event/EventCartridge.html#addNullSetEventHandler(org.apache.velocity.app.event.NullSetEventHandler)">addNullSetEventHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/NullSetEventHandler.html" title="interface in org.apache.velocity.app.event">NullSetEventHandler</A> ev)</CODE> | |
| <BR> | |
| Add a null set event handler to the Cartridge.</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/apache/velocity/app/event/EventCartridge.html#addReferenceInsertionEventHandler(org.apache.velocity.app.event.ReferenceInsertionEventHandler)">addReferenceInsertionEventHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/ReferenceInsertionEventHandler.html" title="interface in org.apache.velocity.app.event">ReferenceInsertionEventHandler</A> ev)</CODE> | |
| <BR> | |
| Add a reference insertion event handler to the Cartridge.</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/apache/velocity/app/event/EventCartridge.html#attachToContext(org.apache.velocity.context.Context)">attachToContext</A></B>(<A HREF="../../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</A> context)</CODE> | |
| <BR> | |
| Attached the EventCartridge to the context | |
| Final because not something one should mess with lightly :)</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/app/event/EventCartridge.html#getIncludeEventHandlers()">getIncludeEventHandlers</A></B>()</CODE> | |
| <BR> | |
| Iterate through all the stored IncludeEventHandlers objects</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/app/event/EventCartridge.html#getInvalidReferenceEventHandlers()">getInvalidReferenceEventHandlers</A></B>()</CODE> | |
| <BR> | |
| Iterate through all the stored InvalidReferenceEventHandlers objects</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/app/event/EventCartridge.html#getMethodExceptionEventHandlers()">getMethodExceptionEventHandlers</A></B>()</CODE> | |
| <BR> | |
| Iterate through all the stored MethodExceptionEventHandler objects</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/app/event/EventCartridge.html#getNullSetEventHandlers()">getNullSetEventHandlers</A></B>()</CODE> | |
| <BR> | |
| Iterate through all the stored NullSetEventHandler objects</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/app/event/EventCartridge.html#getReferenceInsertionEventHandlers()">getReferenceInsertionEventHandlers</A></B>()</CODE> | |
| <BR> | |
| Iterate through all the stored ReferenceInsertionEventHandler objects</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/apache/velocity/app/event/EventCartridge.html#initialize(org.apache.velocity.runtime.RuntimeServices)">initialize</A></B>(<A HREF="../../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</A> rs)</CODE> | |
| <BR> | |
| Initialize the handlers.</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/apache/velocity/app/event/EventCartridge.html#removeEventHandler(org.apache.velocity.app.event.EventHandler)">removeEventHandler</A></B>(<A HREF="../../../../../org/apache/velocity/app/event/EventHandler.html" title="interface in org.apache.velocity.app.event">EventHandler</A> ev)</CODE> | |
| <BR> | |
| Removes an event handler(s) from the Cartridge.</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.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></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="EventCartridge()"><!-- --></A><H3> | |
| EventCartridge</H3> | |
| <PRE> | |
| public <B>EventCartridge</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="addEventHandler(org.apache.velocity.app.event.EventHandler)"><!-- --></A><H3> | |
| addEventHandler</H3> | |
| <PRE> | |
| public boolean <B>addEventHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/EventHandler.html" title="interface in org.apache.velocity.app.event">EventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Adds an event handler(s) to the Cartridge. This method | |
| will find all possible event handler interfaces supported | |
| by the passed in object. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - object impementing a valid EventHandler-derived interface | |
| <DT><B>Returns:</B><DD>true if a supported interface, false otherwise or if null</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addReferenceInsertionEventHandler(org.apache.velocity.app.event.ReferenceInsertionEventHandler)"><!-- --></A><H3> | |
| addReferenceInsertionEventHandler</H3> | |
| <PRE> | |
| public void <B>addReferenceInsertionEventHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/ReferenceInsertionEventHandler.html" title="interface in org.apache.velocity.app.event">ReferenceInsertionEventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Add a reference insertion event handler to the Cartridge. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - ReferenceInsertionEventHandler<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addNullSetEventHandler(org.apache.velocity.app.event.NullSetEventHandler)"><!-- --></A><H3> | |
| addNullSetEventHandler</H3> | |
| <PRE> | |
| public void <B>addNullSetEventHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/NullSetEventHandler.html" title="interface in org.apache.velocity.app.event">NullSetEventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Add a null set event handler to the Cartridge. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - NullSetEventHandler<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addMethodExceptionHandler(org.apache.velocity.app.event.MethodExceptionEventHandler)"><!-- --></A><H3> | |
| addMethodExceptionHandler</H3> | |
| <PRE> | |
| public void <B>addMethodExceptionHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/MethodExceptionEventHandler.html" title="interface in org.apache.velocity.app.event">MethodExceptionEventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Add a method exception event handler to the Cartridge. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - MethodExceptionEventHandler<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addIncludeEventHandler(org.apache.velocity.app.event.IncludeEventHandler)"><!-- --></A><H3> | |
| addIncludeEventHandler</H3> | |
| <PRE> | |
| public void <B>addIncludeEventHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/IncludeEventHandler.html" title="interface in org.apache.velocity.app.event">IncludeEventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Add an include event handler to the Cartridge. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - IncludeEventHandler<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addInvalidReferenceEventHandler(org.apache.velocity.app.event.InvalidReferenceEventHandler)"><!-- --></A><H3> | |
| addInvalidReferenceEventHandler</H3> | |
| <PRE> | |
| public void <B>addInvalidReferenceEventHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/InvalidReferenceEventHandler.html" title="interface in org.apache.velocity.app.event">InvalidReferenceEventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Add an invalid reference event handler to the Cartridge. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - InvalidReferenceEventHandler<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="removeEventHandler(org.apache.velocity.app.event.EventHandler)"><!-- --></A><H3> | |
| removeEventHandler</H3> | |
| <PRE> | |
| public boolean <B>removeEventHandler</B>(<A HREF="../../../../../org/apache/velocity/app/event/EventHandler.html" title="interface in org.apache.velocity.app.event">EventHandler</A> ev)</PRE> | |
| <DL> | |
| <DD>Removes an event handler(s) from the Cartridge. This method will find all | |
| possible event handler interfaces supported by the passed in object and | |
| remove them. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>ev</CODE> - object impementing a valid EventHandler-derived interface | |
| <DT><B>Returns:</B><DD>true if event handler was previously registered, false if not | |
| found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getReferenceInsertionEventHandlers()"><!-- --></A><H3> | |
| getReferenceInsertionEventHandlers</H3> | |
| <PRE> | |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getReferenceInsertionEventHandlers</B>()</PRE> | |
| <DL> | |
| <DD>Iterate through all the stored ReferenceInsertionEventHandler objects | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>iterator of handler objects, null if there are not handlers<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNullSetEventHandlers()"><!-- --></A><H3> | |
| getNullSetEventHandlers</H3> | |
| <PRE> | |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getNullSetEventHandlers</B>()</PRE> | |
| <DL> | |
| <DD>Iterate through all the stored NullSetEventHandler objects | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>iterator of handler objects<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getMethodExceptionEventHandlers()"><!-- --></A><H3> | |
| getMethodExceptionEventHandlers</H3> | |
| <PRE> | |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getMethodExceptionEventHandlers</B>()</PRE> | |
| <DL> | |
| <DD>Iterate through all the stored MethodExceptionEventHandler objects | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>iterator of handler objects<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getIncludeEventHandlers()"><!-- --></A><H3> | |
| getIncludeEventHandlers</H3> | |
| <PRE> | |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getIncludeEventHandlers</B>()</PRE> | |
| <DL> | |
| <DD>Iterate through all the stored IncludeEventHandlers objects | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>iterator of handler objects</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getInvalidReferenceEventHandlers()"><!-- --></A><H3> | |
| getInvalidReferenceEventHandlers</H3> | |
| <PRE> | |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getInvalidReferenceEventHandlers</B>()</PRE> | |
| <DL> | |
| <DD>Iterate through all the stored InvalidReferenceEventHandlers objects | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>iterator of handler objects<DT><B>Since:</B></DT> | |
| <DD>1.5</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="attachToContext(org.apache.velocity.context.Context)"><!-- --></A><H3> | |
| attachToContext</H3> | |
| <PRE> | |
| public final boolean <B>attachToContext</B>(<A HREF="../../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Attached the EventCartridge to the context | |
| Final because not something one should mess with lightly :) | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - context to attach to | |
| <DT><B>Returns:</B><DD>true if successful, false otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="initialize(org.apache.velocity.runtime.RuntimeServices)"><!-- --></A><H3> | |
| initialize</H3> | |
| <PRE> | |
| public void <B>initialize</B>(<A HREF="../../../../../org/apache/velocity/runtime/RuntimeServices.html" title="interface in org.apache.velocity.runtime">RuntimeServices</A> rs) | |
| throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> | |
| <DL> | |
| <DD>Initialize the handlers. For global handlers this is called when Velocity | |
| is initialized. For local handlers this is called when the first handler | |
| is executed. Handlers will not be initialized more than once. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>rs</CODE> - | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE><DT><B>Since:</B></DT> | |
| <DD>1.5</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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EventCartridge.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-all.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"> | |
| PREV CLASS | |
| <A HREF="../../../../../org/apache/velocity/app/event/EventHandler.html" title="interface in org.apache.velocity.app.event"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/app/event/EventCartridge.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="EventCartridge.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <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 | 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> | |
| Copyright © 2000-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
| </BODY> | |
| </HTML> |