com.sas.taglib.servlet.tbeans.form
Class TextAreaTag

com.sas.taglib.servlet.tbeans.form.TextAreaTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

Direct Known Subclasses:

CellContentsTextAreaEditorTag

public class TextAreaTag

TextAreaTag is the tag handler class for the sas:TextArea custom tag . TextAreaTag is invoked by the JSP page to evaluate the sas:TextArea custom tag during the execution of the page. Tag handler methods are called by the JSP page implementation class at various points during the evaluation of the tag. The tag handler methods in turn call methods on the underlying Transformation Bean object, TextArea, to execute the methods.

If you need to extend or modify the functionality of the sas:TextArea custom tag, you can subclass this tag handler class.

For More Information:

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Refer to the Custom Tag Library Reference for usage information on the sas:TextArea custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site.

See Also:

BaseTextArea, Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.servlet.tbeans.form.BaseFormElementBodyTag

accessKey, onBlur, onChange, onClick, onDblClick, onFocus, onKeyDown, onKeyPress, onKeyUp, onMouseDown, onMouseMove, onMouseOut, onMouseOver, onMouseUp, onSelect, styleClassPrefix, tabIndex

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS, RB_KEY

Constructor Summary

TextAreaTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying TextArea object.
int	doStartTag() Processes the start tag for this instance.
java.lang.String	getColumns() Gets the columns property (int) of the TextArea.
boolean	getEnabled() Gets the enabled attribute of the TextAreaTag.
boolean	getReadOnly() Gets the readOnly attribute of the TextAreaTag.
java.lang.String	getRows() Gets the rows property (int) of the TextArea.
java.lang.String	getText() Gets the text property (String) of the TextArea.
java.lang.String	getWrap() Gets the wrap property (String) of the TextArea.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setColumns(java.lang.String columns) Sets the columns property (int) of the TextArea.
void	setEnabled(boolean enabled) Sets the enabled attribute (boolean) of the TextAreaTag.
void	setReadOnly(boolean readOnly) Sets the readOnly attribute (boolean) of the TextAreaTag.
void	setRows(java.lang.String rows) Sets the rows property (int) of the TextArea.
void	setText(java.lang.String text) Sets the text property (String) of the TextArea.
void	setWrap(java.lang.String wrap) Sets the wrap property (String) of the TextArea.

Methods inherited from class com.sas.taglib.servlet.tbeans.form.BaseFormElementBodyTag

getAccessKey, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleClassPrefix, getTabIndex, isEnabled, setAccessKey, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleClassPrefix, setTabIndex

Methods inherited from class com.sas.taglib.servlet.tbeans.BaseTransformationBodyTag

doEndTag, getCustomAttributes, getEpilog, getLocale, getName, getObjectDataProperty, getProlog, getRender, getRenderType, setCustomAttributes, setEpilog, setLocale, setName, setObjectDataProperty, setProlog, setRender, setRenderType

Methods inherited from class com.sas.taglib.BaseBodyTag

doCatch, doFinally, getApplyAttributes, getBodyStrings, getCompositeComponentKey, getInstantiate, getPageContext, getRef, getScope, getTagScope, getWrappedClassName, getWrappedObject, getWrappedObject, loadBeanInstance, newInstance, release, removeFromScope, searchContext, setApplyAttributes, setCompositeComponentKey, setInstantiate, setRef, setScope, setTagScope, setVariableWithinScope, setWrappedClassName, setWrappedObject, validate

Constructor Detail

TextAreaTag

public TextAreaTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseFormElementBodyTag

Parameters:

includeAttributes - Set to true if attributes are to be set to default values.

setText

public void setText(java.lang.String text)

Sets the text property (String) of the TextArea. The text String is used to set the text of the TextArea.

Parameters:

text - The text of the TextArea

setRows

public void setRows(java.lang.String rows)

Sets the rows property (int) of the TextArea. The rows String specifies the number of visible text lines. Users should be able to enter more lines than this, so the client must provide some means of scrolling through the contents of the textarea field. The default is 3. The String value of rows should be an integer.

Parameters:

rows - The visible number of text lines.

setColumns

public void setColumns(java.lang.String columns)

Sets the columns property (int) of the TextArea. The columns String specifies the number of columns in this text area. The default is 40. The String value of columns should be an integer.

Parameters:

columns - The number of columns in the TextArea.

setWrap

public void setWrap(java.lang.String wrap)

Sets the wrap property (String) of the TextArea. Specifies whether lines longer than the text area's column width wrap to the next line

Valid values are:

OFF - Disables word wrap
HARD - Line breaks are included when the form is submitted
SOFT - Line breaks are not included when the form is submitted
VIRTUAL - Same as soft

Parameters:

wrap - Specifies whether or not lines wrap to the next line.

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled attribute (boolean) of the TextAreaTag. Valid values are: true, false.

Overrides:

setEnabled in class BaseFormElementBodyTag

Parameters:

enabled - The state of the TextArea element; "false" results in a disabled textarea.

See Also:

BaseFormElementBodyTag.isEnabled()

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the readOnly attribute (boolean) of the TextAreaTag. Valid values are: true, false.

Parameters:

readOnly - The state of the TextArea element; "true" results in a read only textarea.

getReadOnly

public boolean getReadOnly()

Gets the readOnly attribute of the TextAreaTag.

Returns:

true if the textarea is readOnly

getEnabled

public boolean getEnabled()

Gets the enabled attribute of the TextAreaTag.

Returns:

true if the textarea is enabled

getText

public java.lang.String getText()

Gets the text property (String) of the TextArea. The text String is used to get the text of the TextArea.

Returns:

the TextArea text

getRows

public java.lang.String getRows()

Gets the rows property (int) of the TextArea. The rows String specifies the number of visible text lines. Users should be able to enter more lines than this, so the client must provide some means of scrolling through the contents of the textarea field. The default is 3. The String value of rows should be an integer.

Returns:

the TextArea rows

getColumns

public java.lang.String getColumns()

Gets the columns property (int) of the TextArea. The columns String specifies the number of columns in this text area. The default is 40. The String value of columns should be an integer.

Returns:

the TextArea columns

getWrap

public java.lang.String getWrap()

Gets the wrap property (String) of the TextArea. Specifies whether lines longer than the text area's column width wrap to the next line

Valid values are:

OFF - Disables word wrap
HARD - Line breaks are included when the form is submitted
SOFT - Line breaks are not included when the form is submitted
VIRTUAL - Same as soft

Returns:

the TextArea wrap

doStartTag

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

Processes the start tag for this instance. The doStartTag() method assumes that all setter methods have been invoked before. When this method is invoked, the body has not yet been invoked.

Specified by:

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

Overrides:

doStartTag in class BaseTransformationBodyTag

Returns:

int designating the next course of action for the tag/jsp page.

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

See Also:

BaseBodyTag.setInstantiate(boolean), TagSupport.doStartTag()

applyAttributes

protected void applyAttributes()
                        throws javax.servlet.jsp.JspException

Sets the attributes on the underlying TextArea object.

Overrides:

applyAttributes in class BaseFormElementBodyTag

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs