com.sas.servlet.tbeans.form.html
Class TextEntry

com.sas.servlet.tbeans.form.html.TextEntry

All Implemented Interfaces:

com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, FormElementModificationEventInterface, com.sas.servlet.tbeans.form.JavaScriptObjectCreationInterface, com.sas.servlet.tbeans.JavaScriptEventHandlerInterface, RenderableInterface, StyleInterface, TransformationInterface, GenericValidatorInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

CellContentsTextEntryEditor

public class TextEntry
implements StyleInterface

The TextEntry is a TransformationBean™ that generates the appropriate HTML 4.0 for creating an HTML text entry field. The TextEntry element is a single-line input field.

Accessibility

The Section 508 Accessibility standards, such as making application tasks available through the keyboard, are incorporated into our components to improve usability for all of our software products which benefits every SAS user.

This component is fully compliant with the Web-based standards outlined in Section 508. The compliance is based on producing the correct output, having keyboard equivalent and surfacing the necessary properties to assist consumers of the component to be compliant.

The following keyboard equivalents are supported by this component:

KeyBoard Access	Behavior/Result
TAB	TAB moves the focus to the TextEntry. Hitting TAB while the TextEntry has focus will navigate focus to the next tabbable component.
ALT+ACCESSKEY	Pressing ALT+ACCESSKEY will navigate focus to the TextEntry. The ACCESSKEY indicates the keyboard character used as a shortcut to activate the element.

The following properties are provided to assist in making the application using this component accessible:

• AccessKey
• TabIndex
• KeyDown
• KeyPress
• KeyUp

The TextEntry is one of several TransformationBeans™ that rely on a set of style classes that are used by default when generating the resulting markup language. For more information on style sheets and the default style classes that apply to this TransformationBean™, refer to the AppDev Studio Developer Site. You'll find a useful reference document entitled Cascading Style Sheets, Images, and TransformationBeans™ as well as the TransformationBeans™ Style Sheet Reference.

The TextEntry is one of several TransformationBeans™ that rely on JavaScript to provide some of its functionality. These JavaScript files are including automatically by the tbean. See JavaScriptIncludeHandler for more information about how these files are included and how to customize this behavior. The TextEntry uses the following JavaScript files:

sas_TextEntry.js

Note that the toString() method on this class calls the write method, which may have undesirable side effects. See BaseTransformation.toString() for more information. Debuggers often use toString() to show the value of a variable, and this may cause unexpected behavior while debugging

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

Examples for this class may be found on the Examples Site.

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on the sas:TextEntry 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:

Serialized Form

Field Summary

Fields inherited from class com.sas.servlet.tbeans.form.BaseFormElement

RB_KEY

Constructor Summary

TextEntry()
Constructs a new TextEntry Transformation Bean

TextEntry(java.lang.String name)
Constructs a new TextEntry Transformation Bean

TextEntry(java.lang.String name, java.lang.String value)
Constructs a new TextEntry Transformation Bean

TextEntry(java.lang.String name, java.lang.String value, int size)
Constructs a new TextEntry Transformation Bean

TextEntry(java.lang.String name, java.lang.String value, int size, int len)
Constructs a new TextEntry Transformation Bean

Method Summary

void	write(java.io.PrintWriter out) Writes the transformed representation of the object
void	writeDefaultText(java.io.PrintWriter out) Writes the function to clear the default text of the object

Methods inherited from class com.sas.servlet.tbeans.form.BaseTextEntry

isAutoComplete, setAutoComplete

Methods inherited from class com.sas.servlet.tbeans.form.BaseInput

getInitialText, getMaximumLength, getSize, getText, isReadOnly, setInitialText, setMaximumLength, setReadOnly, setSize, setText

Methods inherited from class com.sas.servlet.tbeans.form.BaseFormElement

getAccessKey, getErrorHandler, getModificationEventName, getName, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleInfo, getTabIndex, getTitle, getValidationFunctions, getValidator, isEnabled, isValid, isValidationEnabled, setAccessKey, setEnabled, setErrorHandler, setId, setModificationEventName, setName, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleInfo, setTabIndex, setTitle, setValidator, writeJavaScriptObject, writeJavaScriptObjectValidate, writeJavaScriptValidatorObject, writeValidationScript

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setInputTransform, setLocale, setLocaleDependentProperties, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.servlet.tbeans.StyleInterface

getStyleInfo, setStyleInfo

Constructor Detail

TextEntry

public TextEntry()

Constructs a new TextEntry Transformation Bean

TextEntry

public TextEntry(java.lang.String name)

Constructs a new TextEntry Transformation Bean

Parameters:

name - The text field name

TextEntry

public TextEntry(java.lang.String name,
                 java.lang.String value)

Constructs a new TextEntry Transformation Bean

Parameters:

name - The text field name

value - The initial text value

TextEntry

public TextEntry(java.lang.String name,
                 java.lang.String value,
                 int size)

Constructs a new TextEntry Transformation Bean

Parameters:

name - The text field name

value - The initial text value

size - The visible size of the text field

TextEntry

public TextEntry(java.lang.String name,
                 java.lang.String value,
                 int size,
                 int len)

Constructs a new TextEntry Transformation Bean

Parameters:

name - The text field name

value - The initial text value

size - The visible size of the text field

len - The maximum input length

Method Detail

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

Writes the transformed representation of the object

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class BaseFormElement

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

writeDefaultText

public void writeDefaultText(java.io.PrintWriter out)
                      throws java.io.IOException

Writes the function to clear the default text of the object

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs