TextBoxAttribute class

public class TextBoxAttribute

com.sybase365.mobiliser.brand.plugins.smapp.controls.InputAttribute class

All public members of the TextBoxAttribute class, including all inherited members.

Name	Description
Attribute constructor	Default value (if provided)
InputAttribute constructor	Constructor.
TextBoxAttribute constructor	Constructor.
getDescription method	Detailed description of the attribute.
getId method	Attribute Id.
getInputType method	Input type can be changed from the State Editor by checking/unchecking the input attribute checkbox, to set to InputType#SESSION or InputType#ATTRIBUTE, respectively.
getInputValue method	More efficient way to check and obtain the value of the input attribute using a single database call.
getInputValueWithWarning method	Similar to getInputValue() but this method throws RequiredParameterMissingException when the input attribute is not optional (or mandatory) but the value is null (or not populated).
getText method	The text that was entered in the input field on the state editor.
getValue method	Get the InputValue with no warning.
isCheckboxEnabled method	Whether the UI checkbox component is enabled or not.
isOptional method	Whether the input attribute is optional.
isSet method	Return True/False when the InputAttribute contains value or not, respectively.
setCheckboxEnabled method	Enable or disable the checkbox.
setContext method	Sets the processing engine context.
setDescription method	Detailed description of the attribute.
setId method	Attribute Id.
setInputType method	Input type can be changed from the State Editor by checking/unchecking the input attribute checkbox, to set it to InputType#SESSION or InputType#ATTRIBUTE, respectively.
setOptional method	Set the input attribute optional status.
InputType enumeration	Indicate how to treat the value provided in the input field, either as a "static value" or as a "session variable name" to retrieve the actual value from session variable using the specified name.

All protected members of the TextBoxAttribute class, including all inherited members.

Name	Description
getContext method	Sets the processing engine context.
getRawValue method	Helper class used internally by the getInputValue(), getInputValueWithWarning(), and getValue().
getRawValueLog method	Helper class called internally by getRawValue().
description variable	Description that will be displayed on the state editor for user consumption.
encrypted variable	Indicator of whether this attribute is encrypted or not.
id variable	Unique Id of the attribute.

The State Editor will display this input field using a textbox component, allowing user to enter value.

By default, this TextBoxAttribute is of InputAttribute.InputType#SESSION (so the checkbox will be checked), and the input field will be populated with the string ID of this input attribute. So during state processing, the input attribute value will be retrieved from the session variable of the input attribute ID.

Change the value of the input field, to retrieve the input attribute value from a different session variable name.

The textbox attribute type can be changed to InputAttribute.InputType#ATTRIBUTE so that the value in the input field is used as a static value.

TextBoxAttribute class

Syntax

Base class/Interfaces

Members

Remarks