org.apache.struts.taglib.html

Class FrameTag


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.
Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
Since:
Struts 1.1

Field Summary

protected String
frameName
The name attribute that should be rendered for this frame.
protected String
frameborder
The frameborder attribute that should be rendered (1, 0).
protected String
longdesc
URI of a long description of this frame (complements title).
protected Integer
marginheight
The margin height in pixels, or zero for no setting.
protected Integer
marginwidth
The margin width in pixels, or null for no setting.
protected boolean
noresize
Should users be disallowed to resize the frame?
protected 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, messages, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, readonly, style, styleClass, styleId, tabindex, title, titleKey, triedJstlInit, triedJstlSuccess

Method Summary

int
doEndTag()
Ignore the end of this tag.
int
doStartTag()
Render the appropriately encoded URI.
String
getFrameName()
String
getFrameborder()
String
getLongdesc()
Integer
getMarginheight()
Integer
getMarginwidth()
boolean
getNoresize()
String
getScrolling()
void
release()
Release any acquired resources.
void
setFrameName(String frameName)
void
setFrameborder(String frameborder)
void
setLongdesc(String longdesc)
void
setMarginheight(Integer marginheight)
void
setMarginwidth(Integer marginwidth)
void
setNoresize(boolean noresize)
void
setScrolling(String scrolling)

Methods inherited from class org.apache.struts.taglib.html.LinkTag

calculateURL, doAfterBody, doEndTag, doStartTag, getAction, getAnchor, getForward, getHref, getIndexId, getLinkName, getModule, getName, getPage, getParamId, getParamName, getParamProperty, getParamScope, getProperty, getScope, getTarget, getTransaction, isUseLocalEncoding, release, 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, getIndexValue, getIndexed, 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, release, 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

Field Details

frameName

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

frameborder

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

longdesc

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

marginheight

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

marginwidth

protected 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 String scrolling
What type of scrolling should be supported (yes, no, auto)?

Method Details

doEndTag

public int doEndTag()
            throws JspException
Ignore the end of this tag.
Overrides:
doEndTag in interface LinkTag

doStartTag

public int doStartTag()
            throws JspException
Render the appropriately encoded URI.
Overrides:
doStartTag in interface LinkTag

getFrameName

public String getFrameName()

getFrameborder

public String getFrameborder()

getLongdesc

public String getLongdesc()

getMarginheight

public Integer getMarginheight()

getMarginwidth

public Integer getMarginwidth()

getNoresize

public boolean getNoresize()

getScrolling

public String getScrolling()

release

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

setFrameName

public void setFrameName(String frameName)

setFrameborder

public void setFrameborder(String frameborder)

setLongdesc

public void setLongdesc(String longdesc)

setMarginheight

public void setMarginheight(Integer marginheight)

setMarginwidth

public void setMarginwidth(Integer marginwidth)

setNoresize

public void setNoresize(boolean noresize)

setScrolling

public void setScrolling(String scrolling)

Copyright B) 2000-2007 - The Apache Software Foundation