acme.textui.ACMEFieldOriginator.ACMEFieldOriginator

class documentation

class ACMEFieldOriginator(ACMEInputField):

An input field for an originator in the ACME text UI.

Method	`__init__`	Initialize the originator field.
Method	`update`	Update the originator field.
Instance Variable	`originator`	The originator value of the field.
Instance Variable	`suggestions`	The suggestions for the field.
Instance Variable	`value`	Return the value of the input field.

Inherited from ACMEInputField:

Class	`Submitted`	The message that is sent when the input field is submitted.
Method	`compose`	Compose the input field.
Method	`setLabel`	Set the label of the field.
Method	`setSuggestions`	Set the suggestions for the input field.
Method	`show_validation_feedback`	Show the validation feedback.
Async Method	`submit`	Submit the input field.
Method	`value.setter`	Set the value of the input field.
Property	`inputField`	Return the input field.
Property	`msgField`	Return the message field.
Instance Variable	`_fieldInput`	The input view of the input field.
Instance Variable	`_fieldLabel`	The label view of the input field.
Instance Variable	`_fieldMessage`	The message view of the input field.
Instance Variable	`_labelText`	The label text of the input field.
Instance Variable	`_placeholder`	The placeholder text of the input field.
Instance Variable	`_suggestions`	The suggestions for the input field.
Instance Variable	`_validators`	The validators of the input field.
Instance Variable	`_value`	The value of the input field.

def __init__(self, originator: str, suggestions: list[str] = [], requestView: Widget | None = None): ¶

overrides acme.textui.ACMEFieldOriginator.ACMEInputField.__init__

Initialize the originator field.

Parameters
originator:`str`	The value of the field.
suggestions:`list[str]`	The suggestions for the field.
requestView:`Widget \| None`	The request view for context (to determine operation type).

def update(self, originator: str, suggestions: list[str] = []): ¶

Update the originator field.

Parameters
originator:`str`	The value of the field.
suggestions:`list[str]`	The suggestions for the field.

originator = ¶

The originator value of the field.

suggestions = ¶

The suggestions for the field.

value = ¶

overrides acme.textui.ACMEFieldOriginator.ACMEInputField.value

Return the value of the input field.

Returns
The value of the input field.