<!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:04 PKT 2011 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
Context (Click Framework API - v2.3.0) | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.click.Context class"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="Context (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/ClickServlet.html" title="class in org.apache.click"><B>PREV CLASS</B></A> | |
<A HREF="../../../org/apache/click/Control.html" title="interface in org.apache.click"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../index.html?org/apache/click/Context.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="Context.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</FONT> | |
<BR> | |
Class Context</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.Context</B> | |
</PRE> | |
<HR> | |
<DL> | |
<DT><PRE>public class <B>Context</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 the HTTP request context information for pages and controls. | |
A new Context object is created for each Page request. The request Context | |
object can be obtained from the thread local variable via the | |
<A HREF="../../../org/apache/click/Context.html#getThreadLocalContext()"><CODE>getThreadLocalContext()</CODE></A> method. | |
<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>protected <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletConfig.html" title="class or interface in javax.servlet">ServletConfig</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#config">config</A></B></CODE> | |
<BR> | |
The servlet config.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <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></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#context">context</A></B></CODE> | |
<BR> | |
The servlet context.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#isPost">isPost</A></B></CODE> | |
<BR> | |
The HTTP method is POST flag.</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/Context.html#LOCALE">LOCALE</A></B></CODE> | |
<BR> | |
The user's session Locale key: <tt>locale</tt>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <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></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#response">response</A></B></CODE> | |
<BR> | |
The servlet response.</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/Context.html#Context(javax.servlet.ServletContext, javax.servlet.ServletConfig, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, boolean, org.apache.click.ClickServlet)">Context</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> context, | |
<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletConfig.html" title="class or interface in javax.servlet">ServletConfig</A> config, | |
<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, | |
boolean isPost, | |
<A HREF="../../../org/apache/click/ClickServlet.html" title="class in org.apache.click">ClickServlet</A> clickServlet)</CODE> | |
<BR> | |
Create a new request context.</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> <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/Context.html#createMessagesMap(java.lang.Class, java.lang.String)">createMessagesMap</A></B>(<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><?> baseClass, | |
<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> globalResource)</CODE> | |
<BR> | |
Return a new messages map for the given baseClass (a page or control) | |
and the given global resource bundle name.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> | |
<TR ALIGN="right" VALIGN=""> | |
<TD NOWRAP><FONT SIZE="-1"> | |
<CODE><T extends <A HREF="../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A>> | |
<BR> | |
T</CODE></FONT></TD> | |
</TR> | |
</TABLE> | |
</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#createPage(java.lang.Class)">createPage</A></B>(<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><T> pageClass)</CODE> | |
<BR> | |
Return a new Page instance for the given class.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> | |
<TR ALIGN="right" VALIGN=""> | |
<TD NOWRAP><FONT SIZE="-1"> | |
<CODE><T extends <A HREF="../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A>> | |
<BR> | |
T</CODE></FONT></TD> | |
</TR> | |
</TABLE> | |
</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#createPage(java.lang.String)">createPage</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> path)</CODE> | |
<BR> | |
Return a new Page instance for the given path.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getApplicationMode()">getApplicationMode</A></B>()</CODE> | |
<BR> | |
Return the Click application mode value: | |
<tt>["production", "profile", "development", "debug", "trace"]</tt>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getCharset()">getCharset</A></B>()</CODE> | |
<BR> | |
Return the Click application charset or ISO-8859-1 if not is defined.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <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/Context.html#getCookie(java.lang.String)">getCookie</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 the cookie for the given name or null if not found.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getCookieValue(java.lang.String)">getCookieValue</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 the cookie value for the given name or null if not found.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://jakarta.apache.org/commons/fileupload/apidocs/org/apache/commons/fileupload/FileItem.html" title="class or interface in org.apache.commons.fileupload">FileItem</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getFileItem(java.lang.String)">getFileItem</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> | |
Returns the value of a request parameter as a FileItem, for | |
"multipart" POST requests (file uploads), or null if the parameter | |
is not found.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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://jakarta.apache.org/commons/fileupload/apidocs/org/apache/commons/fileupload/FileItem.html" title="class or interface in org.apache.commons.fileupload">FileItem</A>[]></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getFileItemMap()">getFileItemMap</A></B>()</CODE> | |
<BR> | |
Returns a map of <tt>FileItem arrays</tt> keyed on request parameter | |
name for "multipart" POST requests (file uploads).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getLocale()">getLocale</A></B>()</CODE> | |
<BR> | |
Return the users Locale.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A><? extends <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/Context.html#getPageClass(java.lang.String)">getPageClass</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> path)</CODE> | |
<BR> | |
Return the page <tt>Class</tt> for the given path.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getPagePath(java.lang.Class)">getPagePath</A></B>(<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/Page.html" title="class in org.apache.click">Page</A>> pageClass)</CODE> | |
<BR> | |
Return the path for the given page Class.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <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></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getRequest()">getRequest</A></B>()</CODE> | |
<BR> | |
Returns the servlet request.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getRequestAttribute(java.lang.String)">getRequestAttribute</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 the named request attribute, or null if not defined.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getRequestParameter(java.lang.String)">getRequestParameter</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 the named request parameter.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getRequestParameterValues(java.lang.String)">getRequestParameterValues</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> | |
Returns an array of String objects containing all of the values the given | |
request parameter has, or null if the parameter does not exist.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getResourcePath()">getResourcePath</A></B>()</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> <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></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getResponse()">getResponse</A></B>()</CODE> | |
<BR> | |
Returns the servlet response.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletConfig.html" title="class or interface in javax.servlet">ServletConfig</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getServletConfig()">getServletConfig</A></B>()</CODE> | |
<BR> | |
Returns the servlet config.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <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></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getServletContext()">getServletContext</A></B>()</CODE> | |
<BR> | |
Returns the servlet context.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <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">HttpSession</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getSession()">getSession</A></B>()</CODE> | |
<BR> | |
Return the user's HttpSession, creating one if necessary.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#getSessionAttribute(java.lang.String)">getSessionAttribute</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 the named session attribute, or null if not defined.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static <A HREF="../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#getThreadLocalContext()">getThreadLocalContext</A></B>()</CODE> | |
<BR> | |
Return the thread local request context instance.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#hasRequestAttribute(java.lang.String)">hasRequestAttribute</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 true if the request contains the named attribute.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#hasRequestParameter(java.lang.String)">hasRequestParameter</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 true if the request contains the named parameter.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#hasSession()">hasSession</A></B>()</CODE> | |
<BR> | |
Return true if a HttpSession exists, or false otherwise.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#hasSessionAttribute(java.lang.String)">hasSessionAttribute</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 true if there is a session and it contains the named attribute.</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/Context.html#hasThreadLocalContext()">hasThreadLocalContext</A></B>()</CODE> | |
<BR> | |
Returns true if a Context instance is available on the current thread, | |
false otherwise.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#invalidateCookie(java.lang.String)">invalidateCookie</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> | |
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> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#isAjaxRequest()">isAjaxRequest</A></B>()</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> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#isForward()">isForward</A></B>()</CODE> | |
<BR> | |
Return true if the request has been forwarded.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#isGet()">isGet</A></B>()</CODE> | |
<BR> | |
Return true if the HTTP request method is "GET".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#isMultipartRequest()">isMultipartRequest</A></B>()</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> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#isPost()">isPost</A></B>()</CODE> | |
<BR> | |
Return true if the HTTP request method is "POST".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#removeSessionAttribute(java.lang.String)">removeSessionAttribute</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> | |
Remove the named attribute from the session.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#renderTemplate(java.lang.Class, java.util.Map)">renderTemplate</A></B>(<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> templateClass, | |
<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>,?> model)</CODE> | |
<BR> | |
Return a rendered Velocity template and model for the given | |
class and model data.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.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/Context.html#renderTemplate(java.lang.String, java.util.Map)">renderTemplate</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> templatePath, | |
<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>,?> model)</CODE> | |
<BR> | |
Return a rendered Velocity template and model data.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <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/Context.html#setCookie(java.lang.String, java.lang.String, int)">setCookie</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/String.html" title="class or interface in java.lang">String</A> value, | |
int maxAge)</CODE> | |
<BR> | |
Sets the given cookie value in the servlet response with the path "/".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#setFlashAttribute(java.lang.String, java.lang.Object)">setFlashAttribute</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/Object.html" title="class or interface in java.lang">Object</A> value)</CODE> | |
<BR> | |
This method will set the named object as a flash HttpSession object.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#setLocale(java.util.Locale)">setLocale</A></B>(<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> | |
This method stores the given Locale in the users session.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#setRequestAttribute(java.lang.String, java.lang.Object)">setRequestAttribute</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/Object.html" title="class or interface in java.lang">Object</A> value)</CODE> | |
<BR> | |
This method will set the named object in the HTTP request.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../org/apache/click/Context.html#setSessionAttribute(java.lang.String, java.lang.Object)">setSessionAttribute</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/Object.html" title="class or interface in java.lang">Object</A> value)</CODE> | |
<BR> | |
This method will set the named object in the HttpSession.</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="LOCALE"><!-- --></A><H3> | |
LOCALE</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>LOCALE</B></PRE> | |
<DL> | |
<DD>The user's session Locale key: <tt>locale</tt>. | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.click.Context.LOCALE">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="context"><!-- --></A><H3> | |
context</H3> | |
<PRE> | |
protected final <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> <B>context</B></PRE> | |
<DL> | |
<DD>The servlet context. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="config"><!-- --></A><H3> | |
config</H3> | |
<PRE> | |
protected final <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletConfig.html" title="class or interface in javax.servlet">ServletConfig</A> <B>config</B></PRE> | |
<DL> | |
<DD>The servlet config. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="isPost"><!-- --></A><H3> | |
isPost</H3> | |
<PRE> | |
protected final boolean <B>isPost</B></PRE> | |
<DL> | |
<DD>The HTTP method is POST flag. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="response"><!-- --></A><H3> | |
response</H3> | |
<PRE> | |
protected final <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> <B>response</B></PRE> | |
<DL> | |
<DD>The servlet response. | |
<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="Context(javax.servlet.ServletContext, javax.servlet.ServletConfig, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, boolean, org.apache.click.ClickServlet)"><!-- --></A><H3> | |
Context</H3> | |
<PRE> | |
public <B>Context</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> context, | |
<A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletConfig.html" title="class or interface in javax.servlet">ServletConfig</A> config, | |
<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, | |
boolean isPost, | |
<A HREF="../../../org/apache/click/ClickServlet.html" title="class in org.apache.click">ClickServlet</A> clickServlet)</PRE> | |
<DL> | |
<DD>Create a new request context. | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the servlet context<DD><CODE>config</CODE> - the servlet config<DD><CODE>request</CODE> - the servlet request<DD><CODE>response</CODE> - the servlet response<DD><CODE>isPost</CODE> - the servlet request is a POST<DD><CODE>clickServlet</CODE> - the click servlet instance</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="getThreadLocalContext()"><!-- --></A><H3> | |
getThreadLocalContext</H3> | |
<PRE> | |
public static <A HREF="../../../org/apache/click/Context.html" title="class in org.apache.click">Context</A> <B>getThreadLocalContext</B>()</PRE> | |
<DL> | |
<DD>Return the thread local request context instance. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the thread local request context instance. | |
<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 Context is not available on the thread.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasThreadLocalContext()"><!-- --></A><H3> | |
hasThreadLocalContext</H3> | |
<PRE> | |
public static boolean <B>hasThreadLocalContext</B>()</PRE> | |
<DL> | |
<DD>Returns true if a Context instance is available on the current thread, | |
false otherwise. Unlike <A HREF="../../../org/apache/click/Context.html#getThreadLocalContext()"><CODE>getThreadLocalContext()</CODE></A> this method | |
can safely be used and will not throw an exception if Context is not | |
available on the current thread. | |
<p/> | |
This method is very useful inside a <A HREF="../../../org/apache/click/Control.html" title="interface in org.apache.click"><CODE>Control</CODE></A> constructor which | |
might need access to the Context. As Controls could potentially be | |
instantiated during Click startup (in order to deploy their resources), | |
this check can be used to determine whether Context is available or not. | |
<p/> | |
For example: | |
<pre class="prettyprint"> | |
public MyControl extends AbstractControl { | |
public MyControl(String name) { | |
if (Context.hasThreadLocalContext()) { | |
// Context is available, meaning a user initiated a web | |
// request | |
Context context = getContext(); | |
String state = (String) context.getSessionAttribute(name); | |
setValue(state); | |
} else { | |
// No Context is available, meaning this is most probably | |
// the application startup and deployment phase. | |
} | |
} | |
} | |
</pre> | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if a Context instance is available on the current thread, | |
false otherwise</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRequest()"><!-- --></A><H3> | |
getRequest</H3> | |
<PRE> | |
public <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> <B>getRequest</B>()</PRE> | |
<DL> | |
<DD>Returns the servlet request. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>HttpServletRequest</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getResponse()"><!-- --></A><H3> | |
getResponse</H3> | |
<PRE> | |
public <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> <B>getResponse</B>()</PRE> | |
<DL> | |
<DD>Returns the servlet response. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>HttpServletResponse</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getServletConfig()"><!-- --></A><H3> | |
getServletConfig</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/servlet/ServletConfig.html" title="class or interface in javax.servlet">ServletConfig</A> <B>getServletConfig</B>()</PRE> | |
<DL> | |
<DD>Returns the servlet config. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>ServletConfig</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getServletContext()"><!-- --></A><H3> | |
getServletContext</H3> | |
<PRE> | |
public <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> <B>getServletContext</B>()</PRE> | |
<DL> | |
<DD>Returns the servlet context. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>ServletContext</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSession()"><!-- --></A><H3> | |
getSession</H3> | |
<PRE> | |
public <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">HttpSession</A> <B>getSession</B>()</PRE> | |
<DL> | |
<DD>Return the user's HttpSession, creating one if necessary. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the user's HttpSession, creating one if necessary.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getResourcePath()"><!-- --></A><H3> | |
getResourcePath</H3> | |
<PRE> | |
public <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>()</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>Returns:</B><DD>the page resource path from the request</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isForward()"><!-- --></A><H3> | |
isForward</H3> | |
<PRE> | |
public boolean <B>isForward</B>()</PRE> | |
<DL> | |
<DD>Return true if the request has been forwarded. A forwarded request | |
will contain a <A HREF="../../../org/apache/click/ClickServlet.html#CLICK_FORWARD"><CODE>ClickServlet.CLICK_FORWARD</CODE></A> request attribute. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the request has been forwarded</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isPost()"><!-- --></A><H3> | |
isPost</H3> | |
<PRE> | |
public boolean <B>isPost</B>()</PRE> | |
<DL> | |
<DD>Return true if the HTTP request method is "POST". | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the HTTP request method is "POST"</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isGet()"><!-- --></A><H3> | |
isGet</H3> | |
<PRE> | |
public boolean <B>isGet</B>()</PRE> | |
<DL> | |
<DD>Return true if the HTTP request method is "GET". | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the HTTP request method is "GET"</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isAjaxRequest()"><!-- --></A><H3> | |
isAjaxRequest</H3> | |
<PRE> | |
public boolean <B>isAjaxRequest</B>()</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>Returns:</B><DD>true if this is an Ajax request, false otherwise</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasRequestAttribute(java.lang.String)"><!-- --></A><H3> | |
hasRequestAttribute</H3> | |
<PRE> | |
public boolean <B>hasRequestAttribute</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 true if the request contains the named attribute. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the request attribute | |
<DT><B>Returns:</B><DD>true if the request contains the named attribute</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRequestAttribute(java.lang.String)"><!-- --></A><H3> | |
getRequestAttribute</H3> | |
<PRE> | |
public <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>getRequestAttribute</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 the named request attribute, or null if not defined. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the request attribute | |
<DT><B>Returns:</B><DD>the named request attribute, or null if not defined</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setRequestAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
setRequestAttribute</H3> | |
<PRE> | |
public void <B>setRequestAttribute</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/Object.html" title="class or interface in java.lang">Object</A> value)</PRE> | |
<DL> | |
<DD>This method will set the named object in the HTTP request. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the storage name for the object in the request<DD><CODE>value</CODE> - the object to store in the request</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasRequestParameter(java.lang.String)"><!-- --></A><H3> | |
hasRequestParameter</H3> | |
<PRE> | |
public boolean <B>hasRequestParameter</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 true if the request contains the named parameter. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the request parameter | |
<DT><B>Returns:</B><DD>true if the request contains the named parameter</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRequestParameter(java.lang.String)"><!-- --></A><H3> | |
getRequestParameter</H3> | |
<PRE> | |
public <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>getRequestParameter</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 the named request parameter. This method supports | |
<tt>"multipart/form-data"</tt> POST requests and should be used in | |
preference to the <tt>HttpServletRequest</tt> method | |
<tt>getParameter()</tt>. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the request parameter | |
<DT><B>Returns:</B><DD>the value of the request parameter.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/click/control/Form.html#onProcess()"><CODE>Form.onProcess()</CODE></A>, | |
<A HREF="../../../org/apache/click/Context.html#isMultipartRequest()"><CODE>isMultipartRequest()</CODE></A>, | |
<A HREF="../../../org/apache/click/Context.html#getFileItemMap()"><CODE>getFileItemMap()</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRequestParameterValues(java.lang.String)"><!-- --></A><H3> | |
getRequestParameterValues</H3> | |
<PRE> | |
public <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>getRequestParameterValues</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>Returns an array of String objects containing all of the values the given | |
request parameter has, or null if the parameter does not exist. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <tt>String</tt> containing the name of the parameter whose | |
value is requested | |
<DT><B>Returns:</B><DD>an array of <tt>String</tt> objects containing the parameter's values</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSessionAttribute(java.lang.String)"><!-- --></A><H3> | |
getSessionAttribute</H3> | |
<PRE> | |
public <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>getSessionAttribute</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 the named session attribute, or null if not defined. | |
<p/> | |
If the session is not defined this method will return null, and a | |
session will not be created. | |
<p/> | |
This method supports <A HREF="../../../org/apache/click/util/FlashAttribute.html" title="class in org.apache.click.util"><CODE>FlashAttribute</CODE></A> which when accessed are then | |
removed from the session. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the session attribute | |
<DT><B>Returns:</B><DD>the named session attribute, or null if not defined</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setSessionAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
setSessionAttribute</H3> | |
<PRE> | |
public void <B>setSessionAttribute</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/Object.html" title="class or interface in java.lang">Object</A> value)</PRE> | |
<DL> | |
<DD>This method will set the named object in the HttpSession. | |
<p/> | |
This method will create a session if one does not already exist. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the storage name for the object in the session<DD><CODE>value</CODE> - the object to store in the session</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="removeSessionAttribute(java.lang.String)"><!-- --></A><H3> | |
removeSessionAttribute</H3> | |
<PRE> | |
public void <B>removeSessionAttribute</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>Remove the named attribute from the session. If the session does not | |
exist or the name is null, this method does nothing. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - of the attribute to remove from the session</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasSessionAttribute(java.lang.String)"><!-- --></A><H3> | |
hasSessionAttribute</H3> | |
<PRE> | |
public boolean <B>hasSessionAttribute</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 true if there is a session and it contains the named attribute. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the attribute | |
<DT><B>Returns:</B><DD>true if the session contains the named attribute</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasSession()"><!-- --></A><H3> | |
hasSession</H3> | |
<PRE> | |
public boolean <B>hasSession</B>()</PRE> | |
<DL> | |
<DD>Return true if a HttpSession exists, or false otherwise. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if a HttpSession exists, or false otherwise</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setFlashAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
setFlashAttribute</H3> | |
<PRE> | |
public void <B>setFlashAttribute</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/Object.html" title="class or interface in java.lang">Object</A> value)</PRE> | |
<DL> | |
<DD>This method will set the named object as a flash HttpSession object. | |
<p/> | |
The flash object will exist in the session until it is accessed once, | |
and then removed. Flash objects are typically used to display a message | |
once. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the storage name for the object in the session<DD><CODE>value</CODE> - the object to store in the session</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCookie(java.lang.String)"><!-- --></A><H3> | |
getCookie</H3> | |
<PRE> | |
public <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/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 cookie for the given name or null if not found. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the cookie | |
<DT><B>Returns:</B><DD>the cookie for the given name or null if not found</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCookieValue(java.lang.String)"><!-- --></A><H3> | |
getCookieValue</H3> | |
<PRE> | |
public <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/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 cookie value for the given name or null if not found. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the cookie | |
<DT><B>Returns:</B><DD>the cookie value for the given name or null if not found</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setCookie(java.lang.String, java.lang.String, int)"><!-- --></A><H3> | |
setCookie</H3> | |
<PRE> | |
public <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/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)</PRE> | |
<DL> | |
<DD>Sets the given cookie value in the servlet response with the path "/". | |
<p/> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><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. | |
<DT><B>Returns:</B><DD>the Cookie object created and set in the response<DT><B>See Also:</B><DD><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)"><CODE>ClickUtils.setCookie(HttpServletRequest, HttpServletResponse, String, String, int, String)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="invalidateCookie(java.lang.String)"><!-- --></A><H3> | |
invalidateCookie</H3> | |
<PRE> | |
public void <B>invalidateCookie</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>Invalidate the specified cookie and delete it from the response object. | |
Deletes only cookies mapped against the root "/" path. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</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)"><CODE>ClickUtils.invalidateCookie(HttpServletRequest, HttpServletResponse, String)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createPage(java.lang.String)"><!-- --></A><H3> | |
createPage</H3> | |
<PRE> | |
public <T extends <A HREF="../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A>> T <B>createPage</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> path)</PRE> | |
<DL> | |
<DD>Return a new Page instance for the given path. | |
<p/> | |
This method can be used to create a target page for the | |
<A HREF="../../../org/apache/click/Page.html#setForward(org.apache.click.Page)"><CODE>Page.setForward(Page)</CODE></A>, for example: | |
<pre class="codeJava"> | |
UserEdit userEdit = (UserEdit) getContext().createPage(<span class="st">"/user-edit.htm"</span>); | |
userEdit.setUser(user); | |
setForward(userEdit); </pre> | |
The given page path must start with a <tt>'/'</tt>. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the Page path as configured in the click.xml file | |
<DT><B>Returns:</B><DD>a new Page object | |
<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 the Page is not found</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createPage(java.lang.Class)"><!-- --></A><H3> | |
createPage</H3> | |
<PRE> | |
public <T extends <A HREF="../../../org/apache/click/Page.html" title="class in org.apache.click">Page</A>> T <B>createPage</B>(<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><T> pageClass)</PRE> | |
<DL> | |
<DD>Return a new Page instance for the given class. | |
<p/> | |
This method can be used to create a target page for the | |
<A HREF="../../../org/apache/click/Page.html#setForward(org.apache.click.Page)"><CODE>Page.setForward(Page)</CODE></A>, for example: | |
<pre class="codeJava"> | |
UserEdit userEdit = (UserEdit) getContext().createPage(UserEdit.<span class="kw">class</span>); | |
userEdit.setUser(user); | |
setForward(userEdit); </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>pageClass</CODE> - the Page class as configured in the click.xml file | |
<DT><B>Returns:</B><DD>a new Page object | |
<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 the Page is not found, or is not | |
configured with a unique path</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getPagePath(java.lang.Class)"><!-- --></A><H3> | |
getPagePath</H3> | |
<PRE> | |
public <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>getPagePath</B>(<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/Page.html" title="class in org.apache.click">Page</A>> pageClass)</PRE> | |
<DL> | |
<DD>Return the path for the given page Class. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>pageClass</CODE> - the class of the Page to lookup the path for | |
<DT><B>Returns:</B><DD>the path for the given page Class | |
<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 the Page Class is not configured | |
with a unique path</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getPageClass(java.lang.String)"><!-- --></A><H3> | |
getPageClass</H3> | |
<PRE> | |
public <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/Page.html" title="class in org.apache.click">Page</A>> <B>getPageClass</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> path)</PRE> | |
<DL> | |
<DD>Return the page <tt>Class</tt> for the given path. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the page path | |
<DT><B>Returns:</B><DD>the page class for the given path | |
<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 the Page Class for the path is not | |
found</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getApplicationMode()"><!-- --></A><H3> | |
getApplicationMode</H3> | |
<PRE> | |
public <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>getApplicationMode</B>()</PRE> | |
<DL> | |
<DD>Return the Click application mode value: | |
<tt>["production", "profile", "development", "debug", "trace"]</tt>. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the application mode value</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCharset()"><!-- --></A><H3> | |
getCharset</H3> | |
<PRE> | |
public <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>getCharset</B>()</PRE> | |
<DL> | |
<DD>Return the Click application charset or ISO-8859-1 if not is defined. | |
<p/> | |
The charset is defined in click.xml through the charset attribute | |
on the click-app element. | |
<pre class="codeConfig"> | |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> | |
<click-app <span class="blue">charset</span>="<span class="red">UTF-8</span>"> | |
.. | |
</click-app> </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the application charset or ISO-8859-1 if not defined</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="createMessagesMap(java.lang.Class, java.lang.String)"><!-- --></A><H3> | |
createMessagesMap</H3> | |
<PRE> | |
public <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>createMessagesMap</B>(<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><?> baseClass, | |
<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> globalResource)</PRE> | |
<DL> | |
<DD>Return a new messages map for the given baseClass (a page or control) | |
and the given global resource bundle name. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>baseClass</CODE> - the target class<DD><CODE>globalResource</CODE> - the global resource bundle name | |
<DT><B>Returns:</B><DD>a new messages map with the messages for the target.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFileItemMap()"><!-- --></A><H3> | |
getFileItemMap</H3> | |
<PRE> | |
public <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://jakarta.apache.org/commons/fileupload/apidocs/org/apache/commons/fileupload/FileItem.html" title="class or interface in org.apache.commons.fileupload">FileItem</A>[]> <B>getFileItemMap</B>()</PRE> | |
<DL> | |
<DD>Returns a map of <tt>FileItem arrays</tt> keyed on request parameter | |
name for "multipart" POST requests (file uploads). Thus each map entry | |
will consist of one or more <tt>FileItem</tt> objects. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>map of <tt>FileItem arrays</tt> keyed on request parameter name | |
for "multipart" POST requests</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFileItem(java.lang.String)"><!-- --></A><H3> | |
getFileItem</H3> | |
<PRE> | |
public <A HREF="http://jakarta.apache.org/commons/fileupload/apidocs/org/apache/commons/fileupload/FileItem.html" title="class or interface in org.apache.commons.fileupload">FileItem</A> <B>getFileItem</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>Returns the value of a request parameter as a FileItem, for | |
"multipart" POST requests (file uploads), or null if the parameter | |
is not found. | |
<p/> | |
If there were multivalued parameters in the request (ie two or more | |
file upload fields with the same name), the first fileItem | |
in the array is returned. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the parameter of the fileItem to retrieve | |
<DT><B>Returns:</B><DD>the fileItem for the specified name</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getLocale()"><!-- --></A><H3> | |
getLocale</H3> | |
<PRE> | |
public <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> <B>getLocale</B>()</PRE> | |
<DL> | |
<DD>Return the users Locale. | |
<p/> | |
If the users Locale is stored in their session this will be returned. | |
Else if the click-app configuration defines a default Locale this | |
value will be returned, otherwise the request's Locale will be returned. | |
<p/> | |
To override the default request Locale set the users Locale using the | |
<A HREF="../../../org/apache/click/Context.html#setLocale(java.util.Locale)"><CODE>setLocale(Locale)</CODE></A> method. | |
<p/> | |
Pages and Controls obtain the users Locale using this method. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the users Locale in the session, or if null the request Locale</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setLocale(java.util.Locale)"><!-- --></A><H3> | |
setLocale</H3> | |
<PRE> | |
public void <B>setLocale</B>(<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>This method stores the given Locale in the users session. If the given | |
Locale is null, the "locale" attribute will be removed from the session. | |
<p/> | |
The Locale object is stored in the session using the <A HREF="../../../org/apache/click/Context.html#LOCALE"><CODE>LOCALE</CODE></A> | |
key. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the Locale to store in the users session using the key | |
"locale"</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isMultipartRequest()"><!-- --></A><H3> | |
isMultipartRequest</H3> | |
<PRE> | |
public boolean <B>isMultipartRequest</B>()</PRE> | |
<DL> | |
<DD>Return true if the request is a multi-part content type POST request. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true if the request is a multi-part content type POST request</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="renderTemplate(java.lang.Class, java.util.Map)"><!-- --></A><H3> | |
renderTemplate</H3> | |
<PRE> | |
public <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>renderTemplate</B>(<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> templateClass, | |
<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>,?> model)</PRE> | |
<DL> | |
<DD>Return a rendered Velocity template and model for the given | |
class and model data. | |
<p/> | |
This method will merge the class <tt>.htm</tt> Velocity template and | |
model data using the applications Velocity Engine. | |
<p/> | |
An example of the class template resolution is provided below: | |
<pre class="codeConfig"> | |
<span class="cm">// Full class name</span> | |
com.mycorp.control.CustomTextField | |
<span class="cm">// Template path name</span> | |
/com/mycorp/control/CustomTextField.htm </pre> | |
Example method usage: | |
<pre class="codeJava"> | |
<span class="kw">public String</span> toString() { | |
Map model = getModel(); | |
<span class="kw">return</span> getContext().renderTemplate(getClass(), model); | |
} </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>templateClass</CODE> - the class to resolve the template for<DD><CODE>model</CODE> - the model data to merge with the template | |
<DT><B>Returns:</B><DD>rendered Velocity template merged with the model data | |
<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 an error occurs</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="renderTemplate(java.lang.String, java.util.Map)"><!-- --></A><H3> | |
renderTemplate</H3> | |
<PRE> | |
public <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>renderTemplate</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> templatePath, | |
<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>,?> model)</PRE> | |
<DL> | |
<DD>Return a rendered Velocity template and model data. | |
<p/> | |
Example method usage: | |
<pre class="codeJava"> | |
<span class="kw">public String</span> toString() { | |
Map model = getModel(); | |
<span class="kw">return</span> getContext().renderTemplate(<span class="st">"/custom-table.htm"</span>, model); | |
} </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>templatePath</CODE> - the path of the Velocity template to render<DD><CODE>model</CODE> - the model data to merge with the template | |
<DT><B>Returns:</B><DD>rendered Velocity template merged with the model data | |
<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 an error occurs</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/ClickServlet.html" title="class in org.apache.click"><B>PREV CLASS</B></A> | |
<A HREF="../../../org/apache/click/Control.html" title="interface in org.apache.click"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../index.html?org/apache/click/Context.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="Context.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> |