com.ivata.mask.web.tag
Class FieldTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.ivata.mask.web.tag.FieldTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class FieldTag

extends javax.servlet.jsp.tagext.TagSupport

Creates an input field, or displays the value for a field.

Note: you must set a session attribute

Since:

ivata masks 0.1 (2004-05-11)

Version:

$Revision: 1.7.2.1 $

Author:

Colin MacLeod colin.macleod@ivata.com

See Also:

Serialized Form

Field Summary

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

id, 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

FieldTag()

Method Summary

int	doStartTag() Called when the tag is first encountered.
com.ivata.mask.field.Field	getField() Field to be displayed.
static FieldWriterFactory	getFieldWriterFactory(javax.servlet.jsp.PageContext pageContext) Get the field writer factory we'll be using to create field writers.
com.ivata.mask.field.Field	getSubField() Sub-field within the field to be displayed.
com.ivata.mask.valueobject.ValueObject	getValueObject() Value object to display/edit.
boolean	isDisabled() If true, the field will not allow user entry.
boolean	isHidden() If true, overrides the hidden value of the field definition, to make this a hidden field.
void	setDisabled(boolean disabledParam) If true, the field will not allow user entry.
void	setField(com.ivata.mask.field.Field fieldParam) Stores the identifier of the field within this group to be displayed.
void	setHidden(boolean hiddenParam) If true, overrides the hidden value of the field definition, to make this a hidden field.
void	setSubField(com.ivata.mask.field.Field fieldParam) Sub-field within the field to be displayed.
void	setValueObject(com.ivata.mask.valueobject.ValueObject object) Value object to display/edit.

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

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldTag

public FieldTag()

Method Detail

getFieldWriterFactory

public static FieldWriterFactory getFieldWriterFactory(javax.servlet.jsp.PageContext pageContext)
                                                throws javax.servlet.jsp.JspException

Get the field writer factory we'll be using to create field writers.

Parameters:

pageContext - current tag page context, used to lookup the factory attribute.

Returns:

field writer factory, used to create field writers.

Throws:

javax.servlet.jsp.JspException - if the field writer factory has not been set to an application scope attribute called FieldWriterFactory.APPLICATION_ATTRIBUTE.

doStartTag

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

Called when the tag is first encountered. Simply diplays the field for now.

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

getField

public com.ivata.mask.field.Field getField()

Field to be displayed.

Returns:

field to be displayed.

getSubField

public com.ivata.mask.field.Field getSubField()

Sub-field within the field to be displayed.

Returns:

Sub-field within the field to be displayed.

getValueObject

public com.ivata.mask.valueobject.ValueObject getValueObject()

Value object to display/edit.

Returns:

value object to display/edit.

isDisabled

public boolean isDisabled()

If true, the field will not allow user entry.

Returns:

Returns whether or not the field is disabled.

isHidden

public boolean isHidden()

If true, overrides the hidden value of the field definition, to make this a hidden field.

Returns:

Returns whether or not the field definition is overridden as hidden.

See Also:

Field.isHidden()

setDisabled

public void setDisabled(boolean disabledParam)

If true, the field will not allow user entry.

Parameters:

disabledParam - Set whether or not the field is disabled.

setField

public final void setField(com.ivata.mask.field.Field fieldParam)

Stores the identifier of the field within this group to be displayed.

Parameters:

fieldParam - definition of the field which this tag is going to display/edit.

setHidden

public void setHidden(boolean hiddenParam)

If true, overrides the hidden value of the field definition, to make this a hidden field.

Parameters:

hiddenParam - Set to true to hide the field, overriding any setting in the field definition.

See Also:

Field.isHidden()

setSubField

public void setSubField(com.ivata.mask.field.Field fieldParam)

Sub-field within the field to be displayed.

Parameters:

fieldParam - Sub-field within the field to be displayed.

setValueObject

public void setValueObject(com.ivata.mask.valueobject.ValueObject object)

Value object to display/edit.

Parameters:

object - value object to display/edit.