net.ontopia.topicmaps.webed.taglibs.form

Class CheckboxTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

net.ontopia.topicmaps.webed.taglibs.form.CheckboxTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, ActionInvokingTagIF

public class CheckboxTag
extends javax.servlet.jsp.tagext.TagSupport
implements ActionInvokingTagIF

INTERNAL: Custom tag that represents a checkbox in an input form.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action_name
protected String	id
protected String	klass
protected String	params
protected String	readonly
protected String	state_var
protected List	sub_actions
protected static String	TEMPLATE_FILE The location where the velocity template can be retrieved from.

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

pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
CheckboxTag()

Method Summary

Modifier and Type	Method and Description
void	addAction(ActionData action) Accepts the action and adds it to the list of actions to be invoked together with the primary action.
int	doEndTag() Generate the required input tag.
int	doStartTag() Process the start tag, do nothing.
void	release() Release any acquired resources.
void	setAction(String action_name) Sets the name of the related action (required).
void	setClass(String klass) Sets the class attribute of the tag.
void	setId(String id) Sets the id of the tag.
void	setParams(String params) Sets the variable name(s) of the parameter(s) transmitted to the action separated by whitespaces (optional).
void	setReadonly(String readonly) Sets the the readonly flag of the tag.
void	setState(String state_var) Sets the name of the variable used to determine whether the checbox should be checked or not.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_FILE

protected static final String TEMPLATE_FILE

The location where the velocity template can be retrieved from.

See Also:

Constant Field Values

id

protected String id

readonly

protected String readonly

klass

protected String klass

action_name

protected String action_name

params

protected String params

state_var

protected String state_var

sub_actions

protected List sub_actions

Constructor Detail

CheckboxTag

public CheckboxTag()

Method Detail

doStartTag

public int doStartTag()

Process the start tag, do nothing.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

doEndTag

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

Generate the required input tag.

Specified by:

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

Overrides:

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

Throws:

javax.servlet.jsp.JspException

release

public void release()

Release any acquired resources.

Specified by:

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

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport

addAction

public void addAction(ActionData action)

Description copied from interface: ActionInvokingTagIF

Accepts the action and adds it to the list of actions to be invoked together with the primary action.

Specified by:

addAction in interface ActionInvokingTagIF

setId

public void setId(String id)

Sets the id of the tag. This value will be used as the value of an ID attribute in the generated output.

Overrides:

setId in class javax.servlet.jsp.tagext.TagSupport

setReadonly

public void setReadonly(String readonly)

Sets the the readonly flag of the tag.

setClass

public void setClass(String klass)

Sets the class attribute of the tag. This value will be used as the value of the 'class' attribute in the generated output.

setAction

public void setAction(String action_name)

Sets the name of the related action (required).

setParams

public void setParams(String params)

Sets the variable name(s) of the parameter(s) transmitted to the action separated by whitespaces (optional).

setState

public void setState(String state_var)

Sets the name of the variable used to determine whether the checbox should be checked or not.