Apache Struts API Documentation: Class FrameTag

Apache Struts API


org.apache.struts.taglib.html Class FrameTag

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

public class FrameTag
extends LinkTag

Generate an HTML <frame> tag with similar capabilities as those the <html:link> tag provides for hyperlink elements. The src element is rendered using the same technique that LinkTag uses to render the href attribute of a hyperlink. Additionall, the HTML 4.0 frame tag attributes noresize, scrolling, marginheight, marginwidth, frameborder, and longdesc are supported. The frame name attribute is rendered based on the frameName property. Note that the value of longdesc is intended to be a URI, but currently no rewriting is supported. The attribute is set directly from the property value.

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

Field Summary
protected  java.lang.String frameborder
          The frameborder attribute that should be rendered (1, 0).
protected  java.lang.String frameName
          The name attribute that should be rendered for this frame.
protected  java.lang.String longdesc
          URI of a long description of this frame (complements title).
protected  java.lang.Integer marginheight
          The margin height in pixels, or zero for no setting.
protected  java.lang.Integer marginwidth
          The margin width in pixels, or null for no setting.
protected  boolean noresize
          Should users be disallowed to resize the frame?
protected  java.lang.String scrolling
          What type of scrolling should be supported (yes, no, auto)?
 
Fields inherited from class org.apache.struts.taglib.html.LinkTag
action, anchor, forward, href, indexId, linkName, messages, module, name, page, paramId, paramName, paramProperty, paramScope, property, scope, target, text, transaction, useLocalEncoding
 
Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag
accesskey, alt, altKey, bundle, defaultLocale, disabled, doDisabled, doReadonly, errorKey, errorStyle, errorStyleClass, errorStyleId, indexed, locale, log, loopTagStatusClass, loopTagStatusGetIndex, loopTagSupportClass, loopTagSupportGetStatus, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, readonly, style, styleClass, styleId, tabindex, title, titleKey, triedJstlInit, triedJstlSuccess
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext, parent, values
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
FrameTag()
           
 
Method Summary
 int doEndTag()
          Ignore the end of this tag.
 int doStartTag()
          Render the appropriately encoded URI.
 java.lang.String getFrameborder()
           
 java.lang.String getFrameName()
           
 java.lang.String getLongdesc()
           
 java.lang.Integer getMarginheight()
           
 java.lang.Integer getMarginwidth()
           
 boolean getNoresize()
           
 java.lang.String getScrolling()
           
 void release()
          Release any acquired resources.
 void setFrameborder(java.lang.String frameborder)
           
 void setFrameName(java.lang.String frameName)
           
 void setLongdesc(java.lang.String longdesc)
           
 void setMarginheight(java.lang.Integer marginheight)
           
 void setMarginwidth(java.lang.Integer marginwidth)
           
 void setNoresize(boolean noresize)
           
 void setScrolling(java.lang.String scrolling)
           
 
Methods inherited from class org.apache.struts.taglib.html.LinkTag
calculateURL, doAfterBody, getAction, getAnchor, getForward, getHref, getIndexId, getLinkName, getModule, getName, getPage, getParamId, getParamName, getParamProperty, getParamScope, getProperty, getScope, getTarget, getTransaction, isUseLocalEncoding, setAction, setAnchor, setForward, setHref, setIndexId, setLinkName, setModule, setName, setPage, setParamId, setParamName, setParamProperty, setParamScope, setProperty, setScope, setTarget, setTransaction, setUseLocalEncoding
 
Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag
doErrorsExist, getAccesskey, getAlt, getAltKey, getBundle, getDisabled, getElementClose, getErrorKey, getErrorStyle, getErrorStyleClass, getErrorStyleId, getIndexed, getIndexValue, getJstlLoopIndex, getLocale, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getReadonly, getStyle, getStyleClass, getStyleId, getTabindex, getTitle, getTitleKey, isXhtml, lookupProperty, message, prepareAttribute, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareKeyEvents, prepareMouseEvents, prepareName, prepareOtherAttributes, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDisabled, setErrorKey, setErrorStyle, setErrorStyleClass, setErrorStyleId, setIndexed, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
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
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Field Detail

frameborder

protected java.lang.String frameborder
The frameborder attribute that should be rendered (1, 0).

frameName

protected java.lang.String frameName
The name attribute that should be rendered for this frame.

longdesc

protected java.lang.String longdesc
URI of a long description of this frame (complements title).

marginheight

protected java.lang.Integer marginheight
The margin height in pixels, or zero for no setting.

marginwidth

protected java.lang.Integer marginwidth
The margin width in pixels, or null for no setting.

noresize

protected boolean noresize
Should users be disallowed to resize the frame?

scrolling

protected java.lang.String scrolling
What type of scrolling should be supported (yes, no, auto)?
Constructor Detail

FrameTag

public FrameTag()
Method Detail

getFrameborder

public java.lang.String getFrameborder()

setFrameborder

public void setFrameborder(java.lang.String frameborder)

getFrameName

public java.lang.String getFrameName()

setFrameName

public void setFrameName(java.lang.String frameName)

getLongdesc

public java.lang.String getLongdesc()

setLongdesc

public void setLongdesc(java.lang.String longdesc)

getMarginheight

public java.lang.Integer getMarginheight()

setMarginheight

public void setMarginheight(java.lang.Integer marginheight)

getMarginwidth

public java.lang.Integer getMarginwidth()

setMarginwidth

public void setMarginwidth(java.lang.Integer marginwidth)

getNoresize

public boolean getNoresize()

setNoresize

public void setNoresize(boolean noresize)

getScrolling

public java.lang.String getScrolling()

setScrolling

public void setScrolling(java.lang.String scrolling)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Render the appropriately encoded URI.
Overrides:
doStartTag in class LinkTag
Throws:
javax.servlet.jsp.JspException - if a JSP exception has occurred

doEndTag

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

release

public void release()
Release any acquired resources.
Overrides:
release in class LinkTag


Copyright © 2000-2005 - The Apache Software Foundation