com.esri.gpt.catalog.schema
Class InputTextArray

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.InputTextArray

public class InputTextArray
extends InputText

An array of input text components associated with a metadata parameter.

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

Example:

<parameter key="theme">
<input type="textArray" arraySize="10"/>
</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

InputTextArray()
Default constructor.

InputTextArray(InputTextArray 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.
InputTextArray	duplicate() Produces a deep clone of the object.
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
int	getArraySize() Gets the number of input text components in the array.
UIComponent	makeInputComponent(UiContext context, Section section, Parameter parameter) Makes a Faces HtmlPanelGroup containing a collection of HtmlInputTextarea components for a parameter.
void	setArraySize(int size) Sets the number of input text components in the array.
void	unBind(UiContext context, UIComponent editorForm, Parameter parameter) Triggered on the save event from the metadata editor.

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

getDefaultMaxlength, getDefaultSize, getMaxlength, getSize, setMaxlength, setSize

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

InputTextArray

public InputTextArray()

Default constructor.

InputTextArray

public InputTextArray(InputTextArray objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getArraySize

public int getArraySize()

Gets the number of input text components in the array.

Returns:

the number of input text components

setArraySize

public void setArraySize(int size)

Sets the number of input text components in the array.

Parameters:

size - the number of input text components

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:
arraySize

Overrides:

configure in class InputText

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

duplicate

public InputTextArray duplicate()

Produces a deep clone of the object.
The duplication constructor is invoked.
return new InputTextArray(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 HtmlPanelGroup containing a collection of HtmlInputTextarea components 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

unBind

public void unBind(UiContext context,
                   UIComponent editorForm,
                   Parameter parameter)
            throws SchemaException

Triggered on the save event from the metadata editor.

On this event, the array of input values are used to generate the parameter's multiple values (parameter.getMultipleValues()).

Overrides:

unBind in class InputText

Parameters:

context - the UI context

editorForm - the Faces HtmlForm for the metadata editor

parameter - the associated parameter

Throws:

SchemaException - if an associated Faces UIComponent cannot be located