Class CheckTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

org.deltava.taglib.BrowserInfoTag

org.deltava.taglib.html.ElementTag

org.deltava.taglib.html.FormElementTag

org.deltava.taglib.html.CheckTag

All Implemented Interfaces:

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

public class CheckTag
extends FormElementTag

A JSP tag to support the generation of HTML multi-option checkboxes and radio buttons.

Since:

1.0

Version:

12.3

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	_firstEntry	An additional entry prepended to the list of options

Fields inherited from class FormElementTag

_value

Modifier and Type	Field	Description
protected Object	_value	The value of this input element.

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

Constructor	Description
CheckTag()	Creates a new checkbox/radio tag.

Method Summary

Modifier and Type	Method	Description
int	doEndTag()	Renders the checkbox tags.
void	release()	Releases the tag's state data.
void	setChecked(Collection<Object> values)	Sets the selected value(s) of this element.
final void	setClassName(String cName)	Sets the CSS class name for the checkbox/radio text .
void	setCols(int columns)	Sets the width of the field in columns; afterwards the separator will be outputted.
void	setFirstEntry(Object entry)	Allows an entry to be inserted before the rest of the options.
void	setName(String name)	Sets the check box name, saving for the CSS class.
void	setNewLine(boolean doNewLine)	Sets the multiple element separator to a DIV with a new line.
void	setOnChange(String jsEvent)	Sets the JavaScript onChange event for these checkboxes/radio buttons.
void	setOptions(Collection<?> choices)	Sets the choices for this checkbox/radio button.
void	setSeparator(String sep)	Sets the multiple element separator.
void	setType(String checkType)	Sets the element type.
void	setWidth(int width)	Sets the width of each checkbox entry.

Methods inherited from class FormElementTag

setDelimValues, setIdx, setRequired, setValue, validateState

Modifier and Type	Method	Description
void	setDelimValues(String values)	Sets multiple values for this input element.
void	setIdx(String index)	Sets the tab index of this field.
void	setRequired(boolean isRequired)	Sets this field as required for HTML5 browsers.
void	setValue(Object value)	Sets the value of this input element.
protected void	validateState()	Validates tag state.

Methods inherited from class ElementTag

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

Modifier and Type	Method	Description
int	doStartTag()
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	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

_firstEntry

protected Object _firstEntry

An additional entry prepended to the list of options

Constructor Details

CheckTag

public CheckTag()

Creates a new checkbox/radio tag.

Method Details

setCols

public void setCols(int columns)

Sets the width of the field in columns; afterwards the separator will be outputted.

Parameters:

columns - the number of columns

setWidth

public void setWidth(int width)

Sets the width of each checkbox entry.

Parameters:

width - the width in pixels

setName

public void setName(String name)

Sets the check box name, saving for the CSS class.

Overrides:

setName in class FormElementTag

Parameters:

name - the field name

setFirstEntry

public void setFirstEntry(Object entry)

Allows an entry to be inserted before the rest of the options.

Parameters:

entry - the first entry to insert

setOnChange

public void setOnChange(String jsEvent)

Sets the JavaScript onChange event for these checkboxes/radio buttons.

Parameters:

jsEvent - the JavaScript event code

doEndTag

public int doEndTag()
             throws jakarta.servlet.jsp.JspException

Renders the checkbox tags.

Specified by:

doEndTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class jakarta.servlet.jsp.tagext.TagSupport

Returns:

EVAL_PAGE always

Throws:

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

release

public void release()

Releases the tag's state data.

Specified by:

release in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

release in class ElementTag

setClassName

public final void setClassName(String cName)

Sets the CSS class name for the checkbox/radio text .

Overrides:

setClassName in class ElementTag

Parameters:

cName - the CSS class name(s)

See Also:

• ElementTag.setClassName(String)

setType

public void setType(String checkType)

Sets the element type. Updats the default CSS class to "check" or "radio".

Parameters:

checkType - the element type, typically RADIO or CHECKBOX

setSeparator

public void setSeparator(String sep)

Sets the multiple element separator.

Parameters:

sep - the string to insert between multiple elements

See Also:

• setNewLine(boolean)

setNewLine

public void setNewLine(boolean doNewLine)

Sets the multiple element separator to a DIV with a new line.

Parameters:

doNewLine - TRUE if the separator should be set, otherwise FALSE

See Also:

• setSeparator(String)

setChecked

public void setChecked(Collection<Object> values)

Sets the selected value(s) of this element.

Parameters:

values - a List of selected values of this element

setOptions

public void setOptions(Collection<?> choices)

Sets the choices for this checkbox/radio button.

Parameters:

choices - a Collection of choices