rundata.html

turbine教程

public void <B>setACL</B>(<A HREF="../../../../org/apache/turbine/util/security/AccessControlList.html">AccessControlList</A>&nbsp;acl)</PRE>
<DL>
<DD>Sets the access control list.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>acl</CODE> - an access control list.</DL>
</DD>
</DL>
<HR>

<A NAME="isPageSet()"><!-- --></A><H3>
isPageSet</H3>
<PRE>
public boolean <B>isPageSet</B>()</PRE>
<DL>
<DD>Checks to see if the page is set.<DD><DL>
<DT><B>Returns:</B><DD>true if the page is set.</DL>
</DD>
</DL>
<HR>

<A NAME="getPage()"><!-- --></A><H3>
getPage</H3>
<PRE>
public org.apache.ecs.Document <B>getPage</B>()</PRE>
<DL>
<DD>Gets the page.<DD><DL>
<DT><B>Returns:</B><DD>a document.</DL>
</DD>
</DL>
<HR>

<A NAME="hasAction()"><!-- --></A><H3>
hasAction</H3>
<PRE>
public boolean <B>hasAction</B>()</PRE>
<DL>
<DD>Whether or not an action has been defined.<DD><DL>
<DT><B>Returns:</B><DD>true if an action has been defined.</DL>
</DD>
</DL>
<HR>

<A NAME="getAction()"><!-- --></A><H3>
getAction</H3>
<PRE>
public java.lang.String <B>getAction</B>()</PRE>
<DL>
<DD>Gets the action. It returns an empty string if null so
 that it is easy to do conditionals on it based on the
 equalsIgnoreCase() method.<DD><DL>
<DT><B>Returns:</B><DD>a string, "" if null.</DL>
</DD>
</DL>
<HR>

<A NAME="setAction(java.lang.String)"><!-- --></A><H3>
setAction</H3>
<PRE>
public void <B>setAction</B>(java.lang.String&nbsp;action)</PRE>
<DL>
<DD>Sets the action for the request.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - a atring.</DL>
</DD>
</DL>
<HR>

<A NAME="getLayout()"><!-- --></A><H3>
getLayout</H3>
<PRE>
public java.lang.String <B>getLayout</B>()</PRE>
<DL>
<DD>If the Layout has not been defined by the screen then set the
 layout to be "DefaultLayout".  The screen object can also
 override this method to provide intelligent determination of
 the Layout to execute.  You can also define that logic here as
 well if you want it to apply on a global scale.  For example,
 if you wanted to allow someone to define layout "preferences"
 where they could dynamicially change the layout for the entire
 site.<DD><DL>
<DT><B>Returns:</B><DD>a string.</DL>
</DD>
</DL>
<HR>

<A NAME="setLayout(java.lang.String)"><!-- --></A><H3>
setLayout</H3>
<PRE>
public void <B>setLayout</B>(java.lang.String&nbsp;layout)</PRE>
<DL>
<DD>Set the layout for the request.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>layout</CODE> - a string.</DL>
</DD>
</DL>
<HR>

<A NAME="getLayoutTemplate()"><!-- --></A><H3>
getLayoutTemplate</H3>
<PRE>
public java.lang.String <B>getLayoutTemplate</B>()</PRE>
<DL>
<DD>Convenience method for a template info that
 returns the layout template being used.<DD><DL>
<DT><B>Returns:</B><DD>a string.</DL>
</DD>
</DL>
<HR>

<A NAME="setLayoutTemplate(java.lang.String)"><!-- --></A><H3>
setLayoutTemplate</H3>
<PRE>
public void <B>setLayoutTemplate</B>(java.lang.String&nbsp;layout)</PRE>
<DL>
<DD>Modifies the layout template for the screen. This convenience
 method allows for a layout to be modified from within a
 template. For example;

    $data.setLayoutTemplate("/NewLayout.vm")<DD><DL>
<DT><B>Parameters:</B><DD><CODE>layout</CODE> - a layout template.</DL>
</DD>
</DL>
<HR>

<A NAME="hasScreen()"><!-- --></A><H3>
hasScreen</H3>
<PRE>
public boolean <B>hasScreen</B>()</PRE>
<DL>
<DD>Whether or not a screen has been defined.<DD><DL>
<DT><B>Returns:</B><DD>true if a screen has been defined.</DL>
</DD>
</DL>
<HR>

