📄 forwardconfig.html
字号:
protected boolean <B>configured</B></PRE>
<DL>
<DD>Has this component been completely configured?</DL>
<HR>
<A NAME="contextRelative"><!-- --></A><H3>
contextRelative</H3>
<PRE>
protected boolean <B>contextRelative</B></PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use module property instead; will be removed in a release following 1.2.0.</I>
<P>
<DD>Should the value of the <code>path</code> property be considered context-relative if it starts with a slash (and therefore not prefixed with the module prefix?</DL>
<HR>
<A NAME="name"><!-- --></A><H3>
name</H3>
<PRE>
protected java.lang.String <B>name</B></PRE>
<DL>
<DD>The unique identifier of this forward, which is used to reference it in <code>Action</code> classes.</DL>
<HR>
<A NAME="path"><!-- --></A><H3>
path</H3>
<PRE>
protected java.lang.String <B>path</B></PRE>
<DL>
<DD><p>The URL to which this <code>ForwardConfig</code> entry points, which must start with a slash ("/") character. It is interpreted according to the following rules:</p> <ul> <li>If <code>contextRelative</code> property is <code>true</code>, the path is considered to be context-relative within the current web application (even if we are in a named module). It will be prefixed by the context path to create a server-relative URL.</li> <li>If the <code>contextRelative</code> property is false, the path is considered to be the module-relative portion of the URL. It will be used as the replacement for the <code>$P</code> marker in the <code>forwardPattern</code> property defined on the <A HREF="../../../../org/apache/struts/config/ControllerConfig.html"><CODE>ControllerConfig</CODE></A> element for our current module. For the default <code>forwardPattern</code> value of <code>$C$M$P</code>, the resulting server-relative URL will be the concatenation of the context path, the module prefix, and the <code>path</code> from this <code>ForwardConfig</code>.</li> </ul></DL>
<HR>
<A NAME="module"><!-- --></A><H3>
module</H3>
<PRE>
protected java.lang.String <B>module</B></PRE>
<DL>
<DD><p>The prefix of the module to which this <code>ForwardConfig</code> entry points, which must start with a slash ("/") character. </p> <p>Usage note: If a forward config is used in a hyperlink, and a module is specified, the path must lead to another action and not directly to a page. This is in keeping with rule that in a modular application all links must be to an action rather than a page. </p></DL>
<HR>
<A NAME="redirect"><!-- --></A><H3>
redirect</H3>
<PRE>
protected boolean <B>redirect</B></PRE>
<DL>
<DD>Should a redirect be used to transfer control to the specified path?</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="ForwardConfig()"><!-- --></A><H3>
ForwardConfig</H3>
<PRE>
public <B>ForwardConfig</B>()</PRE>
<DL>
<DD>Construct a new instance with default values.</DL>
<HR>
<A NAME="ForwardConfig(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
ForwardConfig</H3>
<PRE>
public <B>ForwardConfig</B>(java.lang.String name, java.lang.String path, boolean redirect)</PRE>
<DL>
<DD>Construct a new instance with the specified values.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of this forward<DD><CODE>path</CODE> - Path to which control should be forwarded or redirected<DD><CODE>redirect</CODE> - Should we do a redirect?</DL>
</DD>
</DL>
<HR>
<A NAME="ForwardConfig(java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
ForwardConfig</H3>
<PRE>
public <B>ForwardConfig</B>(java.lang.String name, java.lang.String path, boolean redirect, boolean contextRelative)</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use module rather than contextRelative</I>
<P>
<DD>Construct a new instance with the specified values.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of this forward<DD><CODE>path</CODE> - Path to which control should be forwarded or redirected<DD><CODE>redirect</CODE> - Should we do a redirect?<DD><CODE>contextRelative</CODE> - Is this path context relative?</DL>
</DD>
</DL>
<HR>
<A NAME="ForwardConfig(java.lang.String, java.lang.String, boolean, java.lang.String)"><!-- --></A><H3>
ForwardConfig</H3>
<PRE>
public <B>ForwardConfig</B>(java.lang.String name, java.lang.String path, boolean redirect, java.lang.String module)</PRE>
<DL>
<DD><p>Construct a new instance with the specified values.</p><DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of this forward<DD><CODE>path</CODE> - Path to which control should be forwarded or redirected<DD><CODE>redirect</CODE> - Should we do a redirect?<DD><CODE>module</CODE> - Module prefix, if any</DL>
</DD>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getContextRelative()"><!-- --></A><H3>
getContextRelative</H3>
<PRE>
public boolean <B>getContextRelative</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use module property instead; will be removed in a release following 1.2.0.</I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setContextRelative(boolean)"><!-- --></A><H3>
setContextRelative</H3>
<PRE>
public void <B>setContextRelative</B>(boolean contextRelative)</PRE>
<DL>
<DD><B>Deprecated.</B> <I>Use module property instead; will be removed in a release following 1.2.0.</I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(java.lang.String name)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPath()"><!-- --></A><H3>
getPath</H3>
<PRE>
public java.lang.String <B>getPath</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPath(java.lang.String)"><!-- --></A><H3>
setPath</H3>
<PRE>
public void <B>setPath</B>(java.lang.String path)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getModule()"><!-- --></A><H3>
getModule</H3>
<PRE>
public java.lang.String <B>getModule</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setModule(java.lang.String)"><!-- --></A><H3>
setModule</H3>
<PRE>
public void <B>setModule</B>(java.lang.String module)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getRedirect()"><!-- --></A><H3>
getRedirect</H3>
<PRE>
public boolean <B>getRedirect</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setRedirect(boolean)"><!-- --></A><H3>
setRedirect</H3>
<PRE>
public void <B>setRedirect</B>(boolean redirect)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="freeze()"><!-- --></A><H3>
freeze</H3>
<PRE>
public void <B>freeze</B>()</PRE>
<DL>
<DD>Freeze the configuration of this component.<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Return a String representation of this object.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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/ForwardConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/apache/struts/config/FormPropertyConfig.html"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/struts/config/GlobalForwardFactory.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="ForwardConfig.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -