docs » cp.ui.TextField
Text Field Module.
- Functions - API calls offered directly by the extension
- matches
- Fields - Variables which can only be accessed from an object returned by a constructor
- value
- Methods - API calls which can only be made on an object returned by a constructor
- clear
- doConfirm
- doFocus
- forceFocus
- getValue
- loadLayout
- saveLayout
- setValue
- TextField
Signature | cp.ui.TextField.matches(element[, subrole]) -> boolean |
---|---|
Type | Function |
Description | Checks to see if an element matches what we think it should be. |
Parameters |
|
Returns |
|
Signature | cp.ui.TextField.value <cp.prop: string> |
---|---|
Type | Field |
Description | The current value of the text field. |
Signature | cp.ui.TextField:clear() -> self |
---|---|
Type | Method |
Description | Clears the value of a Text Field. |
Parameters |
|
Returns |
|
Signature | cp.ui.TextField:doConfirm() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that will confirm the current text value. |
Signature | cp.ui.TextField:doFocus() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that will attempt to focus on the current TextField . |
Signature | cp.ui.TextField:forceFocus() |
---|---|
Type | Method |
Description | Configures the TextField to force a focus on the field before editing. |
Signature | cp.ui.TextField:getValue() -> string |
---|---|
Type | Method |
Description | Gets the value of the Text Field. |
Parameters |
|
Returns |
|
Signature | cp.ui.TextField:loadLayout(layout) -> none |
---|---|
Type | Method |
Description | Loads a Text Field layout. |
Parameters |
|
Returns |
|
Signature | cp.ui.TextField:saveLayout() -> table |
---|---|
Type | Method |
Description | Saves the current Text Field layout to a table. |
Parameters |
|
Returns |
|
Signature | cp.ui.TextField:setValue(value) -> self |
---|---|
Type | Method |
Description | Sets the value of the Text Field. |
Parameters |
|
Returns |
|
Signature | cp.ui.TextField(parent, uiFinder[, convertFn]) -> TextField |
---|---|
Type | Method |
Description | Creates a new TextField. They have a parent and a finder function. |
Parameters |
|
Returns |
|