com.sas.servlet.tbeans.ipage.iform
Class IFormTextEntry

com.sas.servlet.tbeans.ipage.iform.IFormTextEntry

All Implemented Interfaces:

com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, RenderableInterface, TransformationInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

public class IFormTextEntry

The IFormTextEntry is a TransformationBean™ used to produce a form using a variety of markup languages (including WML,HDML, and HTML). This class will produce the appropriate markup language based on the requesting browser. For example, if a user accesses a JSP page containing an IForm from their cell phone, the IForm bean will produce either WML or HDML based on the type of browser the cell phone contained. If another user accesses the same JSP page using Internet Explorer, the IForm bean would produce HTML instead.

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:IFormTextEntry 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.ipage.BaseIPage

HTML_PROLOG, WML_PROLOG

Constructor Summary

IFormTextEntry()
The default constructor.

IFormTextEntry(java.lang.String name)
Construct a new IFormTextEntry.

IFormTextEntry(java.lang.String name, java.lang.String prompt)
Construct a new IFormTextEntry.

IFormTextEntry(java.lang.String name, java.lang.String prompt, java.lang.String format)
Construct a new IFormTextEntry.

Method Summary

java.lang.String	getFormat() Gets the format of the element.
java.lang.String	getValue() Gets the default text value of the element.
void	setFormat(java.lang.String format) Sets the format of this element.
void	setValue(java.lang.String value) Sets the default text value of this element shown when the element is first displayed.
void	writeBase(java.io.PrintWriter out) Writes the main base section of the IFormElement bean.
void	writeFooter(java.io.PrintWriter out) Writes the footer.
void	writeHeader(java.io.PrintWriter out) Writes the header.

Methods inherited from class com.sas.servlet.tbeans.ipage.iform.BaseIFormElement

getAcceptLabel, getAcceptURL, getParentIForm, getPrompt, getShortPrompt, setAcceptLabel, setAcceptURL, setParentIForm, setPrompt, setShortPrompt, write, write

Methods inherited from class com.sas.servlet.tbeans.ipage.BaseIPage

addOption, getBrowserType, getCacheTimeToLive, getOptionLabel, getOptionURL, getTitle, resolveNewLine, setBrowserType, setCacheTimeToLive, setId, setName, setName, setRequest, setResponse, setStyle, setStyleClass, setTitle, toString, writeBase, writeBase, writeFooter, writeFooter, writeHeader, writeHeader

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

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

Constructor Detail

IFormTextEntry

public IFormTextEntry()

The default constructor.

IFormTextEntry

public IFormTextEntry(java.lang.String name)

Construct a new IFormTextEntry.

Parameters:

name - The name of the element

IFormTextEntry

public IFormTextEntry(java.lang.String name,
                      java.lang.String prompt)

Construct a new IFormTextEntry.

Parameters:

name - The name of the element

prompt - The prompt to be prepended

IFormTextEntry

public IFormTextEntry(java.lang.String name,
                      java.lang.String prompt,
                      java.lang.String format)

Construct a new IFormTextEntry.

Parameters:

name - The name of the element

prompt - The prompt to be prepended

format - The format of the input

Method Detail

setFormat

public void setFormat(java.lang.String format)

Sets the format of this element. This is mainly used for formatting input to a phone.

Parameters:

format - The format String

getFormat

public java.lang.String getFormat()

Gets the format of the element.

Returns:

The format String

setValue

public void setValue(java.lang.String value)

Sets the default text value of this element shown when the element is first displayed. If not set, then the text entry field will contain no value.

Parameters:

text - The default text String

getValue

public java.lang.String getValue()

Gets the default text value of the element.

Returns:

The default text value String

writeHeader

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

Writes the header. Writes IFormElement's header markup.

Overrides:

writeHeader in class BaseIFormElement

Parameters:

out - The output stream

Throws:

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

writeBase

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

Writes the main base section of the IFormElement bean. The writeHeader method should be called before this method and writeFooter should be called after this method.

Overrides:

writeBase in class BaseIFormElement

Parameters:

out - The output stream

Throws:

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

writeFooter

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

Writes the footer. Writes the IFormElement footer information. This is normally the last information written.

Overrides:

writeFooter in class BaseIFormElement

Parameters:

out - The output stream

Throws:

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