com.esri.gpt.catalog.schema
Class InputTextArea

java.lang.Object
  com.esri.gpt.catalog.schema.Component
      com.esri.gpt.catalog.schema.UiComponent
          com.esri.gpt.catalog.schema.Input
              com.esri.gpt.catalog.schema.InputText
                  com.esri.gpt.catalog.schema.InputTextArea

Direct Known Subclasses:

InputDelimitedTextArea

public class InputTextArea
extends InputText

Input text area component associated with a metadata parameter.

The component is configured from a node with a schema configuration XML document.

Example:

<parameter key="abstract">
<input type="textArea" cols="60" rows="8"/>
</parameter>

Field Summary

Fields inherited from class com.esri.gpt.catalog.schema.Input

INPUTTYPE_DELIMITEDTEXTAREA, INPUTTYPE_MAP, INPUTTYPE_SELECTMANYCHECKBOX, INPUTTYPE_SELECTONEMEMU, INPUTTYPE_SELECTWITHOTHER, INPUTTYPE_TEXT, INPUTTYPE_TEXTAREA, INPUTTYPE_TEXTARRAY, INPUTTYPE_UNKNOWN

Constructor Summary

InputTextArea()
Default constructor.

InputTextArea(InputTextArea objectToDuplicate)
Construct by duplicating an existing object.

Method Summary

void	configure(CfgContext context, Node node, NamedNodeMap attributes) Configures the object based upon a node loaded from a schema configuration XML.
InputTextArea	duplicate() Produces a deep clone of the object.
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
int	getCols() Gets the number of columns in the text area component.
int	getDefaultCols() Gets the default number of columns (60).
int	getDefaultMaxlength() Gets the default max length (4000).
int	getDefaultRows() Gets the default number of rows (8).
int	getRows() Gets the number of rows in the text area component.
UIComponent	makeInputComponent(UiContext context, Section section, Parameter parameter) Makes a Faces HtmlInputTextarea component for a parameter.
void	setCols(int size) Sets the number of columns in the text area component.
void	setRows(int size) Sets the number of rows in the text area component.

Methods inherited from class com.esri.gpt.catalog.schema.InputText

getDefaultSize, getMaxlength, getSize, setMaxlength, setSize, unBind

Methods inherited from class com.esri.gpt.catalog.schema.Input

applyHint, evaluateDefault, findInputComponent, formatValue, getDefaultValue, getEditable, getFacesId, getHintMode, getHintResourceKey, getInputValue, getOnChange, getOnClick, getTestResourceKey, makeOutputComponent, setComponentValue, setDefaultValue, setEditable, setFacesId, setHintMode, setHintResourceKey, setOnChange, setOnClick, setTestResourceKey

Methods inherited from class com.esri.gpt.catalog.schema.UiComponent

getStyleClass, makeBR, makeNBSP, setStyleClass

Methods inherited from class com.esri.gpt.catalog.schema.Component

getKey, setKey, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InputTextArea

public InputTextArea()

Default constructor.

InputTextArea

public InputTextArea(InputTextArea objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getDefaultCols

public int getDefaultCols()

Gets the default number of columns (60).

Returns:

the default number of columns

getDefaultMaxlength

public int getDefaultMaxlength()

Gets the default max length (4000).

Overrides:

getDefaultMaxlength in class InputText

Returns:

the default max length

getDefaultRows

public int getDefaultRows()

Gets the default number of rows (8).

Returns:

the number of rows

getCols

public int getCols()

Gets the number of columns in the text area component.

Returns:

the number of columns

setCols

public void setCols(int size)

Sets the number of columns in the text area component.

Parameters:

size - the number of columns

getRows

public int getRows()

Gets the number of rows in the text area component.

Returns:

the number of rows

setRows

public void setRows(int size)

Sets the number of rows in the text area component.

Parameters:

size - the number of rows

configure

public void configure(CfgContext context,
                      Node node,
                      NamedNodeMap attributes)

Configures the object based upon a node loaded from a schema configuration XML.
The super.configure method should be invoked prior to any sub-class configuration.

The following attributes are configured:
cols rows

Overrides:

configure in class InputText

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

duplicate

public InputTextArea duplicate()

Produces a deep clone of the object.
The duplication constructor is invoked.
return new InputTextArea(this);

Overrides:

duplicate in class InputText

echo

public void echo(StringBuffer sb)

Appends property information for the component to a StringBuffer.
The method is intended to support "FINEST" logging.
super.echo should be invoked prior appending any local information.

Overrides:

echo in class InputText

Parameters:

sb - the StringBuffer to use when appending information

makeInputComponent

public UIComponent makeInputComponent(UiContext context,
                                      Section section,
                                      Parameter parameter)

Makes a Faces HtmlInputTextarea component for a parameter.

Overrides:

makeInputComponent in class InputText

Parameters:

context - the UI context

section - the parent section

parameter - the associated parameter

Returns:

the UI component