| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_06) on Fri Jun 05 14:31:19 PDT 2009 --> |
| <TITLE> |
| DTFacesContext |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-06-05"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DTFacesContext"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTFacesContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.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/eclipse/jst/jsf/designtime/context/DefaultDTExternalContextFactory.html" title="class in org.eclipse.jst.jsf.designtime.context"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTJSPExternalContext.html" title="class in org.eclipse.jst.jsf.designtime.context"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/jst/jsf/designtime/context/DTFacesContext.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DTFacesContext.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.jst.jsf.designtime.context</FONT> |
| <BR> |
| Class DTFacesContext</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.jst.jsf.designtime.context.DTFacesContext</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public final class <B>DTFacesContext</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Represents a design-time version of the JSF FacesContext for a particular web |
| application. |
| |
| Client may not sub-class. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTFacesContext.html#DTFacesContext(IAdaptable, org.eclipse.jst.jsf.designtime.context.IExternalContextFactoryLocator)">DTFacesContext</A></B>(IAdaptable contextObject, |
| <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/IExternalContextFactoryLocator.html" title="interface in org.eclipse.jst.jsf.designtime.context">IExternalContextFactoryLocator</A> locator)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTFacesContext.html#DTFacesContext(org.eclipse.jst.jsf.designtime.context.IExternalContextFactoryLocator)">DTFacesContext</A></B>(<A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/IExternalContextFactoryLocator.html" title="interface in org.eclipse.jst.jsf.designtime.context">IExternalContextFactoryLocator</A> locator)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use DTFacesContext(IAdaptable, |
| IExternalContextFactoryLocator)</I></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> IResource</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTFacesContext.html#adaptContextObject()">adaptContextObject</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/IDTExternalContext.html" title="interface in org.eclipse.jst.jsf.designtime.context">IDTExternalContext</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTFacesContext.html#getDTExternalContext(IAdaptable)">getDTExternalContext</A></B>(IAdaptable contextObject)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTFacesContext.html#getLocaleString()">getLocaleString</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use IDTViewHandler.calculateLocale instead</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.eclipse.jst.jsf.designtime.internal.view.IViewRootHandle</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTFacesContext.html#getViewRootHandle()">getViewRootHandle</A></B>()</CODE> |
| |
| <BR> |
| |
| Returns a new copy of the view root handle.</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/eclipse/jst/jsf/designtime/context/DTFacesContext.html#initialize(org.eclipse.jst.jsf.common.internal.resource.LifecycleListener)">initialize</A></B>(org.eclipse.jst.jsf.common.internal.resource.LifecycleListener lifecycleListener)</CODE> |
| |
| <BR> |
| THIS IS NOT AN API METHOD.</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/eclipse/jst/jsf/designtime/context/DTFacesContext.html#setLocaleString(java.lang.String)">setLocaleString</A></B>(java.lang.String newLocaleString)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use IDTViewHandler.calculateLocale instead</I></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.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DTFacesContext(IAdaptable, org.eclipse.jst.jsf.designtime.context.IExternalContextFactoryLocator)"><!-- --></A><H3> |
| DTFacesContext</H3> |
| <PRE> |
| public <B>DTFacesContext</B>(IAdaptable contextObject, |
| <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/IExternalContextFactoryLocator.html" title="interface in org.eclipse.jst.jsf.designtime.context">IExternalContextFactoryLocator</A> locator)</PRE> |
| <DL> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>contextObject</CODE> - <DD><CODE>locator</CODE> - </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DTFacesContext(org.eclipse.jst.jsf.designtime.context.IExternalContextFactoryLocator)"><!-- --></A><H3> |
| DTFacesContext</H3> |
| <PRE> |
| <FONT SIZE="-1">@Deprecated |
| </FONT>public <B>DTFacesContext</B>(<A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/IExternalContextFactoryLocator.html" title="interface in org.eclipse.jst.jsf.designtime.context">IExternalContextFactoryLocator</A> locator)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use DTFacesContext(IAdaptable, |
| IExternalContextFactoryLocator)</I> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>locator</CODE> - </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="initialize(org.eclipse.jst.jsf.common.internal.resource.LifecycleListener)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| public void <B>initialize</B>(org.eclipse.jst.jsf.common.internal.resource.LifecycleListener lifecycleListener)</PRE> |
| <DL> |
| <DD>THIS IS NOT AN API METHOD. External clients must not call. |
| |
| initilaize the faces context. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>lifecycleListener</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDTExternalContext(IAdaptable)"><!-- --></A><H3> |
| getDTExternalContext</H3> |
| <PRE> |
| public <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/IDTExternalContext.html" title="interface in org.eclipse.jst.jsf.designtime.context">IDTExternalContext</A> <B>getDTExternalContext</B>(IAdaptable contextObject)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contextObject</CODE> - -- |
| the object corresponding to the external context. Usually an |
| IFile point to a file containing the external context. It must |
| be adaptable to an IFile. |
| <DT><B>Returns:</B><DD>the designtime external context or null if one is not defined for |
| this contextObject</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getViewRootHandle()"><!-- --></A><H3> |
| getViewRootHandle</H3> |
| <PRE> |
| public org.eclipse.jst.jsf.designtime.internal.view.IViewRootHandle <B>getViewRootHandle</B>()</PRE> |
| <DL> |
| <DD><p> |
| Returns a new copy of the view root handle. |
| </p> |
| |
| return null if the value of the view root |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the cached view root. May be null.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLocaleString()"><!-- --></A><H3> |
| getLocaleString</H3> |
| <PRE> |
| <FONT SIZE="-1">@Deprecated |
| </FONT>public java.lang.String <B>getLocaleString</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use IDTViewHandler.calculateLocale instead</I> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current locale string</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLocaleString(java.lang.String)"><!-- --></A><H3> |
| setLocaleString</H3> |
| <PRE> |
| <FONT SIZE="-1">@Deprecated |
| </FONT>public void <B>setLocaleString</B>(java.lang.String newLocaleString)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use IDTViewHandler.calculateLocale instead</I> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>newLocaleString</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="adaptContextObject()"><!-- --></A><H3> |
| adaptContextObject</H3> |
| <PRE> |
| public IResource <B>adaptContextObject</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the resource correspondinng to context object or null if it |
| cannot be adapted to an IResource</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTFacesContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.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/eclipse/jst/jsf/designtime/context/DefaultDTExternalContextFactory.html" title="class in org.eclipse.jst.jsf.designtime.context"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/context/DTJSPExternalContext.html" title="class in org.eclipse.jst.jsf.designtime.context"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/jst/jsf/designtime/context/DTFacesContext.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DTFacesContext.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
