Zope 3 apidoc

Base interfaces

Attributes/Fields

name (Attribute)

The unique widget name

This must be unique within a set of widgets.
hint (Attribute)

A hint regarding the use of the widget.

Hints are traditionally rendered using tooltips in GUIs, but may be rendered differently depending on the UI implementation.

Hint may be translated for the request.

The attribute may be implemented as either a read-write or read-only property, depending on the requirements for a specific implementation.
request (Attribute)

The request

The request is a surrogate for the user. It also provides the presentation type and skin. It is of type IPresentationRequest.
label (Attribute)

The widget label.

Label may be translated for the request.

The attribute may be implemented as either a read-write or read-only property, depending on the requirements for a specific implementation.
visible (Attribute)

A flag indicating whether or not the widget is visible.
context (Attribute)

The context of the object

This is the object being adapted, viewed, extended, etc.
required * - Bool (default = None)

Required

If True, widget should be displayed as requiring input.

By default, this value is the field's 'required' attribute. This field can be set to False for widgets that always provide input (e.g. a checkbox) to avoid unnecessary 'required' UI notations.

* = required

Methods

hasValidInput()

Returns True is the widget has valid input.

This method is similar to hasInput but it also confirms that the input provided by the user can be converted to a valid field value based on the field constraints.
setRenderedValue(value)

Set the value to be rendered by the widget.

Calling this method will override any values provided by the user.

For input widgets (IInputWidget implementations), calling this sets the value that will be rendered even if there is already user input.
applyChanges(content)

Validate the user input data and apply it to the content.

Return a boolean indicating whether a change was actually applied.

This raises an error if there is no user input.
hasInput()

Returns True if the widget has input.

Input is used by the widget to calculate an 'input value', which is a value that can be legally assigned to a field.

Note that the widget may return True, indicating it has input, but still be unable to return a value from getInputValue. Use hasValidInput to determine whether or not getInputValue will return a valid value.

A widget that does not have input should generally not be used to update its bound field. Values set using setRenderedValue() do not count as user input.

A widget that has been rendered into a form which has been submitted must report that it has input. If the form containing the widget has not been submitted, the widget shall report that it has no input.
getInputValue()

Return value suitable for the widget's field.

The widget must return a value that can be legally assigned to its bound field or otherwise raise WidgetInputError.

The return value is not affected by setRenderedValue().
setPrefix(prefix)

Set the name prefix used for the widget

The widget name is used to identify the widget's data within input data. For example, for HTTP forms, the widget name is used for the form key.

It is acceptable to reset the prefix: set it once to read values from the request, and again to redraw with a different prefix but maintained state.

Adapters for objects providing this interface:

Specific Adapters

There are no specific adapters registered for this interface.

Extended Adapters

There are no extended adapters registered for this interface.

Generic Adapters

Views

Interface
zope.app.form.interfaces.IInputWidget

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Classes

Interface zope.app.form.interfaces.IInputWidget

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Other Information

Classes

Interface
zope.app.form.interfaces.IInputWidget