NAME
Reaction::UI::Widget::Field::Mutable - Mutable fields
DESCRIPTION
An extension of Reaction::UI::Widget::Field representing fields whose values can be mutated.
FRAGMENTS
widget
The following additional arguments are provided:
- field_id
-
Contains the viewport's event id for
value_string. - field_name
-
Defaults to the
field_idargument unless already defined - field_type
-
Defaults to
text. - field_class
-
A string containing the joined class attribute. Defaults to
action-fieldand the current viewport'sname. - exists_event
-
Contains the event id for
exists. - exists_value
-
Defaults to
1.
message_fragment
Renders nothing if the viewport doesn't have a message.
Otherwise, the message argument will be set to the localised string contained in the viewport's message attribute and the message fragment will be rendered.
field_is_required
Will render either field_is_required_yes or field_is_required_no depending on if value_is_required on the viewport returns true and the viewports value_string is empty.
LAYOUT SETS
base
share/skin/base/layout/field/mutable.tt
The following layouts are provided:
- widget
-
Builds a
spanelement with a class attribute set to thefield_classargument. The element contents will be thelabel_fragment,fieldandmessage_fragmentfragments. - label
-
Builds a
labelelement with theforattribute set to the value offield_idand the other attributes used from thefield_is_requiredargument. The content will be thelabelargument. - field_is_required_yes
-
Sets the class attribute to
required_field. - field_is_required_no
-
Empty.
- message
-
Renders a
spanelement with themessageas content. - field
-
Renders the input field. The
field_bodyfragment is used to set the value. - field_body
-
Creates the
valueattribute for the input element.
default
share/skin/default/layout/field/mutable.tt
The following layouts are provided:
- message
-
Will render the original
messagefragment followed by abrelement.
SUBCLASSES
- Reaction::UI::Widget::Field::Mutable::Boolean
-
A widget allowing the manipulation of boolean values.
- Reaction::UI::Widget::Field::Mutable::ChooseMany
-
Allows the user to choose many items from a list of available values.
- Reaction::UI::Widget::Field::Mutable::ChooseOne
-
Allows the user to choose a single item from a list of available values.
- Reaction::UI::Widget::Field::Mutable::DateTime
-
A simple DateTime Reaction::UI::Widget::Field::Mutable subclass.
- Reaction::UI::Widget::Field::Mutable::File
-
A simple file input field.
- Reaction::UI::Widget::Field::Mutable::HiddenArray
-
Renders an array reference value as a series of hidden fields.
- Reaction::UI::Widget::Field::Mutable::Integer
-
A simple integer Reaction::UI::Widget::Field::Mutable.
- Reaction::UI::Widget::Field::Mutable::MatchingPasswords
-
Password input requiring that the password be entered twice, e.g. to input a new password.
- Reaction::UI::Widget::Field::Mutable::Password
-
A password input Reaction::UI::Widget::Field::Mutable.
- Reaction::UI::Widget::Field::Mutable::Number
-
A simple number Reaction::UI::Widget::Field::Mutable input field.
- Reaction::UI::Widget::Field::Mutable::String
-
A simple string Reaction::UI::Widget::Field::Mutable input field.
- Reaction::UI::Widget::Field::Mutable::Text
-
A multiline input Reaction::UI::Widget::Field::Mutable.
SEE ALSO
AUTHORS
See Reaction::Class for authors.
LICENSE
See Reaction::Class for the license.