org.apache.turbine.services.jsp.tags
Class ScreenTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.turbine.services.jsp.tags.ScreenTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class ScreenTag
extends javax.servlet.jsp.tagext.TagSupport

Supporting class for the screen tag. Sends the content between the screen's body or head tags to the output stream. The decision to output the head or body contents is decided by the section parameter. Example usage: <x:screen section="head" />

Author:
John D. McNally
See Also:
Serialized Form

Field Summary
(package private) static java.lang.String BODY
          One of the valid values for the section parameter
private static java.lang.String FLAG
          Key used to prevent the templates Screen module from executing multiple times while evaluating the layout.
(package private) static java.lang.String HEAD
          One of the valid values for the section parameter
private  java.lang.String section
          section attribute.
(package private) static java.lang.String SECTION_KEY
          Key used to access the section parameter in the request.
private  boolean staticContent
          contextRelevant attribute.
 
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
ScreenTag()
           
 
Method Summary
 int doStartTag()
          Method called when the tag is encountered to send attributes to the output stream
 void setSection(java.lang.String section)
          setter for the section parameter
 void setStaticContent(boolean staticContent)
          setter for the staticContent parameter
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, 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

section

private java.lang.String section
section attribute. Valid values are head or body.

staticContent

private boolean staticContent
contextRelevant attribute. Meant to allow the Screen java code to be skipped in the event the content is static. Not working and have not decided whether to make it work or remove the functionality.

FLAG

private static final java.lang.String FLAG
Key used to prevent the templates Screen module from executing multiple times while evaluating the layout.

SECTION_KEY

static final java.lang.String SECTION_KEY
Key used to access the section parameter in the request.

BODY

static final java.lang.String BODY
One of the valid values for the section parameter

HEAD

static final java.lang.String HEAD
One of the valid values for the section parameter
Constructor Detail

ScreenTag

public ScreenTag()
Method Detail

setSection

public void setSection(java.lang.String section)
setter for the section parameter

setStaticContent

public void setStaticContent(boolean staticContent)
setter for the staticContent parameter

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Method called when the tag is encountered to send attributes to the output stream
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Returns:
SKIP_BODY, as it is intended to be a single tag.


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.