SwatObject
└─SwatUIObject
└─SwatWidget
└─SwatControl
└─SwatInputControl
└─SwatEntry
public class SwatEntry
extends SwatInputControl
| Field Summary | |
|---|---|
| string | Access key. |
| boolean | Whether or not to use browser-based autocompletion on this entry. |
| integer | Maximum length. |
| integer | Minimum length. |
| protected string | If autocomplete is turned off, this nonce is used to obfuscate the name of the XHTML input tag. |
| boolean | Read only?. |
| integer | Input size. |
| integer | Tab index. |
| string | Entry value. |
| Fields inherited from Swat.SwatInputControl | |
|---|---|
| required | |
| Method Summary | |
|---|---|
| void | display() Displays this entry widget. |
| protected array | Gets the array of CSS classes that are applied to this entry widget. |
| protected string | getDisplayValue(string value) Formats a value to display. |
| string | Gets the id attribute of the XHTML element displayed by this widget that should receive focus. |
| protected SwatHtmlTag | Get the input tag to display. |
| protected void | getNonce() |
| protected string | Gets the raw value entered by the user before processing. |
| string | getState() Gets the current state of this entry widget. |
| protected SwatMessage | getValidationMessage(string id) Gets a validation message for this entry. |
| protected boolean | Gets whether or not a value was submitted by the user for this entry. |
| void | process() Processes this entry widget. |
| void | setState(string state) Sets the current state of this entry widget. |
| Methods inherited from Swat.SwatInputControl | |
|---|---|
| getForm, init | |
| Methods inherited from Swat.SwatControl | |
|---|---|
| addMessage, getNote, printWidgetTree | |
| Methods inherited from Swat.SwatWidget | |
|---|---|
| addCompositeWidget, addMessage, confirmCompositeWidgets, copy, createCompositeWidgets, display, displayHtmlHeadEntries, getCSSClassNames, getCompositeWidget, getCompositeWidgets, getFocusableHtmlId, getHtmlHeadEntrySet, getMessages, hasMessage, init, isDisplayed, isInitialized, isProcessed, isSensitive, printWidgetTree, process, replaceWithContainer | |
| Methods inherited from Swat.SwatUIObject | |
|---|---|
| addComment, addJavaScript, addStyleSheet, addTangoAttribution, copy, getCSSClassNames, getCSSClassString, getFirstAncestor, getHtmlHeadEntrySet, getInlineJavaScript, getUniqueId, isVisible | |
public string $access_key = null
Access key
Access key for this form input, for keyboard nagivation.
public boolean $autocomplete = true
Whether or not to use browser-based autocompletion on this entry
Note: Be careful writing JavaScript when using this property as it changes the id of the XHTML element.
public integer $maxlength = null
Maximum length
Maximum number of allowable characters in HTML text form input, or null.
public integer $minlength = null
Minimum length
Minimum number of allowable characters in HTML text form input, or null.
protected string $nonce = null
If autocomplete is turned off, this nonce is used to obfuscate the name of the XHTML input tag.
public boolean $read_only = false
Read only?
If read-only, the input will not allow editing its contents
public integer $size = 50
Input size
Size in characters of the HTML text form input, or null.
public integer $tab_index = null
Tab index
The ordinal tab index position of the XHTML input tag, or null.
public string $value = null
Entry value
Text content of the widget, or null.
public void display()
Displays this entry widget
Outputs an appropriate XHTML tag.
protected array getCSSClassNames()
Gets the array of CSS classes that are applied to this entry widget
protected string getDisplayValue(string value)
Formats a value to display
Can be used by subclasses to change what is displayed.
value - the value to format for display.public string getFocusableHtmlId()
Gets the id attribute of the XHTML element displayed by this widget that should receive focus
protected SwatHtmlTag getInputTag()
Get the input tag to display
Can be used by sub-classes to change the setup of the input tag.
protected void getNonce()
protected string getRawValue()
Gets the raw value entered by the user before processing
public string getState()
Gets the current state of this entry widget
protected SwatMessage getValidationMessage(string id)
Gets a validation message for this entry
Can be used by sub-classes to change the validation messages.
id - the string identifier of the validation message.protected boolean hasRawValue()
Gets whether or not a value was submitted by the user for this entry
Note: Users can submit a value of nothing and this method will return true. This method only returns false if no data was submitted at all.
public void process()
Processes this entry widget
If any validation type errors occur, an error message is attached to this entry widget.
public void setState(string state)
Sets the current state of this entry widget
state - the new state of this entry widget.
A single line text entry widget