Apache Struts API Documentation: Class PresentTag

Apache Struts API


org.apache.struts.taglib.logic Class PresentTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.logic.ConditionalTagBase
              |
              +--org.apache.struts.taglib.logic.PresentTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
NestedPresentTag, NotPresentTag

public class PresentTag
extends ConditionalTagBase

Evalute the nested body content of this tag if the specified value is present for this request.

Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:
Serialized Form

Field Summary
static java.lang.String ROLE_DELIMITER
           
 
Fields inherited from class org.apache.struts.taglib.logic.ConditionalTagBase
cookie, header, messages, name, parameter, property, role, scope, user
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext, parent, values
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
PresentTag()
           
 
Method Summary
protected  boolean condition()
          Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped.
protected  boolean condition(boolean desired)
          Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped.
protected  boolean isBeanPresent()
          Returns true if the bean given in the name attribute is found.
protected  boolean isCookiePresent(javax.servlet.http.HttpServletRequest request)
          Returns true if the cookie is present in the request.
 
Methods inherited from class org.apache.struts.taglib.logic.ConditionalTagBase
doEndTag, doStartTag, getCookie, getHeader, getName, getParameter, getProperty, getRole, getScope, getUser, release, setCookie, setHeader, setName, setParameter, setProperty, setRole, setScope, setUser
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

ROLE_DELIMITER

public static final java.lang.String ROLE_DELIMITER
Constructor Detail

PresentTag

public PresentTag()
Method Detail

condition

protected boolean condition()
                     throws javax.servlet.jsp.JspException
Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped. This method must be implemented by concrete subclasses.
Overrides:
condition in class ConditionalTagBase
Throws:
javax.servlet.jsp.JspException - if a JSP exception occurs

condition

protected boolean condition(boolean desired)
                     throws javax.servlet.jsp.JspException
Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped. This method must be implemented by concrete subclasses.
Parameters:
desired - Desired outcome for a true result
Throws:
javax.servlet.jsp.JspException - if a JSP exception occurs

isBeanPresent

protected boolean isBeanPresent()
Returns true if the bean given in the name attribute is found.
Since:
Struts 1.2

isCookiePresent

protected boolean isCookiePresent(javax.servlet.http.HttpServletRequest request)
Returns true if the cookie is present in the request.
Since:
Struts 1.2


Copyright © 2000-2005 - The Apache Software Foundation