| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!-- saved from url=(0014)about:internet --> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_19) on Sun Mar 20 20:56:07 PKT 2011 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <TITLE> | |
| ClickUtils (Click Framework API - v2.3.0) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.click.util.ClickUtils class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ClickUtils (Click Framework API - v2.3.0)"; | |
| } | |
| </SCRIPT> | |
| <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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </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"> | |
| <A HREF="../../../../org/apache/click/util/Bindable.html" title="annotation in org.apache.click.util"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/click/util/ContainerUtils.html" title="class in org.apache.click.util"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/click/util/ClickUtils.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ClickUtils.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 | <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.apache.click.util</FONT> | |
| <BR> | |
| Class ClickUtils</H2> | |
| <PRE> | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.click.util.ClickUtils</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ClickUtils</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> | |
| </PRE> | |
| <P> | |
| Provides miscellaneous Form, String and Stream utility methods. | |
| <P> | |
| <P> | |
| <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>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#DEFAULT_APP_CONFIG">DEFAULT_APP_CONFIG</A></B></CODE> | |
| <BR> | |
| The default Click configuration filename: | |
| "<tt>/WEB-INF/click.xml</tt>".</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#ENABLE_RESOURCE_VERSION">ENABLE_RESOURCE_VERSION</A></B></CODE> | |
| <BR> | |
| The resource <tt>versioning</tt> request attribute: key: | |
| <tt>enable-resource-version</tt>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#RESOURCE_VERSION_INDICATOR">RESOURCE_VERSION_INDICATOR</A></B></CODE> | |
| <BR> | |
| The static web resource version number indicator string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#VERSION_INDICATOR_SEP">VERSION_INDICATOR_SEP</A></B></CODE> | |
| <BR> | |
| The version indicator separator string.</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/apache/click/util/ClickUtils.html#ClickUtils()">ClickUtils</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#autoPostRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.util.Map, boolean)">autoPostRedirect</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><?,?> params, | |
| boolean compress)</CODE> | |
| <BR> | |
| Perform an auto post redirect to the specified target using the given | |
| response.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.AbstractLink)">bind</A></B>(<A HREF="../../../../org/apache/click/control/AbstractLink.html" title="class in org.apache.click.control">AbstractLink</A> link)</CODE> | |
| <BR> | |
| A helper method that binds the submitted request value to the Link's | |
| value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.Container)">bind</A></B>(<A HREF="../../../../org/apache/click/control/Container.html" title="interface in org.apache.click.control">Container</A> container)</CODE> | |
| <BR> | |
| A helper method that binds the submitted request values of all Fields | |
| and Links inside the given container or child containers.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.Field)">bind</A></B>(<A HREF="../../../../org/apache/click/control/Field.html" title="class in org.apache.click.control">Field</A> field)</CODE> | |
| <BR> | |
| A helper method that binds the submitted request value to the Field's | |
| value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#bindAndValidate(org.apache.click.control.Container)">bindAndValidate</A></B>(<A HREF="../../../../org/apache/click/control/Container.html" title="interface in org.apache.click.control">Container</A> container)</CODE> | |
| <BR> | |
| A helper method that binds and validates the submitted request values | |
| of all Fields and Links inside the given container or child containers.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#bindAndValidate(org.apache.click.control.Field)">bindAndValidate</A></B>(<A HREF="../../../../org/apache/click/control/Field.html" title="class in org.apache.click.control">Field</A> field)</CODE> | |
| <BR> | |
| A helper method that binds and validates the Field's submitted request | |
| value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#bindAndValidate(org.apache.click.control.Form)">bindAndValidate</A></B>(<A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form)</CODE> | |
| <BR> | |
| * A helper method that binds and validates the submitted request values | |
| of all Fields and Links inside the given Form or child containers.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#buildDocument(java.io.InputStream)">buildDocument</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> inputStream)</CODE> | |
| <BR> | |
| Return a new XML Document for the given input stream.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#buildDocument(java.io.InputStream, org.xml.sax.EntityResolver)">buildDocument</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> inputStream, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/EntityResolver.html" title="class or interface in org.xml.sax">EntityResolver</A> entityResolver)</CODE> | |
| <BR> | |
| Return a new XML Document for the given input stream and XML entity | |
| resolver.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#canBind(org.apache.click.Control, org.apache.click.Context)">canBind</A></B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Return true if the given control's request value can be bound, false | |
| otherwise.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#classForName(java.lang.String)">classForName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> classname)</CODE> | |
| <BR> | |
| Returns the <code>Class</code> object associated with the class or | |
| interface with the given string name, using the current Thread context | |
| class loader.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#close(java.io.Closeable)">close</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Closeable.html" title="class or interface in java.io">Closeable</A> closeable)</CODE> | |
| <BR> | |
| Close the given closeable (Reader, Writer, Stream) and ignore any | |
| exceptions thrown.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#copyFormToObject(org.apache.click.control.Form, java.lang.Object, boolean)">copyFormToObject</A></B>(<A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object, | |
| boolean debug)</CODE> | |
| <BR> | |
| Populate the given object's attributes with the Form's field values.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#copyObjectToForm(java.lang.Object, org.apache.click.control.Form, boolean)">copyObjectToForm</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object, | |
| <A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form, | |
| boolean debug)</CODE> | |
| <BR> | |
| Populate the given Form field values with the object's attributes.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#createTemplateModel(org.apache.click.Page, org.apache.click.Context)">createTemplateModel</A></B>(<A HREF="../../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A> page, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Creates a template model of key/value pairs which can be used by template | |
| engines such as Velocity and Freemarker.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#decode(java.lang.String)">decode</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> string)</CODE> | |
| <BR> | |
| Return an object from the <A HREF="../../../../org/apache/click/util/ClickUtils.html#encode(java.lang.Object)"><CODE>encode(Object)</CODE></A> string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#decodePasswordCookie(java.lang.String, int)">decodePasswordCookie</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieVal, | |
| int xorMask)</CODE> | |
| <BR> | |
| Decodes a cookie string containing a username and password.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#decodePasswordCookie(java.lang.String, java.lang.String, int)">decodePasswordCookie</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieVal, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> encoding, | |
| int xorMask)</CODE> | |
| <BR> | |
| Decodes a cookie string containing a username and password.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#decodeURL(java.lang.Object)">decodeURL</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> value)</CODE> | |
| <BR> | |
| URL decode the specified value using the "UTF-8" encoding scheme.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#deployFile(javax.servlet.ServletContext, java.lang.String, java.lang.String)">deployFile</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> resource, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> targetDir)</CODE> | |
| <BR> | |
| Deploy the specified classpath resource to the given target directory | |
| under the web application root directory.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#deployFileList(javax.servlet.ServletContext, java.lang.Class, java.lang.String)">deployFileList</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><? extends <A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A>> controlClass, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> targetDir)</CODE> | |
| <BR> | |
| Deploys required files (from a file list) for a control that repsects a specific convention.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#deployFiles(javax.servlet.ServletContext, java.lang.String[], java.lang.String)">deployFiles</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] resources, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> targetDir)</CODE> | |
| <BR> | |
| Deploy the specified classpath resources to the given target directory | |
| under the web application root directory.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#encode(java.lang.Object)">encode</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object)</CODE> | |
| <BR> | |
| Return an encoded version of the <tt>Serializable</tt> object.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#encodePasswordCookie(java.lang.String, java.lang.String, int)">encodePasswordCookie</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> username, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password, | |
| int xorMask)</CODE> | |
| <BR> | |
| Builds a cookie string containing a username and password.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#encodePasswordCookie(java.lang.String, java.lang.String, java.lang.String, int)">encodePasswordCookie</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> username, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> encoding, | |
| int xorMask)</CODE> | |
| <BR> | |
| Builds a cookie string containing a username and password, using offsets | |
| to customize the encoding.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#encodeURL(java.lang.Object)">encodeURL</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> value)</CODE> | |
| <BR> | |
| URL encode the specified value using the "UTF-8" encoding scheme.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#encodeUrl(java.lang.Object, org.apache.click.Context)">encodeUrl</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Return an encoded URL value for the given object using the context | |
| request character encoding or "UTF-8" if the request character encoding | |
| is not specified.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#escape(java.lang.String)">escape</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</CODE> | |
| <BR> | |
| Return an escaped string for the given string value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#escapeHtml(java.lang.String)">escapeHtml</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</CODE> | |
| <BR> | |
| Return a HTML escaped string for the given string value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getApplicationResourceVersionIndicator()">getApplicationResourceVersionIndicator</A></B>()</CODE> | |
| <BR> | |
| If resource versioning is active this method will return the | |
| application version indicator for static web resources | |
| (eg JavaScript and Css) otherwise this method will return an empty string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getApplicationVersion()">getApplicationVersion</A></B>()</CODE> | |
| <BR> | |
| Return the web application version string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/ResourceBundle.html" title="class or interface in java.util">ResourceBundle</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getBundle(java.lang.String)">getBundle</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> baseName)</CODE> | |
| <BR> | |
| Return a resource bundle using the specified base name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/ResourceBundle.html" title="class or interface in java.util">ResourceBundle</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getBundle(java.lang.String, java.util.Locale)">getBundle</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> baseName, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> locale)</CODE> | |
| <BR> | |
| Return a resource bundle using the specified base name and locale.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getChild(org.w3c.dom.Element, java.lang.String)">getChild</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A> parent, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
| <BR> | |
| Return the first XML child Element for the given parent Element and child | |
| Element name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getChildren(org.w3c.dom.Element, java.lang.String)">getChildren</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A> parent, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
| <BR> | |
| Return the list of XML child Element elements with the given name from | |
| the given parent Element.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getClickConfig(javax.servlet.ServletContext)">getClickConfig</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext)</CODE> | |
| <BR> | |
| Return the InputStream for the Click configuration file <tt>click.xml</tt>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getClickVersion()">getClickVersion</A></B>()</CODE> | |
| <BR> | |
| Return the Click Framework version string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../org/apache/click/service/ConfigService.html" title="interface in org.apache.click.service">ConfigService</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getConfigService(javax.servlet.ServletContext)">getConfigService</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext)</CODE> | |
| <BR> | |
| Return the application configuration service instance from the given | |
| servlet context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/Cookie.html" title="class or interface in javax.servlet.http">Cookie</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getCookie(javax.servlet.http.HttpServletRequest, java.lang.String)">getCookie</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
| <BR> | |
| Returns the specified Cookie object, or null if the cookie does not exist.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getCookieValue(javax.servlet.http.HttpServletRequest, java.lang.String)">getCookieValue</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
| <BR> | |
| Returns the value of the specified cookie as a String.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getCssSelector(org.apache.click.Control)">getCssSelector</A></B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</CODE> | |
| <BR> | |
| Return the given control CSS selector or null if no selector can be found.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/click/control/Field.html" title="class in org.apache.click.control">Field</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getFormFields(org.apache.click.control.Form)">getFormFields</A></B>(<A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form)</CODE> | |
| <BR> | |
| Return the list of Fields for the given Form, including any Fields | |
| contained in FieldSets.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../org/apache/click/service/LogService.html" title="interface in org.apache.click.service">LogService</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getLogService()">getLogService</A></B>()</CODE> | |
| <BR> | |
| Return the application LogService instance using thread local Context | |
| to perform the lookup.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getMimeType(java.lang.String)">getMimeType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</CODE> | |
| <BR> | |
| Return the mime-type or content-type for the given filename/extension.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getParentMessage(org.apache.click.Control, java.lang.String)">getParentMessage</A></B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
| <BR> | |
| Return the given control's top level parent's localized message for the | |
| specified name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getParentMessages(org.apache.click.Control)">getParentMessages</A></B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</CODE> | |
| <BR> | |
| Return the given control's top level parent's localized messages Map.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getParentPage(org.apache.click.Control)">getParentPage</A></B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</CODE> | |
| <BR> | |
| Get the parent page of the given control or null if the control has no | |
| parent.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getRequestParameterMap(javax.servlet.http.HttpServletRequest)">getRequestParameterMap</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</CODE> | |
| <BR> | |
| Return an ordered map of request parameters from the given request.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getRequestURI(javax.servlet.http.HttpServletRequest)">getRequestURI</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</CODE> | |
| <BR> | |
| Return the requestURI from the request.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URL.html" title="class or interface in java.net">URL</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getResource(java.lang.String, java.lang.Class)">getResource</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><?> aClass)</CODE> | |
| <BR> | |
| Finds a resource with a given name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getResourceAsStream(java.lang.String, java.lang.Class)">getResourceAsStream</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><?> aClass)</CODE> | |
| <BR> | |
| Finds a resource with a given name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getResourcePath(javax.servlet.http.HttpServletRequest)">getResourcePath</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</CODE> | |
| <BR> | |
| Return the page resource path from the request.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#getResourceVersionIndicator(org.apache.click.Context)">getResourceVersionIndicator</A></B>(<A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Return Click's version indicator for static web resources | |
| (eg css, js and image files) if resource versioning is active, | |
| otherwise this method will return an empty string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#hasRequestParameter(org.apache.click.Control)">hasRequestParameter</A></B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</CODE> | |
| <BR> | |
| Return true if the control has a submitted request value, false otherwise.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#invalidateCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)">invalidateCookie</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieName)</CODE> | |
| <BR> | |
| Invalidate the specified cookie and delete it from the response object.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#invalidateCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)">invalidateCookie</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieName, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> | |
| <BR> | |
| Invalidate the specified cookie and delete it from the response object.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../org/apache/click/ActionResult.html" title="class in org.apache.click">ActionResult</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#invokeAction(java.lang.Object, java.lang.String)">invokeAction</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> target, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> method)</CODE> | |
| <BR> | |
| Invoke the named method on the given target and return the Object result.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#invokeListener(java.lang.Object, java.lang.String)">invokeListener</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> listener, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> method)</CODE> | |
| <BR> | |
| Invoke the named method on the given object and return the boolean | |
| result.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#isAjaxRequest(javax.servlet.http.HttpServletRequest)">isAjaxRequest</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</CODE> | |
| <BR> | |
| Return true is this is an Ajax request, false otherwise.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#isEnableResourceVersion(org.apache.click.Context)">isEnableResourceVersion</A></B>(<A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Return true if static web content resource versioning is enabled.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#isMultipartRequest(javax.servlet.http.HttpServletRequest)">isMultipartRequest</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</CODE> | |
| <BR> | |
| Return true if the request is a multi-part content type POST request.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#isResourcesDeployable(javax.servlet.ServletContext)">isResourcesDeployable</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext)</CODE> | |
| <BR> | |
| Returns true if Click resources (JavaScript, CSS, images etc) packaged | |
| in jars can be deployed to the root directory of the webapp, false | |
| otherwise.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#limitLength(java.lang.String, int)">limitLength</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value, | |
| int maxlength)</CODE> | |
| <BR> | |
| Return the value string limited to maxlength characters.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#limitLength(java.lang.String, int, java.lang.String)">limitLength</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value, | |
| int maxlength, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> suffix)</CODE> | |
| <BR> | |
| Return the value string limited to maxlength characters.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#removeState(org.apache.click.Stateful, java.lang.String, org.apache.click.Context)">removeState</A></B>(<A HREF="../../../../org/apache/click/Stateful.html" title="interface in org.apache.click">Stateful</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> controlName, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Remove the control state from the session for the given stateful control, | |
| control name and request context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#restoreState(org.apache.click.Stateful, java.lang.String, org.apache.click.Context)">restoreState</A></B>(<A HREF="../../../../org/apache/click/Stateful.html" title="interface in org.apache.click">Stateful</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> controlName, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Restore the control state from the session for the given stateful control, | |
| control name and request context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#saveState(org.apache.click.Stateful, java.lang.String, org.apache.click.Context)">saveState</A></B>(<A HREF="../../../../org/apache/click/Stateful.html" title="interface in org.apache.click">Stateful</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> controlName, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</CODE> | |
| <BR> | |
| Save the control state in the session for the given stateful control, | |
| control name and request context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#setApplicationVersion(java.lang.String)">setApplicationVersion</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationVersion)</CODE> | |
| <BR> | |
| Set the web application version string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/Cookie.html" title="class or interface in javax.servlet.http">Cookie</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#setCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String, int, java.lang.String)">setCookie</A></B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value, | |
| int maxAge, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</CODE> | |
| <BR> | |
| Sets the given cookie values in the servlet response.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#toGetterName(java.lang.String)">toGetterName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> property)</CODE> | |
| <BR> | |
| Return the getter method name for the given property name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#toIsGetterName(java.lang.String)">toIsGetterName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> property)</CODE> | |
| <BR> | |
| Return the is getter method name for the given property name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#toLabel(java.lang.String)">toLabel</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
| <BR> | |
| Return a field label string from the given field name.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#toMD5Hash(java.lang.String)">toMD5Hash</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> plaintext)</CODE> | |
| <BR> | |
| Return an 32 char MD5 encoded string from the given plain text.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#toName(java.lang.String)">toName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> label)</CODE> | |
| <BR> | |
| Return a field name string from the given field label.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/click/util/ClickUtils.html#toSetterName(java.lang.String)">toSetterName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> property)</CODE> | |
| <BR> | |
| Return the setter method name for the given property name.</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.5.0/docs/api/java/lang/Object.html" 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.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</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="ENABLE_RESOURCE_VERSION"><!-- --></A><H3> | |
| ENABLE_RESOURCE_VERSION</H3> | |
| <PRE> | |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>ENABLE_RESOURCE_VERSION</B></PRE> | |
| <DL> | |
| <DD>The resource <tt>versioning</tt> request attribute: key: | |
| <tt>enable-resource-version</tt>. | |
| <p/> | |
| If this attribute is set to <tt>true</tt> and Click is running in | |
| <tt>production</tt> or <tt>profile</tt> mode, Click resources returned | |
| from <A HREF="../../../../org/apache/click/Control.html#getHeadElements()"><CODE>Control.getHeadElements()</CODE></A> will have a | |
| <tt>version indicator</tt> added to their path. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/click/Control.html#getHeadElements()"><CODE>Control.getHeadElements()</CODE></A>, | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#getResourceVersionIndicator(org.apache.click.Context)"><CODE>getResourceVersionIndicator(Context)</CODE></A>, | |
| <A HREF="../../../../constant-values.html#org.apache.click.util.ClickUtils.ENABLE_RESOURCE_VERSION">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DEFAULT_APP_CONFIG"><!-- --></A><H3> | |
| DEFAULT_APP_CONFIG</H3> | |
| <PRE> | |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>DEFAULT_APP_CONFIG</B></PRE> | |
| <DL> | |
| <DD>The default Click configuration filename: | |
| "<tt>/WEB-INF/click.xml</tt>". | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.click.util.ClickUtils.DEFAULT_APP_CONFIG">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="VERSION_INDICATOR_SEP"><!-- --></A><H3> | |
| VERSION_INDICATOR_SEP</H3> | |
| <PRE> | |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>VERSION_INDICATOR_SEP</B></PRE> | |
| <DL> | |
| <DD>The version indicator separator string. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.click.util.ClickUtils.VERSION_INDICATOR_SEP">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="RESOURCE_VERSION_INDICATOR"><!-- --></A><H3> | |
| RESOURCE_VERSION_INDICATOR</H3> | |
| <PRE> | |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>RESOURCE_VERSION_INDICATOR</B></PRE> | |
| <DL> | |
| <DD>The static web resource version number indicator string. | |
| <P> | |
| <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="ClickUtils()"><!-- --></A><H3> | |
| ClickUtils</H3> | |
| <PRE> | |
| public <B>ClickUtils</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="autoPostRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.util.Map, boolean)"><!-- --></A><H3> | |
| autoPostRedirect</H3> | |
| <PRE> | |
| public static void <B>autoPostRedirect</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> target, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><?,?> params, | |
| boolean compress)</PRE> | |
| <DL> | |
| <DD>Perform an auto post redirect to the specified target using the given | |
| response. If the params Map is defined then the form will post these | |
| values as name value pairs. If the compress value is true, this method | |
| will attempt to gzip compress the response content if requesting | |
| browser accepts "gzip" encoding. | |
| <p/> | |
| Once this method has returned you should not attempt to write to the | |
| servlet response. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request<DD><CODE>response</CODE> - the servlet response<DD><CODE>target</CODE> - the target URL to send the auto post redirect to<DD><CODE>params</CODE> - the map of parameter values to post<DD><CODE>compress</CODE> - the flag to specify whether to attempt gzip compression | |
| of the response content</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="bind(org.apache.click.control.Field)"><!-- --></A><H3> | |
| bind</H3> | |
| <PRE> | |
| public static void <B>bind</B>(<A HREF="../../../../org/apache/click/control/Field.html" title="class in org.apache.click.control">Field</A> field)</PRE> | |
| <DL> | |
| <DD>A helper method that binds the submitted request value to the Field's | |
| value. Since Field values are only bound during the <tt>"onProcess"</tt> | |
| event, this method can be used to bind a submitted Field value during | |
| the <tt>"onInit"</tt> event, which occurs <b>before</b> the | |
| <tt>"onProcess"</tt> event. | |
| <p/> | |
| This is especially useful for dynamic Form and Page behavior where Field | |
| values are inspected during the <tt>"onInit"</tt> event to add or remove | |
| specific Fields. | |
| <p/> | |
| <b>Please note</b>: this method won't bind disabled fields, unless the | |
| field has an incoming request parameter matching its name. If an incoming | |
| request parameter is present, this method will switch off the Field's | |
| disabled property. | |
| <p/> | |
| This method delegates to | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#canBind(org.apache.click.Control, org.apache.click.Context)"><CODE>canBind(org.apache.click.Control, org.apache.click.Context)</CODE></A> | |
| to check if the Field value can be bound. | |
| <p/> | |
| <pre class="prettyprint"> | |
| public void onInit() { | |
| Form form = new Form("form"); | |
| Select select = new Select("select"); | |
| select.setAttribute("onchange", "Click.submit(form, false)"); | |
| // Bind the select Field request value | |
| ClickUtils.bind(select); | |
| if (select.getValue() == COMPANY) { | |
| form.add(new TextField("companyName")); | |
| } else { | |
| form.add(new TextField("fullname")); | |
| form.add(new TextField("age")); | |
| } | |
| } </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>field</CODE> - the Field to bind</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="bind(org.apache.click.control.AbstractLink)"><!-- --></A><H3> | |
| bind</H3> | |
| <PRE> | |
| public static void <B>bind</B>(<A HREF="../../../../org/apache/click/control/AbstractLink.html" title="class in org.apache.click.control">AbstractLink</A> link)</PRE> | |
| <DL> | |
| <DD>A helper method that binds the submitted request value to the Link's | |
| value. See <A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.Field)"><CODE>bind(org.apache.click.control.Field)</CODE></A> for a detailed | |
| description. | |
| <p/> | |
| This method delegates to | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#canBind(org.apache.click.Control, org.apache.click.Context)"><CODE>canBind(org.apache.click.Control, org.apache.click.Context)</CODE></A> | |
| to check if the Link value can be bound. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>link</CODE> - the AbstractLink to bind</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="bind(org.apache.click.control.Container)"><!-- --></A><H3> | |
| bind</H3> | |
| <PRE> | |
| public static void <B>bind</B>(<A HREF="../../../../org/apache/click/control/Container.html" title="interface in org.apache.click.control">Container</A> container)</PRE> | |
| <DL> | |
| <DD>A helper method that binds the submitted request values of all Fields | |
| and Links inside the given container or child containers. See | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.Field)"><CODE>bind(org.apache.click.control.Field)</CODE></A> for a detailed description. | |
| <p/> | |
| This method delegates to | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#canBind(org.apache.click.Control, org.apache.click.Context)"><CODE>canBind(org.apache.click.Control, org.apache.click.Context)</CODE></A> | |
| to check if the Container Fields and Links can be bound. | |
| <p/> | |
| Below is an example to bind Form Field's during the onInit event: | |
| <pre class="prettyprint"> | |
| public void onInit() { | |
| Form form = new Form("form"); | |
| Checkbox commentChk = new Checkbox("comment"); | |
| Select select = new Select("select"); | |
| select.setAttribute("onchange", "Click.submit(form, false)"); | |
| // Bind all Form Field request values | |
| ClickUtils.bind(form); | |
| if (select.getValue() == COMPANY) { | |
| form.add(new TextField("companyName")); | |
| } else { | |
| form.add(new TextField("fullname")); | |
| form.add(new TextField("age")); | |
| } | |
| if (commentChk.isChecked()) { | |
| form.add(new TextArea("feedback")); | |
| } | |
| } </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>container</CODE> - the container which Fields and Links to bind</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="bindAndValidate(org.apache.click.control.Field)"><!-- --></A><H3> | |
| bindAndValidate</H3> | |
| <PRE> | |
| public static boolean <B>bindAndValidate</B>(<A HREF="../../../../org/apache/click/control/Field.html" title="class in org.apache.click.control">Field</A> field)</PRE> | |
| <DL> | |
| <DD>A helper method that binds and validates the Field's submitted request | |
| value. This method will return true if the validation succeeds, false | |
| otherwise. See <A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.Field)"><CODE>bind(org.apache.click.control.Field)</CODE></A> for a | |
| detailed description. | |
| <p/> | |
| This method delegates to | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#canBind(org.apache.click.Control, org.apache.click.Context)"><CODE>canBind(org.apache.click.Control, org.apache.click.Context)</CODE></A> | |
| to check if the Field value can be bound and validated. | |
| <p/> | |
| <b>Please note</b>: this method won't bind and validate disabled fields, | |
| unless the field has an incoming request parameter matching its name. | |
| If an incoming request parameter is present, this method will switch off | |
| the Field's disabled property. | |
| <p/> | |
| <pre class="prettyprint"> | |
| public void onInit() { | |
| Form form = new Form("form"); | |
| Select select = new Select("select", true); | |
| select.addOption(Option.EMPTY_OPTION); | |
| select.setAttribute("onchange", "Click.submit(form, false)"); | |
| // Bind the Field request value and validate it before continuing | |
| if (ClickUtils.bindAndValidate(select)) { | |
| if (select.getValue() == COMPANY) { | |
| form.add(new TextField("companyName")); | |
| } else { | |
| form.add(new TextField("fullname")); | |
| form.add(new TextField("age")); | |
| } | |
| } | |
| } </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>field</CODE> - the Field to bind and validate | |
| <DT><B>Returns:</B><DD>true if field was bound and valid, or false otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="bindAndValidate(org.apache.click.control.Container)"><!-- --></A><H3> | |
| bindAndValidate</H3> | |
| <PRE> | |
| public static boolean <B>bindAndValidate</B>(<A HREF="../../../../org/apache/click/control/Container.html" title="interface in org.apache.click.control">Container</A> container)</PRE> | |
| <DL> | |
| <DD>A helper method that binds and validates the submitted request values | |
| of all Fields and Links inside the given container or child containers. | |
| This method will return true if the validation succeeds, false | |
| otherwise. | |
| <p/> | |
| See <A HREF="../../../../org/apache/click/util/ClickUtils.html#bindAndValidate(org.apache.click.control.Form)"><CODE>bindAndValidate(org.apache.click.control.Form)</CODE></A> for a | |
| detailed description. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>container</CODE> - the container which Fields and Links to bind and | |
| validate | |
| <DT><B>Returns:</B><DD>true if all Fields are valid, false otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="bindAndValidate(org.apache.click.control.Form)"><!-- --></A><H3> | |
| bindAndValidate</H3> | |
| <PRE> | |
| public static boolean <B>bindAndValidate</B>(<A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form)</PRE> | |
| <DL> | |
| <DD>* A helper method that binds and validates the submitted request values | |
| of all Fields and Links inside the given Form or child containers. Note, | |
| the Form itself is also validated. | |
| <p/> | |
| This method will return true if the validation succeeds, false otherwise. | |
| See <A HREF="../../../../org/apache/click/util/ClickUtils.html#bind(org.apache.click.control.Field)"><CODE>bind(org.apache.click.control.Field)</CODE></A> for a detailed | |
| description. | |
| <p/> | |
| This method delegates to | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#canBind(org.apache.click.Control, org.apache.click.Context)"><CODE>canBind(org.apache.click.Control, org.apache.click.Context)</CODE></A> | |
| to check if the Form Fields and Links can be bound and validated. | |
| <pre class="prettyprint"> | |
| public void onInit() { | |
| Form form = new Form("form"); | |
| Checkbox commentChk = new Checkbox("comment"); | |
| Select select = new Select("select", true); | |
| select.addOption(Option.EMPTY_OPTION); | |
| select.setAttribute("onchange", "Click.submit(form, false)"); | |
| // Bind all Form field request values and validate it before continuing | |
| if (ClickUtils.bindAndValidate(form)) { | |
| if (select.getValue() == COMPANY) { | |
| form.add(new TextField("companyName")); | |
| } else { | |
| form.add(new TextField("fullname")); | |
| form.add(new TextField("age")); | |
| } | |
| if (commentChk.isChecked()) { | |
| form.add(new TextArea("feedback")); | |
| } | |
| } | |
| } </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>form</CODE> - the form which Fields and Links to bind and validate | |
| <DT><B>Returns:</B><DD>true if the form, it's fields and links was bound and valid, false | |
| otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="buildDocument(java.io.InputStream)"><!-- --></A><H3> | |
| buildDocument</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A> <B>buildDocument</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> inputStream)</PRE> | |
| <DL> | |
| <DD>Return a new XML Document for the given input stream. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - the input stream | |
| <DT><B>Returns:</B><DD>new XML Document | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang">RuntimeException</A></CODE> - if a parsing error occurs</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="buildDocument(java.io.InputStream, org.xml.sax.EntityResolver)"><!-- --></A><H3> | |
| buildDocument</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom">Document</A> <B>buildDocument</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> inputStream, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/xml/sax/EntityResolver.html" title="class or interface in org.xml.sax">EntityResolver</A> entityResolver)</PRE> | |
| <DL> | |
| <DD>Return a new XML Document for the given input stream and XML entity | |
| resolver. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - the input stream<DD><CODE>entityResolver</CODE> - the XML entity resolver | |
| <DT><B>Returns:</B><DD>new XML Document | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang">RuntimeException</A></CODE> - if a parsing error occurs</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="canBind(org.apache.click.Control, org.apache.click.Context)"><!-- --></A><H3> | |
| canBind</H3> | |
| <PRE> | |
| public static boolean <B>canBind</B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Return true if the given control's request value can be bound, false | |
| otherwise. | |
| <p/> | |
| The following algorithm is used to determine if the Control can be | |
| bound to a request value or not. | |
| <ul> | |
| <li>return false if the request is a forward. | |
| See <A HREF="../../../../org/apache/click/Context.html#isForward()"><CODE>Context.isForward()</CODE></A></li> | |
| <li>return true if the request is an Ajax request. | |
| See <A HREF="../../../../org/apache/click/Context.html#isAjaxRequest()"><CODE>Context.isAjaxRequest()</CODE></A></li> | |
| <li>return true if the control has no parent Form</li> | |
| <li>return true if the control's parent Form was submitted, false otherwise. | |
| See <A HREF="../../../../org/apache/click/control/Form.html#isFormSubmission()"><CODE>Form.isFormSubmission()</CODE></A></li> | |
| </ul> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the control to check if it can be bound or not<DD><CODE>context</CODE> - the request context | |
| <DT><B>Returns:</B><DD>true if the given control request value be bound, false otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="classForName(java.lang.String)"><!-- --></A><H3> | |
| classForName</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>classForName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> classname) | |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></PRE> | |
| <DL> | |
| <DD>Returns the <code>Class</code> object associated with the class or | |
| interface with the given string name, using the current Thread context | |
| class loader. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>classname</CODE> - the name of the class to load | |
| <DT><B>Returns:</B><DD>the <tt>Class</tt> object | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></CODE> - if the class cannot be located</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="close(java.io.Closeable)"><!-- --></A><H3> | |
| close</H3> | |
| <PRE> | |
| public static void <B>close</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Closeable.html" title="class or interface in java.io">Closeable</A> closeable)</PRE> | |
| <DL> | |
| <DD>Close the given closeable (Reader, Writer, Stream) and ignore any | |
| exceptions thrown. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>closeable</CODE> - the closeable (Reader, Writer, Stream) to close.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="createTemplateModel(org.apache.click.Page, org.apache.click.Context)"><!-- --></A><H3> | |
| createTemplateModel</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>> <B>createTemplateModel</B>(<A HREF="../../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A> page, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Creates a template model of key/value pairs which can be used by template | |
| engines such as Velocity and Freemarker. | |
| <p/> | |
| The following objects will be added to the model: | |
| <ul> | |
| <li>the Page <A HREF="../../../../org/apache/click/Page.html#model"><CODE>model</CODE></A> Map key/value | |
| pairs | |
| </li> | |
| <li>context - the Servlet context path, e.g. <span class="">/mycorp</span> | |
| </li> | |
| <li>format - the Page <A HREF="../../../../org/apache/click/util/Format.html" title="class in org.apache.click.util"><CODE>Format</CODE></A> object for formatting the display | |
| of objects. | |
| </li> | |
| <li>messages - the <A HREF="../../../../org/apache/click/util/MessagesMap.html" title="class in org.apache.click.util"><CODE>MessagesMap</CODE></A> adaptor for the | |
| <A HREF="../../../../org/apache/click/Page.html#getMessages()"><CODE>Page.getMessages()</CODE></A> method. | |
| </li> | |
| <li>path - the <A HREF="../../../../org/apache/click/Page.html#path"><CODE>path</CODE></A> of the <tt>page</tt> | |
| template. | |
| </li> | |
| <li>request - the page <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http"><CODE>HttpServletRequest</CODE></A> | |
| object. | |
| </li> | |
| <li>response - the page <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http"><CODE>HttpServletResponse</CODE></A> | |
| object. | |
| </li> | |
| <li>session - the <A HREF="../../../../org/apache/click/util/SessionMap.html" title="class in org.apache.click.util"><CODE>SessionMap</CODE></A> adaptor for the users | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpSession.html" title="class or interface in javax.servlet.http"><CODE>HttpSession</CODE></A>. | |
| </li> | |
| </ul> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>page</CODE> - the page to populate the template model from<DD><CODE>context</CODE> - the request context | |
| <DT><B>Returns:</B><DD>a template model as a map</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="invalidateCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| invalidateCookie</H3> | |
| <PRE> | |
| public static void <B>invalidateCookie</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieName, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> | |
| <DL> | |
| <DD>Invalidate the specified cookie and delete it from the response object. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request<DD><CODE>response</CODE> - the servlet response<DD><CODE>cookieName</CODE> - The name of the cookie you want to delete<DD><CODE>path</CODE> - of the path the cookie you want to delete</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isAjaxRequest(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| isAjaxRequest</H3> | |
| <PRE> | |
| public static boolean <B>isAjaxRequest</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</PRE> | |
| <DL> | |
| <DD>Return true is this is an Ajax request, false otherwise. | |
| <p/> | |
| An Ajax request is identified by the presence of the request <tt>header</tt> | |
| or request <tt>parameter</tt>: "<tt>X-Requested-With</tt>". | |
| "<tt>X-Requested-With</tt>" is the de-facto standard identifier used by | |
| Ajax libraries. | |
| <p/> | |
| <b>Note:</b> incoming requests that contains a request <tt>parameter</tt> | |
| "<tt>X-Requested-With</tt>" will result in this method returning true, even | |
| though the request itself was not initiated through a <tt>XmlHttpRequest</tt> | |
| object. This allows one to programmatically enable Ajax requests. A common | |
| use case for this feature is when uploading files through an IFrame element. | |
| By specifying "<tt>X-Requested-With</tt>" as a request parameter the IFrame | |
| request will be handled like a normal Ajax request. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request | |
| <DT><B>Returns:</B><DD>true if this is an Ajax request, false otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isMultipartRequest(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| isMultipartRequest</H3> | |
| <PRE> | |
| public static boolean <B>isMultipartRequest</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</PRE> | |
| <DL> | |
| <DD>Return true if the request is a multi-part content type POST request. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the page servlet request | |
| <DT><B>Returns:</B><DD>true if the request is a multi-part content type POST request</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="invalidateCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)"><!-- --></A><H3> | |
| invalidateCookie</H3> | |
| <PRE> | |
| public static void <B>invalidateCookie</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieName)</PRE> | |
| <DL> | |
| <DD>Invalidate the specified cookie and delete it from the response object. Deletes only cookies mapped | |
| against the root "/" path. Otherwise use | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#invalidateCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)"><CODE>invalidateCookie(HttpServletRequest, HttpServletResponse, String, String)</CODE></A> | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request<DD><CODE>response</CODE> - the servlet response<DD><CODE>cookieName</CODE> - The name of the cookie you want to delete.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/click/util/ClickUtils.html#invalidateCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)"><CODE>invalidateCookie(HttpServletRequest, HttpServletResponse, String, String)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getBundle(java.lang.String)"><!-- --></A><H3> | |
| getBundle</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/ResourceBundle.html" title="class or interface in java.util">ResourceBundle</A> <B>getBundle</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> baseName)</PRE> | |
| <DL> | |
| <DD>Return a resource bundle using the specified base name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>baseName</CODE> - the base name of the resource bundle, a fully qualified class name | |
| <DT><B>Returns:</B><DD>a resource bundle for the given base name | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/MissingResourceException.html" title="class or interface in java.util">MissingResourceException</A></CODE> - if no resource bundle for the specified base name can be found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getBundle(java.lang.String, java.util.Locale)"><!-- --></A><H3> | |
| getBundle</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/ResourceBundle.html" title="class or interface in java.util">ResourceBundle</A> <B>getBundle</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> baseName, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> locale)</PRE> | |
| <DL> | |
| <DD>Return a resource bundle using the specified base name and locale. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>baseName</CODE> - the base name of the resource bundle, a fully qualified class name<DD><CODE>locale</CODE> - the locale for which a resource bundle is desired | |
| <DT><B>Returns:</B><DD>a resource bundle for the given base name and locale | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/MissingResourceException.html" title="class or interface in java.util">MissingResourceException</A></CODE> - if no resource bundle for the specified base name can be found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getChild(org.w3c.dom.Element, java.lang.String)"><!-- --></A><H3> | |
| getChild</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A> <B>getChild</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A> parent, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
| <DL> | |
| <DD>Return the first XML child Element for the given parent Element and child | |
| Element name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent element to get the child from<DD><CODE>name</CODE> - the name of the child element | |
| <DT><B>Returns:</B><DD>the first child element for the given name and parent</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getChildren(org.w3c.dom.Element, java.lang.String)"><!-- --></A><H3> | |
| getChildren</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A>> <B>getChildren</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A> parent, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
| <DL> | |
| <DD>Return the list of XML child Element elements with the given name from | |
| the given parent Element. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent element to get the child from<DD><CODE>name</CODE> - the name of the child element | |
| <DT><B>Returns:</B><DD>the list of XML child elements for the given name</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getClickConfig(javax.servlet.ServletContext)"><!-- --></A><H3> | |
| getClickConfig</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> <B>getClickConfig</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext)</PRE> | |
| <DL> | |
| <DD>Return the InputStream for the Click configuration file <tt>click.xml</tt>. | |
| This method will first lookup the <tt>click.xml</tt> under the | |
| applications <tt>WEB-INF</tt> directory, and then if not found it will | |
| attempt to find the configuration file on the classpath root. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the servlet context to obtain the Click configuration | |
| from | |
| <DT><B>Returns:</B><DD>the InputStream for the Click configuration file | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang">RuntimeException</A></CODE> - if the resource could not be found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getConfigService(javax.servlet.ServletContext)"><!-- --></A><H3> | |
| getConfigService</H3> | |
| <PRE> | |
| public static <A HREF="../../../../org/apache/click/service/ConfigService.html" title="interface in org.apache.click.service">ConfigService</A> <B>getConfigService</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext)</PRE> | |
| <DL> | |
| <DD>Return the application configuration service instance from the given | |
| servlet context. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the servlet context to get the config service instance | |
| <DT><B>Returns:</B><DD>the application config service instance</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCookie(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3> | |
| getCookie</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/Cookie.html" title="class or interface in javax.servlet.http">Cookie</A> <B>getCookie</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
| <DL> | |
| <DD>Returns the specified Cookie object, or null if the cookie does not exist. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request<DD><CODE>name</CODE> - the name of the cookie | |
| <DT><B>Returns:</B><DD>the Cookie object if it exists, otherwise null</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setCookie(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, java.lang.String, int, java.lang.String)"><!-- --></A><H3> | |
| setCookie</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/Cookie.html" title="class or interface in javax.servlet.http">Cookie</A> <B>setCookie</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletResponse.html" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value, | |
| int maxAge, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> path)</PRE> | |
| <DL> | |
| <DD>Sets the given cookie values in the servlet response. | |
| <p/> | |
| This will also put the cookie in a list of cookies to send with this request's response | |
| (so that in case of a redirect occurring down the chain, the first filter | |
| will always try to set this cookie again) | |
| <p/> | |
| The cookie secure flag is set if the request is secure. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request<DD><CODE>response</CODE> - the servlet response<DD><CODE>name</CODE> - the cookie name<DD><CODE>value</CODE> - the cookie value<DD><CODE>maxAge</CODE> - the maximum age of the cookie in seconds. A negative | |
| value will expire the cookie at the end of the session, while 0 will delete | |
| the cookie.<DD><CODE>path</CODE> - the cookie path | |
| <DT><B>Returns:</B><DD>the Cookie object created and set in the response</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCookieValue(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3> | |
| getCookieValue</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getCookieValue</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
| <DL> | |
| <DD>Returns the value of the specified cookie as a String. If the cookie | |
| does not exist, the method returns null. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request<DD><CODE>name</CODE> - the name of the cookie | |
| <DT><B>Returns:</B><DD>the value of the cookie, or null if the cookie does not exist.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getClickVersion()"><!-- --></A><H3> | |
| getClickVersion</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getClickVersion</B>()</PRE> | |
| <DL> | |
| <DD>Return the Click Framework version string. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the Click Framework version string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getApplicationVersion()"><!-- --></A><H3> | |
| getApplicationVersion</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getApplicationVersion</B>()</PRE> | |
| <DL> | |
| <DD>Return the web application version string. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the web application version string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setApplicationVersion(java.lang.String)"><!-- --></A><H3> | |
| setApplicationVersion</H3> | |
| <PRE> | |
| public static void <B>setApplicationVersion</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> applicationVersion)</PRE> | |
| <DL> | |
| <DD>Set the web application version string. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>applicationVersion</CODE> - the web application version string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getResourceVersionIndicator(org.apache.click.Context)"><!-- --></A><H3> | |
| getResourceVersionIndicator</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getResourceVersionIndicator</B>(<A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Return Click's version indicator for static web resources | |
| (eg css, js and image files) if resource versioning is active, | |
| otherwise this method will return an empty string. | |
| <p/> | |
| Click's resource versioning becomes active under the following | |
| conditions: | |
| <ul> | |
| <li>the <A HREF="../../../../org/apache/click/util/ClickUtils.html#ENABLE_RESOURCE_VERSION"><CODE>ENABLE_RESOURCE_VERSION</CODE></A> request attribute must be set | |
| to <tt>true</tt></li> | |
| <li>the application mode must be either "production" or "profile"</li> | |
| </ul> | |
| The version indicator is based on the current Click release version. | |
| For example when using Click 1.4 this method will return the string | |
| <tt>"_1.4"</tt>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the request context | |
| <DT><B>Returns:</B><DD>a version indicator for web resources</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getApplicationResourceVersionIndicator()"><!-- --></A><H3> | |
| getApplicationResourceVersionIndicator</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getApplicationResourceVersionIndicator</B>()</PRE> | |
| <DL> | |
| <DD>If resource versioning is active this method will return the | |
| application version indicator for static web resources | |
| (eg JavaScript and Css) otherwise this method will return an empty string. | |
| <p/> | |
| Application resource versioning becomes active under the following | |
| conditions: | |
| <ul> | |
| <li>the <A HREF="../../../../org/apache/click/util/ClickUtils.html#ENABLE_RESOURCE_VERSION"><CODE>ENABLE_RESOURCE_VERSION</CODE></A> request attribute must be set | |
| to <tt>true</tt></li> | |
| <li>the application mode must be either "production" or "profile"</li> | |
| </ul> | |
| The version indicator is based on the application version. | |
| For example if the application version is 1.2 this method will | |
| return the string <tt>"_1.2"</tt>. | |
| <p/> | |
| The application version can be set through the static method | |
| <A HREF="../../../../org/apache/click/util/ClickUtils.html#setApplicationVersion(java.lang.String)"><CODE>setApplicationVersion(java.lang.String)</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>an application version indicator for web resources</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCssSelector(org.apache.click.Control)"><!-- --></A><H3> | |
| getCssSelector</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getCssSelector</B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</PRE> | |
| <DL> | |
| <DD>Return the given control CSS selector or null if no selector can be found. | |
| <p/> | |
| <b>Please note:</b> it is highly recommended to set a control's ID | |
| attribute when dealing with Ajax requests. | |
| <p/> | |
| The CSS selector is calculated as follows: | |
| <ol> | |
| <li>if control.getId() is set, prepend it with a '#' char | |
| and return the value. An example selector will be: <tt>#field-id</tt> | |
| </li> | |
| <li>if control.getName() is set do the following: | |
| <ol> | |
| <li>if the control is of type <A HREF="../../../../org/apache/click/control/ActionLink.html" title="class in org.apache.click.control"><CODE>ActionLink</CODE></A>, | |
| it's "<tt>class</tt>" attribute selector will be returned. For example: | |
| <tt>a[class=red]</tt>. <b>Please note:</b> if the link class attribute is | |
| not set, the class attribute will be set to its name, prefixed with | |
| a dash, '-'. For example: <tt>a[class=-my-link]</tt>. | |
| </li> | |
| <li>if the control is not an ActionLink, it is assumed the control | |
| will render its "<tt>name</tt>" attribute and the name attribute | |
| selector will be returned. For example: <tt>input[name=my-button]</tt>. | |
| </li> | |
| </ol> | |
| </li> | |
| <li>otherwise return null. | |
| </li> | |
| </ol> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the control which CSS selector to return | |
| <DT><B>Returns:</B><DD>the control CSS selector or null if no selector can be found | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if control is null</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="copyFormToObject(org.apache.click.control.Form, java.lang.Object, boolean)"><!-- --></A><H3> | |
| copyFormToObject</H3> | |
| <PRE> | |
| public static void <B>copyFormToObject</B>(<A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object, | |
| boolean debug)</PRE> | |
| <DL> | |
| <DD>Populate the given object's attributes with the Form's field values. | |
| <p/> | |
| The specified Object can either be a POJO (plain old java object) or | |
| a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util"><CODE>Map</CODE></A>. If a POJO is specified, its attributes are | |
| populated from matching form fields. If a map is specified, its | |
| key/value pairs are populated from matching form fields. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>form</CODE> - the Form to obtain field values from<DD><CODE>object</CODE> - the object to populate with field values<DD><CODE>debug</CODE> - log debug statements when populating the object</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="copyObjectToForm(java.lang.Object, org.apache.click.control.Form, boolean)"><!-- --></A><H3> | |
| copyObjectToForm</H3> | |
| <PRE> | |
| public static void <B>copyObjectToForm</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object, | |
| <A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form, | |
| boolean debug)</PRE> | |
| <DL> | |
| <DD>Populate the given Form field values with the object's attributes. | |
| <p/> | |
| The specified Object can either be a POJO (plain old java object) or | |
| a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util"><CODE>Map</CODE></A>. If a POJO is specified, its attributes are | |
| copied to matching form fields. If a map is specified, its key/value | |
| pairs are copied to matching form fields. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to obtain attribute values from<DD><CODE>form</CODE> - the Form to populate<DD><CODE>debug</CODE> - log debug statements when populating the form</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="deployFile(javax.servlet.ServletContext, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| deployFile</H3> | |
| <PRE> | |
| public static void <B>deployFile</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> resource, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> targetDir)</PRE> | |
| <DL> | |
| <DD>Deploy the specified classpath resource to the given target directory | |
| under the web application root directory. | |
| <p/> | |
| This method will <b>not</b> override any existing resources found in the | |
| target directory. | |
| <p/> | |
| If an IOException or SecurityException occurs this method will log a | |
| warning message. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the web applications servlet context<DD><CODE>resource</CODE> - the classpath resource name<DD><CODE>targetDir</CODE> - the target directory to deploy the resource to</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="deployFiles(javax.servlet.ServletContext, java.lang.String[], java.lang.String)"><!-- --></A><H3> | |
| deployFiles</H3> | |
| <PRE> | |
| public static void <B>deployFiles</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] resources, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> targetDir)</PRE> | |
| <DL> | |
| <DD>Deploy the specified classpath resources to the given target directory | |
| under the web application root directory. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the web applications servlet context<DD><CODE>resources</CODE> - the array of classpath resource names<DD><CODE>targetDir</CODE> - the target directory to deploy the resource to</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="deployFileList(javax.servlet.ServletContext, java.lang.Class, java.lang.String)"><!-- --></A><H3> | |
| deployFileList</H3> | |
| <PRE> | |
| public static void <B>deployFileList</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><? extends <A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A>> controlClass, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> targetDir)</PRE> | |
| <DL> | |
| <DD>Deploys required files (from a file list) for a control that repsects a specific convention. | |
| <p/> | |
| <b>Convention:</b> | |
| <p/> | |
| There's a descriptor file generated by the <code>tools/standalone/dev-tasks/ListFilesTask</code>. | |
| The files to deploy are all in a subdirectory placed in the same directory with the control. | |
| See documentation for more details. <p/> | |
| <b>Usage:</b><p/> | |
| In your Control simply use the code below, and everything should work automatically. | |
| <pre class="prettyprint"> | |
| public void onDeploy(ServletContext servletContext) { | |
| ClickUtils.deployFileList(servletContext, HeavyControl.class, "click"); | |
| } </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the web applications servlet context<DD><CODE>controlClass</CODE> - the class of the Control that has files for deployment<DD><CODE>targetDir</CODE> - target directory where to deploy the files to. In most cases this | |
| is only the reserved directory <code>click</code></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="encode(java.lang.Object)"><!-- --></A><H3> | |
| encode</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>encode</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object) | |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> | |
| <DL> | |
| <DD>Return an encoded version of the <tt>Serializable</tt> object. The object | |
| will be serialized, compressed and Base 64 encoded. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to encode | |
| <DT><B>Returns:</B><DD>a serialized, compressed and Base 64 string encoding of the | |
| given object | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O error occurs | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the object parameter is null, or if | |
| the object is not Serializable</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="decode(java.lang.String)"><!-- --></A><H3> | |
| decode</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>decode</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> string) | |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A>, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> | |
| <DL> | |
| <DD>Return an object from the <A HREF="../../../../org/apache/click/util/ClickUtils.html#encode(java.lang.Object)"><CODE>encode(Object)</CODE></A> string. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - the encoded string | |
| <DT><B>Returns:</B><DD>an object from the encoded | |
| <DT><B>Throws:</B> | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></CODE> - if the class could not be instantiated | |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an data I/O error occurs</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="encodePasswordCookie(java.lang.String, java.lang.String, int)"><!-- --></A><H3> | |
| encodePasswordCookie</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>encodePasswordCookie</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> username, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password, | |
| int xorMask)</PRE> | |
| <DL> | |
| <DD>Builds a cookie string containing a username and password. | |
| <p/> | |
| Note: with open source this is not really secure, but it prevents users | |
| from snooping the cookie file of others and by changing the XOR mask and | |
| character offsets, you can easily tweak results. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username<DD><CODE>password</CODE> - the password<DD><CODE>xorMask</CODE> - the XOR mask to encrypt the value with, must be same as | |
| as the value used to decrypt the cookie password | |
| <DT><B>Returns:</B><DD>String encoding the input parameters, an empty string if one of | |
| the arguments equals <code>null</code></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="encodePasswordCookie(java.lang.String, java.lang.String, java.lang.String, int)"><!-- --></A><H3> | |
| encodePasswordCookie</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>encodePasswordCookie</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> username, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> encoding, | |
| int xorMask)</PRE> | |
| <DL> | |
| <DD>Builds a cookie string containing a username and password, using offsets | |
| to customize the encoding. | |
| <p/> | |
| Note: with open source this is not really secure, but it prevents users | |
| from snooping the cookie file of others and by changing the XOR mask and | |
| character offsets, you can easily tweak results. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username<DD><CODE>password</CODE> - the password<DD><CODE>encoding</CODE> - a String used to customize cookie encoding (only the first 3 characters are used)<DD><CODE>xorMask</CODE> - the XOR mask to encrypt the value with, must be same as | |
| as the value used to decrypt the cookie password | |
| <DT><B>Returns:</B><DD>String encoding the input parameters, an empty string if one of | |
| the arguments equals <code>null</code>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="decodePasswordCookie(java.lang.String, int)"><!-- --></A><H3> | |
| decodePasswordCookie</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>decodePasswordCookie</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieVal, | |
| int xorMask)</PRE> | |
| <DL> | |
| <DD>Decodes a cookie string containing a username and password. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>cookieVal</CODE> - the encoded cookie username and password value<DD><CODE>xorMask</CODE> - the XOR mask to decrypt the value with, must be same as | |
| as the value used to encrypt the cookie password | |
| <DT><B>Returns:</B><DD>String[] containing the username at index 0 and the password at | |
| index 1, or <code>{ null, null }</code> if cookieVal equals | |
| <code>null</code> or the empty string.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="decodePasswordCookie(java.lang.String, java.lang.String, int)"><!-- --></A><H3> | |
| decodePasswordCookie</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>decodePasswordCookie</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> cookieVal, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> encoding, | |
| int xorMask)</PRE> | |
| <DL> | |
| <DD>Decodes a cookie string containing a username and password. | |
| <p/> | |
| This method was derived from Atlassian <tt>CookieUtils</tt> method of | |
| the same name, release under the BSD License. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>cookieVal</CODE> - the encoded cookie username and password value<DD><CODE>encoding</CODE> - a String used to customize cookie encoding (only the first 3 characters are used) | |
| - should be the same string you used to encode the cookie!<DD><CODE>xorMask</CODE> - the XOR mask to decrypt the value with, must be same as | |
| as the value used to encrypt the cookie password | |
| <DT><B>Returns:</B><DD>String[] containing the username at index 0 and the password at | |
| index 1, or <code>{ null, null }</code> if cookieVal equals | |
| <code>null</code> or the empty string.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="encodeURL(java.lang.Object)"><!-- --></A><H3> | |
| encodeURL</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>encodeURL</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> value)</PRE> | |
| <DL> | |
| <DD>URL encode the specified value using the "UTF-8" encoding scheme. | |
| <p/> | |
| For example <tt>(http://host?name=value with spaces)</tt> will become | |
| <tt>(http://host?name=value+with+spaces)</tt>. | |
| <p/> | |
| This method uses <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URLEncoder.html#encode(java.lang.String, java.lang.String)" title="class or interface in java.net"><CODE>URLEncoder.encode(java.lang.String, java.lang.String)</CODE></A> | |
| internally. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to encode using "UTF-8" | |
| <DT><B>Returns:</B><DD>an encoded URL string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="decodeURL(java.lang.Object)"><!-- --></A><H3> | |
| decodeURL</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>decodeURL</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> value)</PRE> | |
| <DL> | |
| <DD>URL decode the specified value using the "UTF-8" encoding scheme. | |
| <p/> | |
| For example <tt>(http://host?name=value+with+spaces)</tt> will become | |
| <tt>(http://host?name=value with spaces)</tt>. | |
| <p/> | |
| This method uses <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URLDecoder.html#decode(java.lang.String, java.lang.String)" title="class or interface in java.net"><CODE>URLDecoder.decode(java.lang.String, java.lang.String)</CODE></A> | |
| internally. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to decode using "UTF-8" | |
| <DT><B>Returns:</B><DD>an encoded URL string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="encodeUrl(java.lang.Object, org.apache.click.Context)"><!-- --></A><H3> | |
| encodeUrl</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>encodeUrl</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Return an encoded URL value for the given object using the context | |
| request character encoding or "UTF-8" if the request character encoding | |
| is not specified. | |
| <p/> | |
| For example <tt>(http://host?name=value with spaces)</tt> will become | |
| <tt>(http://host?name=value+with+spaces)</tt>. | |
| <p/> | |
| This method uses | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URLEncoder.html#encode(java.lang.String, java.lang.String)" title="class or interface in java.net"><CODE>URLEncoder.encode(java.lang.String, java.lang.String)</CODE></A> internally. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>object</CODE> - the object value to encode as a URL string<DD><CODE>context</CODE> - the context providing the request character encoding | |
| <DT><B>Returns:</B><DD>an encoded URL string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="escapeHtml(java.lang.String)"><!-- --></A><H3> | |
| escapeHtml</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>escapeHtml</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</PRE> | |
| <DL> | |
| <DD>Return a HTML escaped string for the given string value. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string value to escape | |
| <DT><B>Returns:</B><DD>the HTML escaped string value</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="escape(java.lang.String)"><!-- --></A><H3> | |
| escape</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>escape</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</PRE> | |
| <DL> | |
| <DD>Return an escaped string for the given string value. The following | |
| characters are escaped: <, >, ", ', &. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string value to escape | |
| <DT><B>Returns:</B><DD>the escaped string value</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasRequestParameter(org.apache.click.Control)"><!-- --></A><H3> | |
| hasRequestParameter</H3> | |
| <PRE> | |
| public static boolean <B>hasRequestParameter</B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</PRE> | |
| <DL> | |
| <DD>Return true if the control has a submitted request value, false otherwise. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the control which request parameter to check | |
| <DT><B>Returns:</B><DD>true if the control has a submitted request value, false otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="invokeListener(java.lang.Object, java.lang.String)"><!-- --></A><H3> | |
| invokeListener</H3> | |
| <PRE> | |
| public static boolean <B>invokeListener</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> listener, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> method)</PRE> | |
| <DL> | |
| <DD>Invoke the named method on the given object and return the boolean | |
| result. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the object with the method to invoke<DD><CODE>method</CODE> - the name of the method to invoke | |
| <DT><B>Returns:</B><DD>true if the listener method returned true<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/click/Control.html#setListener(java.lang.Object, java.lang.String)"><CODE>Control.setListener(Object, String)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="invokeAction(java.lang.Object, java.lang.String)"><!-- --></A><H3> | |
| invokeAction</H3> | |
| <PRE> | |
| public static <A HREF="../../../../org/apache/click/ActionResult.html" title="class in org.apache.click">ActionResult</A> <B>invokeAction</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> target, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> method)</PRE> | |
| <DL> | |
| <DD>Invoke the named method on the given target and return the Object result. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>target</CODE> - the target object with the method to invoke<DD><CODE>method</CODE> - the name of the method to invoke | |
| <DT><B>Returns:</B><DD>an ActionResult instance</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isEnableResourceVersion(org.apache.click.Context)"><!-- --></A><H3> | |
| isEnableResourceVersion</H3> | |
| <PRE> | |
| public static boolean <B>isEnableResourceVersion</B>(<A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Return true if static web content resource versioning is enabled. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the request context | |
| <DT><B>Returns:</B><DD>true if static web content resource versioning is enabled</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="limitLength(java.lang.String, int)"><!-- --></A><H3> | |
| limitLength</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>limitLength</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value, | |
| int maxlength)</PRE> | |
| <DL> | |
| <DD>Return the value string limited to maxlength characters. If the string | |
| gets curtailed, "..." is appended to it. | |
| <p/> | |
| Adapted from Velocity Tools Formatter. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string value to limit the length of<DD><CODE>maxlength</CODE> - the maximum string length | |
| <DT><B>Returns:</B><DD>a length limited string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="limitLength(java.lang.String, int, java.lang.String)"><!-- --></A><H3> | |
| limitLength</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>limitLength</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value, | |
| int maxlength, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> suffix)</PRE> | |
| <DL> | |
| <DD>Return the value string limited to maxlength characters. If the string | |
| gets curtailed and the suffix parameter is appended to it. | |
| <p/> | |
| Adapted from Velocity Tools Formatter. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string value to limit the length of<DD><CODE>maxlength</CODE> - the maximum string length<DD><CODE>suffix</CODE> - the suffix to append to the length limited string | |
| <DT><B>Returns:</B><DD>a length limited string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLogService()"><!-- --></A><H3> | |
| getLogService</H3> | |
| <PRE> | |
| public static <A HREF="../../../../org/apache/click/service/LogService.html" title="interface in org.apache.click.service">LogService</A> <B>getLogService</B>()</PRE> | |
| <DL> | |
| <DD>Return the application LogService instance using thread local Context | |
| to perform the lookup. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>the application LogService instance</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFormFields(org.apache.click.control.Form)"><!-- --></A><H3> | |
| getFormFields</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/click/control/Field.html" title="class in org.apache.click.control">Field</A>> <B>getFormFields</B>(<A HREF="../../../../org/apache/click/control/Form.html" title="class in org.apache.click.control">Form</A> form)</PRE> | |
| <DL> | |
| <DD>Return the list of Fields for the given Form, including any Fields | |
| contained in FieldSets. The list of returned fields will exclude any | |
| <tt>Button</tt>, <tt>FieldSet</tt> or <tt>Label</tt> fields. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>form</CODE> - the form to obtain the fields from | |
| <DT><B>Returns:</B><DD>the list of contained form fields</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getMimeType(java.lang.String)"><!-- --></A><H3> | |
| getMimeType</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getMimeType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</PRE> | |
| <DL> | |
| <DD>Return the mime-type or content-type for the given filename/extension. | |
| <p/> | |
| Example: | |
| <pre class="prettyprint"> | |
| // Lookup mimetype for file | |
| String mimeType = ClickUtils.getMimeType("hello-world.pdf"); | |
| // Lookup mimetype for extension | |
| mimeType = ClickUtils.getMimeType("pdf"); | |
| </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the filename or extension to obtain the mime-type for | |
| <DT><B>Returns:</B><DD>the mime-type for the given filename/extension, or null if not | |
| found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getParentMessages(org.apache.click.Control)"><!-- --></A><H3> | |
| getParentMessages</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getParentMessages</B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</PRE> | |
| <DL> | |
| <DD>Return the given control's top level parent's localized messages Map. | |
| <p/> | |
| This method will walk up to the control's parent page object and | |
| return pages messages. If the control's top level parent is a control | |
| then the parent's messages map will be returned. If the top level | |
| parent is not a Page or Control instance an empty map will be returned. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the control to get the parent messages Map for | |
| <DT><B>Returns:</B><DD>the top level parent's Map of localized messages</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getParentMessage(org.apache.click.Control, java.lang.String)"><!-- --></A><H3> | |
| getParentMessage</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getParentMessage</B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
| <DL> | |
| <DD>Return the given control's top level parent's localized message for the | |
| specified name. | |
| <p/> | |
| This method will walk up to the control's parent page object and for each | |
| parent control found, look for a message of the specified name. A | |
| message found in a parent control will override the message of a child | |
| control. | |
| <p/> | |
| Given the following property files: | |
| <p/> | |
| MyPage.properties | |
| <pre class="prettyprint"> | |
| myfield.label=Page </pre> | |
| and MyForm.properties | |
| <pre class="prettyprint"> | |
| myfield.label=Form </pre> | |
| and a the following snippet: | |
| <pre class="prettyprint"> | |
| public MyPage extends Page { | |
| public void onInit() { | |
| MyForm form = new MyForm("form"); | |
| TextField field = new TextField("myfield"); | |
| form.add(field); | |
| //1. | |
| System.out.println(ClickUtils.getParentMessage(field, "myfield.label")); | |
| addControl(form); | |
| //2. | |
| System.out.println(ClickUtils.getParentMessage(field, "myfield.label")); | |
| } | |
| } | |
| </pre> | |
| The first (1.) println statement above will output <tt>Form</tt> because | |
| at that stage MyForm is the highest level parent of field. | |
| <tt>getParentMessage</tt> will find the property <tt>myfield.label</tt> | |
| in the MyForm message properties and return <tt>Form</tt> | |
| <p/> | |
| The second (2.) println statement will output <tt>Page</tt> as now | |
| MyPage is the highest level parent. On its first pass up the hierarchy, | |
| <tt>getParentMessage</tt> will find the property <tt>myfield.label</tt> | |
| in the MyForm message properties and on its second pass will find the | |
| same property in MyPage message properties. As MyPage is higher up the | |
| hierarchy than MyForm, MyPage will override MyForm and the property value | |
| will be <tt>Page</tt>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the control to get the parent message for<DD><CODE>name</CODE> - the specific property name to find | |
| <DT><B>Returns:</B><DD>the top level parent's Map of localized messages</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getParentPage(org.apache.click.Control)"><!-- --></A><H3> | |
| getParentPage</H3> | |
| <PRE> | |
| public static <A HREF="../../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A> <B>getParentPage</B>(<A HREF="../../../../org/apache/click/Control.html" title="interface in org.apache.click">Control</A> control)</PRE> | |
| <DL> | |
| <DD>Get the parent page of the given control or null if the control has no | |
| parent. This method will walk up the control's parent hierarchy to | |
| find its parent page. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the control to get the parent page from | |
| <DT><B>Returns:</B><DD>the parent page of the control or null if the control has no | |
| parent</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getRequestParameterMap(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| getRequestParameterMap</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>> <B>getRequestParameterMap</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</PRE> | |
| <DL> | |
| <DD>Return an ordered map of request parameters from the given request. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the servlet request to obtain request parameters from | |
| <DT><B>Returns:</B><DD>the ordered map of request parameters</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getResourcePath(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| getResourcePath</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getResourcePath</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</PRE> | |
| <DL> | |
| <DD>Return the page resource path from the request. For example: | |
| <pre class="codeHtml"> | |
| <span class="blue">http://www.mycorp.com/banking/secure/login.htm</span> -> <span class="red">/secure/login.htm</span> </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the page servlet request | |
| <DT><B>Returns:</B><DD>the page resource path from the request</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getRequestURI(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| getRequestURI</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getRequestURI</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/http/HttpServletRequest.html" title="class or interface in javax.servlet.http">HttpServletRequest</A> request)</PRE> | |
| <DL> | |
| <DD>Return the requestURI from the request. For example: | |
| <pre class="codeHtml"> | |
| <span class="blue">http://www.mycorp.com/banking/secure/login.htm</span> -> <span class="red">/banking/secure/login.htm</span> </pre> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the page servlet request | |
| <DT><B>Returns:</B><DD>the requestURI from the request</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getResourceAsStream(java.lang.String, java.lang.Class)"><!-- --></A><H3> | |
| getResourceAsStream</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A> <B>getResourceAsStream</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><?> aClass)</PRE> | |
| <DL> | |
| <DD>Finds a resource with a given name. This method returns null if no | |
| resource with this name is found. | |
| <p> | |
| This method uses the current <tt>Thread</tt> context <tt>ClassLoader</tt> to find | |
| the resource. If the resource is not found the class loader of the given | |
| class is then used to find the resource. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the resource<DD><CODE>aClass</CODE> - the class lookup the resource against, if the resource is | |
| not found using the current <tt>Thread</tt> context <tt>ClassLoader</tt>. | |
| <DT><B>Returns:</B><DD>the input stream of the resource if found or null otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getResource(java.lang.String, java.lang.Class)"><!-- --></A><H3> | |
| getResource</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URL.html" title="class or interface in java.net">URL</A> <B>getResource</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><?> aClass)</PRE> | |
| <DL> | |
| <DD>Finds a resource with a given name. This method returns null if no | |
| resource with this name is found. | |
| <p> | |
| This method uses the current <tt>Thread</tt> context <tt>ClassLoader</tt> to find | |
| the resource. If the resource is not found the class loader of the given | |
| class is then used to find the resource. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the resource<DD><CODE>aClass</CODE> - the class lookup the resource against, if the resource is | |
| not found using the current <tt>Thread</tt> context <tt>ClassLoader</tt>. | |
| <DT><B>Returns:</B><DD>the URL of the resource if found or null otherwise</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="removeState(org.apache.click.Stateful, java.lang.String, org.apache.click.Context)"><!-- --></A><H3> | |
| removeState</H3> | |
| <PRE> | |
| public static void <B>removeState</B>(<A HREF="../../../../org/apache/click/Stateful.html" title="interface in org.apache.click">Stateful</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> controlName, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Remove the control state from the session for the given stateful control, | |
| control name and request context. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the stateful control which state to remove<DD><CODE>controlName</CODE> - the name of the control which state to remove<DD><CODE>context</CODE> - the request context</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="restoreState(org.apache.click.Stateful, java.lang.String, org.apache.click.Context)"><!-- --></A><H3> | |
| restoreState</H3> | |
| <PRE> | |
| public static void <B>restoreState</B>(<A HREF="../../../../org/apache/click/Stateful.html" title="interface in org.apache.click">Stateful</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> controlName, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Restore the control state from the session for the given stateful control, | |
| control name and request context. | |
| <p/> | |
| This method delegates to <A HREF="../../../../org/apache/click/Stateful.html#setState(java.lang.Object)"><CODE>Stateful.setState(java.lang.Object)</CODE></A> | |
| to restore the control state. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the stateful control which state to restore<DD><CODE>controlName</CODE> - the name of the control which state to restore<DD><CODE>context</CODE> - the request context</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="saveState(org.apache.click.Stateful, java.lang.String, org.apache.click.Context)"><!-- --></A><H3> | |
| saveState</H3> | |
| <PRE> | |
| public static void <B>saveState</B>(<A HREF="../../../../org/apache/click/Stateful.html" title="interface in org.apache.click">Stateful</A> control, | |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> controlName, | |
| <A HREF="../../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> context)</PRE> | |
| <DL> | |
| <DD>Save the control state in the session for the given stateful control, | |
| control name and request context. | |
| <p/> | |
| * This method delegates to <A HREF="../../../../org/apache/click/Stateful.html#getState()"><CODE>Stateful.getState()</CODE></A> | |
| to retrieve the control state to save. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>control</CODE> - the stateful control which state to save<DD><CODE>controlName</CODE> - the name of the control control which state to save<DD><CODE>context</CODE> - the request context</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toGetterName(java.lang.String)"><!-- --></A><H3> | |
| toGetterName</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toGetterName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> property)</PRE> | |
| <DL> | |
| <DD>Return the getter method name for the given property name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - the property name | |
| <DT><B>Returns:</B><DD>the getter method name for the given property name.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toIsGetterName(java.lang.String)"><!-- --></A><H3> | |
| toIsGetterName</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toIsGetterName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> property)</PRE> | |
| <DL> | |
| <DD>Return the is getter method name for the given property name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - the property name | |
| <DT><B>Returns:</B><DD>the is getter method name for the given property name.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toLabel(java.lang.String)"><!-- --></A><H3> | |
| toLabel</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toLabel</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
| <DL> | |
| <DD>Return a field label string from the given field name. For example: | |
| <pre class="codeHtml"> | |
| <span class="blue">faxNumber</span> -> <span class="red">Fax Number</span> </pre> | |
| <p/> | |
| <b>Note</b> toLabel will return an empty String ("") if a <tt>null</tt> | |
| String name is specified. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the field name | |
| <DT><B>Returns:</B><DD>a field label string from the given field name</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toMD5Hash(java.lang.String)"><!-- --></A><H3> | |
| toMD5Hash</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toMD5Hash</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> plaintext)</PRE> | |
| <DL> | |
| <DD>Return an 32 char MD5 encoded string from the given plain text. | |
| The returned value is MD5 hash compatible with Tomcat catalina Realm. | |
| <p/> | |
| Adapted from <tt>org.apache.catalina.util.MD5Encoder</tt> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>plaintext</CODE> - the plain text value to encode | |
| <DT><B>Returns:</B><DD>encoded MD5 string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toName(java.lang.String)"><!-- --></A><H3> | |
| toName</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> label)</PRE> | |
| <DL> | |
| <DD>Return a field name string from the given field label. | |
| <p/> | |
| A label of <tt>" OK do it!"</tt> is returned as <tt>"okDoIt"</tt>. Any <tt>&nbsp;</tt> | |
| characters will also be removed. | |
| <p/> | |
| A label of <tt>"customerSelect"</tt> is returned as <tt>"customerSelect"</tt>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>label</CODE> - the field label or caption | |
| <DT><B>Returns:</B><DD>a field name string from the given field label</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toSetterName(java.lang.String)"><!-- --></A><H3> | |
| toSetterName</H3> | |
| <PRE> | |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toSetterName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> property)</PRE> | |
| <DL> | |
| <DD>Return the setter method name for the given property name. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - the property name | |
| <DT><B>Returns:</B><DD>the setter method name for the given property name.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isResourcesDeployable(javax.servlet.ServletContext)"><!-- --></A><H3> | |
| isResourcesDeployable</H3> | |
| <PRE> | |
| public static boolean <B>isResourcesDeployable</B>(<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletContext.html" title="class or interface in javax.servlet">ServletContext</A> servletContext)</PRE> | |
| <DL> | |
| <DD>Returns true if Click resources (JavaScript, CSS, images etc) packaged | |
| in jars can be deployed to the root directory of the webapp, false | |
| otherwise. | |
| <p/> | |
| This method will return false in restricted environments where write | |
| access to the underlying file system is disallowed. Examples where | |
| write access is not allowed include the WebLogic JEE server (this can be | |
| changed though) and Google App Engine. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - the application servlet context | |
| <DT><B>Returns:</B><DD>true if writes are allowed, false otherwise</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="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"> | |
| <A HREF="../../../../org/apache/click/util/Bindable.html" title="annotation in org.apache.click.util"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/click/util/ContainerUtils.html" title="class in org.apache.click.util"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/click/util/ClickUtils.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ClickUtils.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 | <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> | |
| <style type='text/css'>.str{color:#2A00FF;}.kwd{color:#7F0055;font-weight:bold;}.com{color:#3F7F5F;}.typ{color:#000;}.lit{color:#066;}.pun{color:#660;}.pln{color:#000;}.tag{color:#000099;font-weight:bold;}.atn{color:#009900;}.atv{color:#000;}.dec{color:#606;}pre.prettyprint{padding:1em;border:1px solid #888;overflow:auto;}@media print{.str{color:#2A00FF;}.kwd{color:#7F0055;font-weight:bold;}.com{color:#3F7F5F;font-style:italic;}.typ{color:#000;font-weight:bold;}.lit{color:#044;}.pun{color:#440;}.pln{color:#000;}.tag{color:#000099;font-weight:bold;}.atn{color:#009900;}.atv{color:#000;}}</style><script type='text/javascript'>var PR_keywords={};(function(){var CPP_KEYWORDS='abstract bool break case catch char class const '+'const_cast continue default delete deprecated dllexport dllimport do '+'double dynamic_cast else enum explicit extern false float for friend '+'goto if inline int long mutable naked namespace new noinline noreturn '+'nothrow novtable operator private property protected public register '+'reinterpret_cast return selectany short signed sizeof static '+'static_cast struct switch template this thread throw true try typedef '+'typeid typename union unsigned using declaration, directive uuid '+'virtual void volatile while typeof';var CSHARP_KEYWORDS='as base by byte checked decimal delegate descending '+'event finally fixed foreach from group implicit in interface internal '+'into is lock null object override orderby params readonly ref sbyte '+'sealed stackalloc string select uint ulong unchecked unsafe ushort var';var JAVA_KEYWORDS='package synchronized boolean implements import throws '+'instanceof transient extends final strictfp native super';var JSCRIPT_KEYWORDS='debugger export function with NaN Infinity';var PERL_KEYWORDS='require sub unless until use elsif BEGIN END';var PYTHON_KEYWORDS='and assert def del elif except exec global lambda '+'not or pass print raise yield False True None';var RUBY_KEYWORDS='then end begin rescue ensure module when undef next '+'redo retry alias defined';var SH_KEYWORDS='done fi';var KEYWORDS=[CPP_KEYWORDS,CSHARP_KEYWORDS,JAVA_KEYWORDS,JSCRIPT_KEYWORDS,PERL_KEYWORDS,PYTHON_KEYWORDS,RUBY_KEYWORDS,SH_KEYWORDS];for(var k=0;k<KEYWORDS.length;k++){var kw=KEYWORDS[k].split(' ');for(var i=0;i<kw.length;i++){if(kw[i]){PR_keywords[kw[i]]=true;}}}}).call(this);var PR_STRING='str';var PR_KEYWORD='kwd';var PR_COMMENT='com';var PR_TYPE='typ';var PR_LITERAL='lit';var PR_PUNCTUATION='pun';var PR_PLAIN='pln';var PR_TAG='tag';var PR_DECLARATION='dec';var PR_SOURCE='src';var PR_ATTRIB_NAME='atn';var PR_ATTRIB_VALUE='atv';var PR_TAB_WIDTH=8;function PR_isWordChar(ch){return(ch>='a'&&ch<='z')||(ch>='A'&&ch<='Z');}function PR_spliceArrayInto(inserted,container,containerPosition,countReplaced){inserted.unshift(containerPosition,countReplaced||0);try{container.splice.apply(container,inserted);}finally{inserted.splice(0,2);}}var REGEXP_PRECEDER_PATTERN=(function(){var preceders=['!','!=','!==','#','%','%=','&','&&','&&=','&=','(','*','*=','+=',',','-=','->','/','/=',':','::',';','<','<<','<<=','<=','=','==','===','>','>=','>>','>>=','>>>','>>>=','?','@','[','^','^=','^^','^^=','{','|','|=','||','||=','~','break','case','continue','delete','do','else','finally','instanceof','return','throw','try','typeof'];var pattern='(?:'+'(?:(?:^|[^0-9\.])\\.{1,3})|'+'(?:(?:^|[^\\+])\\+)|'+'(?:(?:^|[^\\-])-)';for(var i=0;i<preceders.length;++i){var preceder=preceders[i];if(PR_isWordChar(preceder.charAt(0))){pattern+='|\\b'+preceder;}else{pattern+='|'+preceder.replace(/([^=<>:&])/g,'\\$1');}}pattern+='|^)\\s*$';return new RegExp(pattern);})();var pr_amp=/&/g;var pr_lt=/</g;var pr_gt=/>/g;var pr_quot=/"/g;function PR_attribToHtml(str){return str.replace(pr_amp,'&').replace(pr_lt,'<').replace(pr_gt,'>').replace(pr_quot,'"');}function PR_textToHtml(str){return str.replace(pr_amp,'&').replace(pr_lt,'<').replace(pr_gt,'>');}var pr_ltEnt=/</g;var pr_gtEnt=/>/g;var pr_aposEnt=/'/g;var pr_quotEnt=/"/g;var pr_ampEnt=/&/g;function PR_htmlToText(html){var pos=html.indexOf('&');if(pos<0){return html;}for(--pos;(pos=html.indexOf('&#',pos+1))>=0;){var end=html.indexOf(';',pos);if(end>=0){var num=html.substring(pos+3,end);var radix=10;if(num&&num.charAt(0)=='x'){num=num.substring(1);radix=16;}var codePoint=parseInt(num,radix);if(!isNaN(codePoint)){html=(html.substring(0,pos)+String.fromCharCode(codePoint)+html.substring(end+1));}}}return html.replace(pr_ltEnt,'<').replace(pr_gtEnt,'>').replace(pr_aposEnt,"'").replace(pr_quotEnt,'"').replace(pr_ampEnt,'&');}function PR_isRawContent(node){return'XMP'==node.tagName;}var PR_innerHtmlWorks=null;function PR_getInnerHtml(node){if(null===PR_innerHtmlWorks){var testNode=document.createElement('PRE');testNode.appendChild(document.createTextNode('<!DOCTYPE foo PUBLIC "foo bar">\n<foo />'));PR_innerHtmlWorks=!/</.test(testNode.innerHTML);}if(PR_innerHtmlWorks){var content=node.innerHTML;if(PR_isRawContent(node)){content=PR_textToHtml(content);}return content;}var out=[];for(var child=node.firstChild;child;child=child.nextSibling){PR_normalizedHtml(child,out);}return out.join('');}function PR_normalizedHtml(node,out){switch(node.nodeType){case 1:var name=node.tagName.toLowerCase();out.push('\074',name);for(var i=0;i<node.attributes.length;++i){var attr=node.attributes[i];if(!attr.specified){continue;}out.push(' ');PR_normalizedHtml(attr,out);}out.push('>');for(var child=node.firstChild;child;child=child.nextSibling){PR_normalizedHtml(child,out);}if(node.firstChild||!/^(?:br|link|img)$/.test(name)){out.push('<\/',name,'>');}break;case 2:out.push(node.name.toLowerCase(),'="',PR_attribToHtml(node.value),'"');break;case 3:case 4:out.push(PR_textToHtml(node.nodeValue));break;}}function PR_tabExpander(tabWidth){var SPACES=' ';var charInLine=0;return function(plainText){var out=null;var pos=0;for(var i=0,n=plainText.length;i<n;++i){var ch=plainText.charAt(i);switch(ch){case'\t':if(!out){out=[];}out.push(plainText.substring(pos,i));var nSpaces=tabWidth-(charInLine%tabWidth);charInLine+=nSpaces;for(;nSpaces>=0;nSpaces-=SPACES.length){out.push(SPACES.substring(0,nSpaces));}pos=i+1;break;case'\n':charInLine=0;break;default:++charInLine;}}if(!out){return plainText;}out.push(plainText.substring(pos));return out.join('');};}var pr_chunkPattern=/(?:[^<]+|<!--[\s\S]*?-->|<!\[CDATA\[([\s\S]*?)\]\]>|<\/?[a-zA-Z][^>]*>|<)/g;var pr_commentPrefix=/^<!--/;var pr_cdataPrefix=/^<\[CDATA\[/;var pr_brPrefix=/^<br\b/i;function PR_extractTags(s){var matches=s.match(pr_chunkPattern);var sourceBuf=[];var sourceBufLen=0;var extractedTags=[];if(matches){for(var i=0,n=matches.length;i<n;++i){var match=matches[i];if(match.length>1&&match.charAt(0)==='<'){if(pr_commentPrefix.test(match)){continue;}if(pr_cdataPrefix.test(match)){sourceBuf.push(match.substring(9,match.length-3));sourceBufLen+=match.length-12;}else if(pr_brPrefix.test(match)){sourceBuf.push('\n');sourceBufLen+=1;}else{extractedTags.push(sourceBufLen,match);}}else{var literalText=PR_htmlToText(match);sourceBuf.push(literalText);sourceBufLen+=literalText.length;}}}return{source:sourceBuf.join(''),tags:extractedTags};}function PR_createSimpleLexer(shortcutStylePatterns,fallthroughStylePatterns){var shortcuts={};(function(){var allPatterns=shortcutStylePatterns.concat(fallthroughStylePatterns);for(var i=allPatterns.length;--i>=0;){var patternParts=allPatterns[i];var shortcutChars=patternParts[3];if(shortcutChars){for(var c=shortcutChars.length;--c>=0;){shortcuts[shortcutChars.charAt(c)]=patternParts;}}}})();var nPatterns=fallthroughStylePatterns.length;return function(sourceCode,opt_basePos){opt_basePos=opt_basePos||0;var decorations=[opt_basePos,PR_PLAIN];var lastToken='';var pos=0;var tail=sourceCode;while(tail.length){var style;var token=null;var patternParts=shortcuts[tail.charAt(0)];if(patternParts){var match=tail.match(patternParts[1]);token=match[0];style=patternParts[0];}else{for(var i=0;i<nPatterns;++i){patternParts=fallthroughStylePatterns[i];var contextPattern=patternParts[2];if(contextPattern&&!contextPattern.test(lastToken)){continue;}var match=tail.match(patternParts[1]);if(match){token=match[0];style=patternParts[0];break;}}if(!token){style=PR_PLAIN;token=tail.substring(0,1);}}decorations.push(opt_basePos+pos,style);pos+=token.length;tail=tail.substring(token.length);if(style!==PR_COMMENT&&/\S/.test(token)){lastToken=token;}}return decorations;};}var PR_C_STYLE_STRING_AND_COMMENT_LEXER=PR_createSimpleLexer([[PR_STRING,/^\'(?:[^\\\']|\\[\s\S])*(?:\'|$)/,null,"'"],[PR_STRING,/^"(?:[^\\"]|\\[\s\S])*(?:"|$)/,null,'"'],[PR_STRING,/^\`(?:[^\\\`]|\\[\s\S])*(?:\`|$)/,null,'`']],[[PR_PLAIN,/^(?:[^\'"\`\/\#]+)/,null,' \r\n'],[PR_COMMENT,/^#[^\r\n]*/,null,'#'],[PR_COMMENT,/^\/\/[^\r\n]*/,null],[PR_STRING,/^\/(?:[^\\\*\/]|\\[\s\S])+(?:\/|$)/,REGEXP_PRECEDER_PATTERN],[PR_COMMENT,/^\/\*[\s\S]*?(?:\*\/|$)/,null]]);function PR_splitStringAndCommentTokens(sourceCode){return PR_C_STYLE_STRING_AND_COMMENT_LEXER(sourceCode);}var PR_C_STYLE_LITERAL_IDENTIFIER_PUNC_RECOGNIZER=PR_createSimpleLexer([],[[PR_PLAIN,/^\s+/,null,' \r\n'],[PR_PLAIN,/^[a-z_$@][a-z_$@0-9]*/i,null],[PR_LITERAL,/^0x[a-f0-9]+[a-z]/i,null],[PR_LITERAL,/^(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?[a-z]*/i,null,'123456789'],[PR_PUNCTUATION,/^[^\s\w\.$@]+/,null]]);function PR_splitNonStringNonCommentTokens(source,decorations){for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style===PR_PLAIN){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var chunk=source.substring(start,end);var subDecs=PR_C_STYLE_LITERAL_IDENTIFIER_PUNC_RECOGNIZER(chunk,start);for(var j=0,m=subDecs.length;j<m;j+=2){var subStyle=subDecs[j+1];if(subStyle===PR_PLAIN){var subStart=subDecs[j];var subEnd=j+2<m?subDecs[j+2]:chunk.length;var token=source.substring(subStart,subEnd);if(token=='.'){subDecs[j+1]=PR_PUNCTUATION;}else if(token in PR_keywords){subDecs[j+1]=PR_KEYWORD;}else if(/^@?[A-Z][A-Z$]*[a-z][A-Za-z$]*$/.test(token)){subDecs[j+1]=token.charAt(0)=='@'?PR_LITERAL:PR_TYPE;}}}PR_spliceArrayInto(subDecs,decorations,i,2);i+=subDecs.length-2;}}return decorations;}var PR_MARKUP_LEXER=PR_createSimpleLexer([],[[PR_PLAIN,/^[^<]+/,null],[PR_DECLARATION,/^<!\w[^>]*(?:>|$)/,null],[PR_COMMENT,/^<!--[\s\S]*?(?:-->|$)/,null],[PR_SOURCE,/^<\?[\s\S]*?(?:\?>|$)/,null],[PR_SOURCE,/^<%[\s\S]*?(?:%>|$)/,null],[PR_SOURCE,/^<(script|style|xmp)\b[^>]*>[\s\S]*?<\/\1\b[^>]*>/i,null],[PR_TAG,/^<\/?\w[^<>]*>/,null]]);var PR_SOURCE_CHUNK_PARTS=/^(<[^>]*>)([\s\S]*)(<\/[^>]*>)$/;function PR_tokenizeMarkup(source){var decorations=PR_MARKUP_LEXER(source);for(var i=0;i<decorations.length;i+=2){if(decorations[i+1]===PR_SOURCE){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var sourceChunk=source.substring(start,end);var match=(sourceChunk.match(PR_SOURCE_CHUNK_PARTS));if(match){decorations.splice(i,2,start,PR_TAG,start+match[1].length,PR_SOURCE,start+match[1].length+(match[2]||'').length,PR_TAG);}}}return decorations;}var PR_TAG_LEXER=PR_createSimpleLexer([[PR_ATTRIB_VALUE,/^\'[^\']*(?:\'|$)/,null,"'"],[PR_ATTRIB_VALUE,/^"[^"]*(?:"|$)/,null,'"'],[PR_PUNCTUATION,/^[<>\/=]+/,null,'<>/=']],[[PR_TAG,/^[\w-]+/,/^</],[PR_ATTRIB_VALUE,/^[\w-]+/,/^=/],[PR_ATTRIB_NAME,/^[\w-]+/,null],[PR_PLAIN,/^\s+/,null,' \r\n']]);function PR_splitTagAttributes(source,decorations){for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style===PR_TAG){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var chunk=source.substring(start,end);var subDecorations=PR_TAG_LEXER(chunk,start);PR_spliceArrayInto(subDecorations,decorations,i,2);i+=subDecorations.length-2;}}return decorations;}function PR_splitSourceNodes(source,decorations){for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style==PR_SOURCE){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var subDecorations=PR_decorateSource(source.substring(start,end));for(var j=0,m=subDecorations.length;j<m;j+=2){subDecorations[j]+=start;}PR_spliceArrayInto(subDecorations,decorations,i,2);i+=subDecorations.length-2;}}return decorations;}function PR_splitSourceAttributes(source,decorations){var nextValueIsSource=false;for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style===PR_ATTRIB_NAME){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;nextValueIsSource=/^on|^style$/i.test(source.substring(start,end));}else if(style==PR_ATTRIB_VALUE){if(nextValueIsSource){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var attribValue=source.substring(start,end);var attribLen=attribValue.length;var quoted=(attribLen>=2&&/^["\']/.test(attribValue)&&attribValue.charAt(0)===attribValue.charAt(attribLen-1));var attribSource;var attribSourceStart;var attribSourceEnd;if(quoted){attribSourceStart=start+1;attribSourceEnd=end-1;attribSource=attribValue;}else{attribSourceStart=start+1;attribSourceEnd=end-1;attribSource=attribValue.substring(1,attribValue.length-1);}var attribSourceDecorations=PR_decorateSource(attribSource);for(var j=0,m=attribSourceDecorations.length;j<m;j+=2){attribSourceDecorations[j]+=attribSourceStart;}if(quoted){attribSourceDecorations.push(attribSourceEnd,PR_ATTRIB_VALUE);PR_spliceArrayInto(attribSourceDecorations,decorations,i+2,0);}else{PR_spliceArrayInto(attribSourceDecorations,decorations,i,2);}}nextValueIsSource=false;}}return decorations;}function PR_decorateSource(sourceCode){var decorations=PR_splitStringAndCommentTokens(sourceCode);decorations=PR_splitNonStringNonCommentTokens(sourceCode,decorations);return decorations;}function PR_decorateMarkup(sourceCode){var decorations=PR_tokenizeMarkup(sourceCode);decorations=PR_splitTagAttributes(sourceCode,decorations);decorations=PR_splitSourceNodes(sourceCode,decorations);decorations=PR_splitSourceAttributes(sourceCode,decorations);return decorations;}function PR_recombineTagsAndDecorations(sourceText,extractedTags,decorations){var html=[];var outputIdx=0;var openDecoration=null;var currentDecoration=null;var tagPos=0;var decPos=0;var tabExpander=PR_tabExpander(PR_TAB_WIDTH);function emitTextUpTo(sourceIdx){if(sourceIdx>outputIdx){if(openDecoration&&openDecoration!==currentDecoration){html.push('</span>');openDecoration=null;}if(!openDecoration&¤tDecoration){openDecoration=currentDecoration;html.push('<span class="',openDecoration,'">');}var htmlChunk=PR_textToHtml(tabExpander(sourceText.substring(outputIdx,sourceIdx))).replace(/(\r\n?|\n| ) /g,'$1 ').replace(/\r\n?|\n/g,' <br>');html.push(htmlChunk);outputIdx=sourceIdx;}}while(true){var outputTag;if(tagPos<extractedTags.length){if(decPos<decorations.length){outputTag=extractedTags[tagPos]<=decorations[decPos];}else{outputTag=true;}}else{outputTag=false;}if(outputTag){emitTextUpTo(extractedTags[tagPos]);if(openDecoration){html.push('</span>');openDecoration=null;}html.push(extractedTags[tagPos+1]);tagPos+=2;}else if(decPos<decorations.length){emitTextUpTo(decorations[decPos]);currentDecoration=decorations[decPos+1];decPos+=2;}else{break;}}emitTextUpTo(sourceText.length);if(openDecoration){html.push('</span>');}return html.join('');}function prettyPrintOne(sourceCodeHtml){try{var sourceAndExtractedTags=PR_extractTags(sourceCodeHtml);var source=sourceAndExtractedTags.source;var extractedTags=sourceAndExtractedTags.tags;var isMarkup=/^\s*</.test(source)&&/>\s*$/.test(source);var decorations=isMarkup?PR_decorateMarkup(source):PR_decorateSource(source);return PR_recombineTagsAndDecorations(source,extractedTags,decorations);}catch(e){if('console'in window){console.log(e);console.trace();}return sourceCodeHtml;}}var PR_SHOULD_USE_CONTINUATION=true;function prettyPrint(opt_whenDone){var codeSegments=[document.getElementsByTagName('pre'),document.getElementsByTagName('code'),document.getElementsByTagName('xmp')];var elements=[];for(var i=0;i<codeSegments.length;++i){for(var j=0;j<codeSegments[i].length;++j){elements.push(codeSegments[i][j]);}}codeSegments=null;var k=0;function doWork(){var endTime=(PR_SHOULD_USE_CONTINUATION?new Date().getTime()+250:Infinity);for(;k<elements.length&&new Date().getTime()<endTime;k++){var cs=elements[k];if(cs.className&&cs.className.indexOf('prettyprint')>=0){var nested=false;for(var p=cs.parentNode;p!=null;p=p.parentNode){if((p.tagName=='pre'||p.tagName=='code'||p.tagName=='xmp')&&p.className&&p.className.indexOf('prettyprint')>=0){nested=true;break;}}if(!nested){var content=PR_getInnerHtml(cs);content=content.replace(/(?:\r\n?|\n)$/,'');var newContent=prettyPrintOne(content);if(!PR_isRawContent(cs)){cs.innerHTML=newContent;}else{var pre=document.createElement('PRE');for(var i=0;i<cs.attributes.length;++i){var a=cs.attributes[i];if(a.specified){pre.setAttribute(a.name,a.value);}}pre.innerHTML=newContent;cs.parentNode.replaceChild(pre,cs);}}}}if(k<elements.length){setTimeout(doWork,250);}else if(opt_whenDone){opt_whenDone();}}doWork();}</script><script type='text/javascript'>prettyPrint();</script></BODY> | |
| </HTML> |