<A NAME="getScreen()"><!-- --></A><H3>
getScreen</H3>
<PRE>
public java.lang.String <B>getScreen</B>()</PRE>
<DL>
<DD>Gets the screen to execute.<DD><DL>
<DT><B>Returns:</B><DD>a string.</DL>
</DD>
</DL>
<HR>

<A NAME="setScreen(java.lang.String)"><!-- --></A><H3>
setScreen</H3>
<PRE>
public void <B>setScreen</B>(java.lang.String&nbsp;screen)</PRE>
<DL>
<DD>Sets the screen for the request.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>screen</CODE> - a string.</DL>
</DD>
</DL>
<HR>

<A NAME="getScreenTemplate()"><!-- --></A><H3>
getScreenTemplate</H3>
<PRE>
public java.lang.String <B>getScreenTemplate</B>()</PRE>
<DL>
<DD>Convenience method for a template info that
 returns the name of the template being used.<DD><DL>
<DT><B>Returns:</B><DD>a string.</DL>
</DD>
</DL>
<HR>

<A NAME="setScreenTemplate(java.lang.String)"><!-- --></A><H3>
setScreenTemplate</H3>
<PRE>
public void <B>setScreenTemplate</B>(java.lang.String&nbsp;screen)</PRE>
<DL>
<DD>Sets the screen template for the request. For
 example;

    $data.setScreenTemplate("NewScreen.vm")<DD><DL>
<DT><B>Parameters:</B><DD><CODE>screen</CODE> - a screen template.</DL>
</DD>
</DL>
<HR>

<A NAME="getTemplateEncoding()"><!-- --></A><H3>
getTemplateEncoding</H3>
<PRE>
public java.lang.String <B>getTemplateEncoding</B>()</PRE>
<DL>
<DD>Gets the character encoding to use for reading template files.<DD><DL>
<DT><B>Returns:</B><DD>the template encoding or null if not specified.</DL>
</DD>
</DL>
<HR>

<A NAME="setTemplateEncoding(java.lang.String)"><!-- --></A><H3>
setTemplateEncoding</H3>
<PRE>
public void <B>setTemplateEncoding</B>(java.lang.String&nbsp;encoding)</PRE>
<DL>
<DD>Sets the character encoding to use for reading template files.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the template encoding.</DL>
</DD>
</DL>
<HR>

<A NAME="getTemplateInfo()"><!-- --></A><H3>
getTemplateInfo</H3>
<PRE>
public <A HREF="../../../../org/apache/turbine/util/template/TemplateInfo.html">TemplateInfo</A> <B>getTemplateInfo</B>()</PRE>
<DL>
<DD>Gets the template info. Creates a new one if needed.<DD><DL>
<DT><B>Returns:</B><DD>a template info.</DL>
</DD>
</DL>
<HR>

<A NAME="hasMessage()"><!-- --></A><H3>
hasMessage</H3>
<PRE>
public boolean <B>hasMessage</B>()</PRE>
<DL>
<DD>Whether or not a message has been defined.<DD><DL>
<DT><B>Returns:</B><DD>true if a message has been defined.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessage()"><!-- --></A><H3>
getMessage</H3>
<PRE>
public java.lang.String <B>getMessage</B>()</PRE>
<DL>
<DD>Gets the results of an action or another message
 to be displayed as a string.<DD><DL>
<DT><B>Returns:</B><DD>a string.</DL>
</DD>
</DL>
<HR>

<A NAME="setMessage(java.lang.String)"><!-- --></A><H3>
setMessage</H3>
<PRE>
public void <B>setMessage</B>(java.lang.String&nbsp;msg)</PRE>
<DL>
<DD>Sets the message for the request as a string.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - a string.</DL>
</DD>
</DL>
<HR>

<A NAME="addMessage(java.lang.String)"><!-- --></A><H3>
addMessage</H3>
<PRE>
public void <B>addMessage</B>(java.lang.String&nbsp;msg)</PRE>
<DL>
<DD>Adds the string to message. If message has prior messages from
 other actions or screens, this method can be used to chain them.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - a string.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessageAsHTML()"><!-- --></A><H3>
getMessageAsHTML</H3>
<PRE>
public org.apache.ecs.StringElement <B>getMessageAsHTML</B>()</PRE>
<DL>
<DD>Gets the results of an action or another message
 to be displayed as an ECS string element.<DD><DL>
<DT><B>Returns:</B><DD>a string element.</DL>
</DD>
</DL>
<HR>

