Class ScrollTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

org.deltava.taglib.BrowserInfoTag

org.deltava.taglib.html.ElementTag

org.deltava.taglib.html.LinkTag

org.deltava.taglib.view.ScrollTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable

Direct Known Subclasses:

PageDownTag, PageUpTag

abstract class ScrollTag
extends LinkTag

A class to support tag to handle Page Up/Down links at the bottom of a view page.

Since:

1.0

Version:

10.0

Author:

Luke

Field Summary

Fields

Modifier and Type	Field	Description
protected ScrollBarTag	_scrollBarTag
protected String	_tagLabel
protected TableTag	_viewTag

Fields inherited from class ElementTag

_classes, _data, _out

Modifier and Type	Field	Description
protected final Collection<String>	_classes
protected final XMLRenderer	_data
protected jakarta.servlet.jsp.JspWriter	_out

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScrollTag(String label)	Creates a new JSP tag with the specified label.

Method Summary

Modifier and Type	Method	Description
protected static String	buildParameters(Map<String,String> params)	A helper method to bundle request parameters into a URL string.
protected void	renderLabel()	Outputs the tag label to the JSP output stream.
final void	setTarget(String targetFrame)	Updates the target frame for this tag.
void	setText(String label)	Updates the URL label text.
final void	setUrl(String cmd)	Updates the URL for this tag.
protected void	validateTag()	Validates the tag to ensure it is contained within an enclosing <view:table> tag and an enclosing <view:scrollbar> tag.

Methods inherited from class LinkTag

doEndTag, doStartTag, release, setAnchor, setExternal, setLabel, setOnClick, validateLink

Modifier and Type	Method	Description
int	doEndTag()
int	doStartTag()
void	release()
void	setAnchor(String a)	Sets the anchor for this link.
void	setExternal(boolean isExternal)	Marks this link as an external link.
void	setLabel(String label)	Sets the label for this link.
void	setOnClick(String js)	Sets the JavaScript onClick event for this link.
protected void	validateLink()	Validates the tag to ensure a URL/onClick event has been set.

Methods inherited from class ElementTag

getFormIndexCount, getName, getParentFormTag, setClassName, setID, setNumericAttr, setPageContext, setStyle

Modifier and Type	Method	Description
protected int	getFormIndexCount()	Gets and increments the current tab index count for the parent form tag.
protected String	getName()	Returns the type of HTML element this tag generated.
protected FormTag	getParentFormTag()	Returns the parent form tag.
void	setClassName(String cName)	Sets the CSS class name of this HTML element.
void	setID(String id)	Sets the ID of this HTML element.
protected void	setNumericAttr(String attrName, int value, int minValue)	Sets a numeric attribute.
void	setPageContext(jakarta.servlet.jsp.PageContext ctxt)
void	setStyle(String style)	Associates a CSS style with this HTML element.

Methods inherited from class BrowserInfoTag

getBrowserContext, passedCAPTCHA

Modifier and Type	Method	Description
protected HTTPContextData	getBrowserContext()	Fetches the browser data.
protected boolean	passedCAPTCHA()	Returns whether the user has passed CAPTCHA validation.

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_viewTag

protected TableTag _viewTag

_scrollBarTag

protected ScrollBarTag _scrollBarTag

_tagLabel

protected String _tagLabel

Constructor Details

ScrollTag

protected ScrollTag(String label)

Creates a new JSP tag with the specified label.

Parameters:

label - the label text

See Also:

• setText(String)

Method Details

setUrl

public final void setUrl(String cmd)

Updates the URL for this tag. NOT IMPLEMENTED

Overrides:

setUrl in class LinkTag

Parameters:

cmd - the target URL

Throws:

UnsupportedOperationException

setTarget

public final void setTarget(String targetFrame)

Updates the target frame for this tag. NOT IMPLEMENTED

Overrides:

setTarget in class LinkTag

Parameters:

targetFrame - the target frame name

Throws:

UnsupportedOperationException

buildParameters

protected static String buildParameters(Map<String,String> params)

A helper method to bundle request parameters into a URL string.

Parameters:

params - a Map of paramater name/value pairs

Returns:

the Query String

setText

public void setText(String label)

Updates the URL label text.

Parameters:

label - the new URL label

validateTag

protected void validateTag()
                    throws jakarta.servlet.jsp.JspException

Validates the tag to ensure it is contained within an enclosing <view:table> tag and an enclosing <view:scrollbar> tag.

Throws:

jakarta.servlet.jsp.JspException - if the tag is not enclosed

renderLabel

protected void renderLabel()
                    throws jakarta.servlet.jsp.JspException

Outputs the tag label to the JSP output stream.

Throws:

jakarta.servlet.jsp.JspException - if an error occurs