Apache Struts API Documentation: Class HtmlTag

Apache Struts API


org.apache.struts.taglib.html Class HtmlTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.html.HtmlTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.Tag

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

Renders an HTML

element with appropriate language attributes if there is a current Locale available in the user's session.

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

Field Summary
protected  boolean lang
          Are we rendering a lang attribute?
protected  boolean locale
          Deprecated. This will be removed after Struts 1.2.
protected static MessageResources messages
          The message resources for this package.
protected  boolean xhtml
          Are we rendering an xhtml page?
 
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
HtmlTag()
           
 
Method Summary
 int doEndTag()
          Process the end of this tag.
 int doStartTag()
          Process the start of this tag.
protected  java.util.Locale getCurrentLocale()
          Deprecated. This will be removed after Struts 1.2.
 boolean getLang()
          Returns true if the tag should render a lang attribute.
 boolean getLocale()
          Deprecated. This will be removed after Struts 1.2.
 boolean getXhtml()
           
 void release()
          Release any acquired resources.
protected  java.lang.String renderHtmlStartElement()
          Renders an <html> element with appropriate language attributes.
 void setLang(boolean lang)
          Sets whether the tag should render a lang attribute.
 void setLocale(boolean locale)
          Deprecated. This will be removed after Struts 1.2.
 void setXhtml(boolean xhtml)
           
 
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

messages

protected static MessageResources messages
The message resources for this package.

locale

protected boolean locale
Deprecated. This will be removed after Struts 1.2.

Should we set the current Locale for this user if needed?

xhtml

protected boolean xhtml
Are we rendering an xhtml page?

lang

protected boolean lang
Are we rendering a lang attribute?
Since:
Struts 1.2
Constructor Detail

HtmlTag

public HtmlTag()
Method Detail

getLocale

public boolean getLocale()
Deprecated. This will be removed after Struts 1.2.


setLocale

public void setLocale(boolean locale)
Deprecated. This will be removed after Struts 1.2.


getXhtml

public boolean getXhtml()

setXhtml

public void setXhtml(boolean xhtml)

getLang

public boolean getLang()
Returns true if the tag should render a lang attribute.
Since:
Struts 1.2

setLang

public void setLang(boolean lang)
Sets whether the tag should render a lang attribute.
Since:
Struts 1.2

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Process the start of this tag.
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

renderHtmlStartElement

protected java.lang.String renderHtmlStartElement()
Renders an <html> element with appropriate language attributes.
Since:
Struts 1.2

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Process the end of this tag.
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

release

public void release()
Release any acquired resources.
Overrides:
release in class javax.servlet.jsp.tagext.TagSupport

getCurrentLocale

protected java.util.Locale getCurrentLocale()
Deprecated. This will be removed after Struts 1.2.

Return the current Locale for this request. If there is no locale in the session and the locale attribute is set to "true", this method will create a Locale based on the client's Accept-Language header or the server's default locale and store it in the session. This will always return a Locale and never null.
Since:
Struts 1.1


Copyright © 2000-2005 - The Apache Software Foundation