<A NAME="setMessage(org.apache.ecs.Element)"><!-- --></A><H3>
setMessage</H3>
<PRE>
public void <B>setMessage</B>(org.apache.ecs.Element&nbsp;msg)</PRE>
<DL>
<DD>Sets the message for the request as an ECS element.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - an element.</DL>
</DD>
</DL>
<HR>

<A NAME="addMessage(org.apache.ecs.Element)"><!-- --></A><H3>
addMessage</H3>
<PRE>
public void <B>addMessage</B>(org.apache.ecs.Element&nbsp;msg)</PRE>
<DL>
<DD>Adds the ECS element to message. If message has prior messages from
 other actions or screens, this method can be used to chain them.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - an element.</DL>
</DD>
</DL>
<HR>

<A NAME="unsetMessage()"><!-- --></A><H3>
unsetMessage</H3>
<PRE>
public void <B>unsetMessage</B>()</PRE>
<DL>
<DD>Unsets the message for the request.</DL>
<HR>

<A NAME="getMessages()"><!-- --></A><H3>
getMessages</H3>
<PRE>
public <A HREF="../../../../org/apache/turbine/util/FormMessages.html">FormMessages</A> <B>getMessages</B>()</PRE>
<DL>
<DD>Gets a FormMessages object where all the messages to the
 user should be stored.<DD><DL>
<DT><B>Returns:</B><DD>a FormMessages.</DL>
</DD>
</DL>
<HR>

<A NAME="setMessages(org.apache.turbine.util.FormMessages)"><!-- --></A><H3>
setMessages</H3>
<PRE>
public void <B>setMessages</B>(<A HREF="../../../../org/apache/turbine/util/FormMessages.html">FormMessages</A>&nbsp;msgs)</PRE>
<DL>
<DD>Sets the FormMessages object for the request.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msgs</CODE> - A FormMessages.</DL>
</DD>
</DL>
<HR>

<A NAME="getTitle()"><!-- --></A><H3>
getTitle</H3>
<PRE>
public java.lang.String <B>getTitle</B>()</PRE>
<DL>
<DD>Gets the title of the page.<DD><DL>
<DT><B>Returns:</B><DD>a string.</DL>
</DD>
</DL>
<HR>

<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
setTitle</H3>
<PRE>
public void <B>setTitle</B>(java.lang.String&nbsp;title)</PRE>
<DL>
<DD>Sets the title of the page.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>title</CODE> - a string.</DL>
</DD>
</DL>
<HR>

<A NAME="userExists()"><!-- --></A><H3>
userExists</H3>
<PRE>
public boolean <B>userExists</B>()</PRE>
<DL>
<DD>Checks if a user exists in this session.<DD><DL>
<DT><B>Returns:</B><DD>true if a user exists in this session.</DL>
</DD>
</DL>
<HR>

<A NAME="getUser()"><!-- --></A><H3>
getUser</H3>
<PRE>
public <A HREF="../../../../org/apache/turbine/om/security/User.html">User</A> <B>getUser</B>()</PRE>
<DL>
<DD>Gets the user.<DD><DL>
<DT><B>Returns:</B><DD>a user.</DL>
</DD>
</DL>
<HR>

<A NAME="setUser(org.apache.turbine.om.security.User)"><!-- --></A><H3>
setUser</H3>
<PRE>
public void <B>setUser</B>(<A HREF="../../../../org/apache/turbine/om/security/User.html">User</A>&nbsp;user)</PRE>
<DL>
<DD>Sets the user.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - a user.</DL>
</DD>
</DL>
<HR>

<A NAME="getUserFromSession()"><!-- --></A><H3>
getUserFromSession</H3>
<PRE>
public <A HREF="../../../../org/apache/turbine/om/security/User.html">User</A> <B>getUserFromSession</B>()</PRE>
<DL>
<DD>Attempts to get the user from the session. If it does
 not exist, it returns null.<DD><DL>
<DT><B>Returns:</B><DD>a user.</DL>
</DD>
</DL>
<HR>

<A NAME="removeUserFromSession()"><!-- --></A><H3>
removeUserFromSession</H3>
<PRE>
public boolean <B>removeUserFromSession</B>()</PRE>
<DL>
<DD>Allows one to invalidate the user in the default session.<DD><DL>
<DT><B>Returns:</B><DD>true if user was invalidated.</DL>
</DD>
</DL>
<HR>

<A NAME="isOutSet()"><!-- --></A><H3>
isOutSet</H3>
<PRE>
public boolean <B>isOutSet</B>()</PRE>
<DL>
<DD>Checks to see if out is set.<DD><DL>