com.plumtree.xpshared.htmlelements
Class HTMLTextArea

java.lang.Object
  com.plumtree.xpshared.htmlelements.HTMLElement
      com.plumtree.xpshared.htmlelements.HTMLGenericInputElement
          com.plumtree.xpshared.htmlelements.HTMLTextArea

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLTextArea
extends HTMLGenericInputElement

Spec

Nested Class Summary

Nested classes/interfaces inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

HTMLElement.ValidationLevel

Field Summary

Fields inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

aNewLine, bAllowEvents, bAllowSetStyleClassWithString, bCheckNestedStringForHTML, bDisplayDidPause, bEnforceMaxTableDepth, bForceFormattingOff, bForceFormattingOn, bPauseAfterDisplay, bPrintComments, bResumingAndChildFinished, bResumingAndChildInMidRender, bShowLang, iMaxTableDepth, sLangLocal, sNewLine, sTab

Constructor Summary

HTMLTextArea(java.lang.String cols, java.lang.String rows)

Method Summary

protected void	AppendBeginningOfOpeningTag(boolean bFormat, XPStringBuilder sb, IXPResponse response) This method generates the beginning of the opening tag.
protected void	AppendClosingTag(boolean bFormat, XPStringBuilder sb, IXPResponse response) This method generates the closing tag of this html element.
void	ClearTabIndex() Sets sTabIndex to null.
java.lang.String	GetCols() Call this method to get the value of the cols attribute.
boolean	GetReadOnly() Get the value of the readonly attribute.
java.lang.String	GetRows() Call this method to get the value of the rows attribute.
java.lang.String	GetTabIndex() Returns the tab index.
protected void	InternalWrite(boolean bFormat, XPStringBuilder sb, IXPResponse response) HTMLElement.InternalWrite rewritten to prevent formatting.
protected boolean	ProvidesClosingTag() Indicates whether or not this HTML element provides a closing tag.
void	SetDisabled(boolean bInputDisabled) Set the value of the Disabled attribute.
void	SetReadOnly(boolean bInputReadOnly) Set the value of the readonly attribute.
void	SetTabIndex(java.lang.String _sTabIndex) Sets the tab index.
void	SetValue(java.lang.String s) This method rewritten to prevent usage.
void	ValidateName(java.lang.String s) Call this method to validate the name of this HTMLTextArea.

Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLGenericInputElement

GetOnBlur, GetOnChange, GetOnFocus, GetValue, SetName, SetOnBlur, SetOnChange, SetOnFocus, SetValidateName

Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

AddInnerHTMLElement, AddInnerHTMLEncodedString, AddInnerHTMLString, AppendClosingLineBreak, CleanupHTMLSubtreeAfterRendering, ClearInnerHTMLElements, clone, Display, Display, ForceFormattingOff, GetChildInMidRender, GetClone, GetDisabled, GetDisplayDidPause, GetDisplayOptions, GetDisplayString, GetDisplayString, GetDisplayString, GetDo508Checking, GetDoFormat, GetElementName, GetForceLineBreaksAfterSafeElements, GetHTMLElementReadOnly, GetID, GetImgBaseUrl, GetInnerHTML, GetInnerHTML, GetInnerHTMLDisplayString, GetInnerHTMLElements, GetInnerHTMLElementsAsArrayList, GetIsNetscape, GetLang, GetLastChildFullyRendered, GetName, GetOnClick, GetOnKeyDown, GetOnKeyPress, GetOnKeyUp, GetOnMouseOut, GetOnMouseOver, GetPauseAfterDisplay, GetPostComment, GetPreComment, GetStringBuilder, GetStyle, GetStyleClass, GetStyleClassPrefix, GetTitle, GetValidationLevel, InsertInnerHTMLElement, SaveToTempFile, SaveToTempFile, SetChildInMidRender, SetDisplayOptions, SetDo508Checking, SetDoFormat, SetElementName, SetFlushAfterDisplay, SetForceLineBreaksAfterSafeElements, SetHTMLElementReadOnly, SetID, SetImgBaseUrl, SetInner, SetIsNetscape, SetLangGlobal, SetLangLocal, SetLastChildFullyRendered, SetOnClick, SetOnKeyDown, SetOnKeyPress, SetOnKeyUp, SetOnMouseOut, SetOnMouseOver, SetPauseAfterDisplay, SetPostComment, SetPreComment, SetStyle, SetStyleClass, SetStyleClass, SetStyleClassPrefix, SetTitle, SetValidationLevel, ToByteArray, VerifyWritability, WriteNugget, WriteNugget

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLTextArea

