com.esri.gpt.catalog.schema
Class InputText

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

Direct Known Subclasses:

InputTextArea, InputTextArray

public class InputText
extends Input

Input text component associated with a metadata parameter.

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

Example:

<parameter key="fileIdentifier">
<input type="text" maxlength="4000" size="50"/>
</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

InputText()
Default constructor.

InputText(InputText 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.
InputText	duplicate() Produces a deep clone of the object.
void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
int	getDefaultMaxlength() Gets the default max length (128).
int	getDefaultSize() Gets the default size (50).
int	getMaxlength() Gets the max length for the input text component.
int	getSize() Gets the size for the input text component.
UIComponent	makeInputComponent(UiContext context, Section section, Parameter parameter) Makes a Faces HtmlInputText component for a parameter.
void	setMaxlength(int size) Sets the max length for the input text component.
void	setSize(int size) Sets the size for the input text component
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.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

InputText

public InputText()

Default constructor.

InputText

public InputText(InputText objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getDefaultMaxlength

public int getDefaultMaxlength()

Gets the default max length (128).

Returns:

the default max length

getDefaultSize

public int getDefaultSize()

Gets the default size (50).

Returns:

the default size

getMaxlength

public int getMaxlength()

Gets the max length for the input text component.

Returns:

the max length

setMaxlength

public void setMaxlength(int size)

Sets the max length for the input text component.

Parameters:

size - the max length

getSize

public int getSize()

Gets the size for the input text component.

Returns:

the size

setSize

public void setSize(int size)

Sets the size for the input text component

Parameters:

size - the size

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:
maxlength size

Overrides:

configure in class Input

Parameters:

context - the configuration context

node - the configuration node

attributes - the attributes of the configuration node

duplicate

public InputText duplicate()

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

Specified by:

duplicate in class Input

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 Input

Parameters:

sb - the StringBuffer to use when appending information

makeInputComponent

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

Makes a Faces HtmlInputText component for a parameter.

Specified by:

makeInputComponent in class Input

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 HtmlInputText input value is propagated to the parameter's singleValue.

Overrides:

unBind in class Input

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