public HTMLTextArea(java.lang.String cols,
                    java.lang.String rows)

Parameters:

cols - Pass the cols string of this textarea.

rows - Pass the rows string of this textarea.

Throws:

HTMLException

Method Detail

GetCols

public java.lang.String GetCols()

Call this method to get the value of the cols attribute.

Returns:

String value

GetReadOnly

public boolean GetReadOnly()

Get the value of the readonly attribute.

Returns:

boolean value

GetRows

public java.lang.String GetRows()

Call this method to get the value of the rows attribute.

Returns:

String value

SetReadOnly

public void SetReadOnly(boolean bInputReadOnly)

Set the value of the readonly attribute.

Parameters:

bInputReadOnly - value

SetDisabled

public void SetDisabled(boolean bInputDisabled)

Set the value of the Disabled attribute.

Overrides:

SetDisabled in class HTMLElement

Parameters:

bInputDisabled - value

SetValue

public void SetValue(java.lang.String s)

This method rewritten to prevent usage.

Overrides:

SetValue in class HTMLGenericInputElement

Parameters:

s - String value

Throws:

HTMLException - This method throws an exception.

ValidateName

public void ValidateName(java.lang.String s)

Call this method to validate the name of this HTMLTextArea.

Specified by:

ValidateName in class HTMLGenericInputElement

Parameters:

s - String name.

Throws:

HTMLException - This method throws an exception if the name passed is not valid.

InternalWrite

protected void InternalWrite(boolean bFormat,
                             XPStringBuilder sb,
                             IXPResponse response)

HTMLElement.InternalWrite rewritten to prevent formatting.

Overrides:

InternalWrite in class HTMLElement

Parameters:

bFormat - Pass a boolean indicating whether or not to format the output.

sb - Pass an XPStringBuilder to which you wish the String appended. Pass null if you do not wish the string appended to an XPStringBuilder.

response - Pass an IXPResponse to which you wish the String written. Pass null if you do not wish the string written to an IXPResponse.

Throws:

HTMLException

AppendBeginningOfOpeningTag

protected void AppendBeginningOfOpeningTag(boolean bFormat,
                                           XPStringBuilder sb,
                                           IXPResponse response)

This method generates the beginning of the opening tag. The abstract HTMLElement superclass will provide the remainder of the opening tag, repleate with attributes common to all html elements, such as name, and id, and class.

Specified by:

AppendBeginningOfOpeningTag in class HTMLElement

Parameters:

bFormat - boolean indicating whether or not to format.

sb - XPStringBuilder

response - IXPResponse

GetTabIndex

public java.lang.String GetTabIndex()

Returns the tab index.

Returns:

String the tab index.

SetTabIndex

public void SetTabIndex(java.lang.String _sTabIndex)

Sets the tab index.

ClearTabIndex

public void ClearTabIndex()

Sets sTabIndex to null.

AppendClosingTag

protected void AppendClosingTag(boolean bFormat,
                                XPStringBuilder sb,
                                IXPResponse response)

This method generates the closing tag of this html element. If the providesClosingTag method returns false, then this method will never be called.

Specified by:

AppendClosingTag in class HTMLElement

Parameters:

bFormat - boolean indicating whether or not to format.

sb - XPStringBuilder

response - IXPResponse

ProvidesClosingTag

protected boolean ProvidesClosingTag()

Indicates whether or not this HTML element provides a closing tag. Some elements only provide opening tags, such as the <br> element.

Specified by:

ProvidesClosingTag in class HTMLElement

Returns:

boolean true.