Docs For Class SimpleWidget

Description

Form element.

Located in /tag.php (line 231)

SimpleTag
   |
   --SimpleWidget

Direct descendents

Class	Description
SimpleTextTag	Text, password and hidden field.
SimpleSubmitTag	Submit button as input tag.
SimpleImageSubmitTag	Image button as input tag.
SimpleButtonTag	Submit button as button tag.
SimpleTextAreaTag	Content tag for text area.
SimpleUploadTag	File upload widget.
SimpleSelectionTag	Drop down widget.
MultipleSelectionTag	Drop down widget.
SimpleOptionTag	Option for selection field.
SimpleRadioButtonTag	Radio button.
SimpleCheckboxTag	Checkbox widget.

Variable Summary

mixed $_is_set

mixed $_label

mixed $_value

Method Summary

SimpleWidget SimpleWidget (string $name, hash $attributes)

string getDefault ()

string getName ()

string getValue ()

boolean isLabel (string $label)

void resetValue ()

void setLabel (string $label)

boolean setValue (string $value)

void write ( &$encoding, SimpleEncoding $encoding)

Variables

mixed $_is_set (line 234)

mixed $_label (line 233)

mixed $_value (line 232)

Inherited Variables

Inherited from SimpleTag

SimpleTag::$_attributes
SimpleTag::$_content
SimpleTag::$_name

Methods

Constructor SimpleWidget (line 242)

Starts with a named tag with attributes only.

SimpleWidget SimpleWidget (string $name, hash $attributes)

string $name: Tag name.
hash $attributes: Attribute names and string values.

getDefault (line 264)

Accessor for default value parsed with the tag.

return: Parsed value.
access: public

string getDefault ()

Redefined in descendants as:

SimpleTextAreaTag::getDefault() : Accessor for starting value.
SimpleSelectionTag::getDefault() : Scans options for defaults. If none, then the first option is selected.
MultipleSelectionTag::getDefault() : Scans options for defaults to populate the value array().
SimpleOptionTag::getDefault() : Accessor for starting value. Will be set to the option label if no value exists.
SimpleRadioButtonTag::getDefault() : Accessor for starting value.
SimpleCheckboxTag::getDefault() : Accessor for starting value. The default value is "on".

getName (line 255)

Accessor for name submitted as the key in GET/POST variables hash.

return: Parsed value.
access: public

string getName ()

getValue (line 275)

Accessor for currently set value or default if none.

return: Value set by form or default if none.
access: public

string getValue ()

Redefined in descendants as:

SimpleSelectionTag::getValue() : Accessor for current selection value.
MultipleSelectionTag::getValue() : Accessor for current selection value.

isLabel (line 319)

Reads external or internal label.

return: True is match.
access: public

boolean isLabel (string $label)

string $label: Label to test.

Redefined in descendants as:

SimpleSubmitTag::isLabel() : Test for a label match when searching.
SimpleImageSubmitTag::isLabel() : Test for a label match when searching.
SimpleButtonTag::isLabel() : Test for a label match when searching.

resetValue (line 299)

Resets the form element value back to the default.

access: public

void resetValue ()

setLabel (line 309)

Allows setting of a label externally, say by a label tag.

access: public

void setLabel (string $label)

string $label: Label to attach.

setValue (line 288)

Sets the current form element value.

return: True if allowed.
access: public

boolean setValue (string $value)

string $value: New value.

Redefined in descendants as:

SimpleTextTag::setValue() : Sets the current form element value. Cannot change the value of a hidden field.
SimpleSubmitTag::setValue() : Disables the setting of the button value.
SimpleImageSubmitTag::setValue() : Disables the setting of the button value.
SimpleButtonTag::setValue() : Disables the setting of the button value.
SimpleTextAreaTag::setValue() : Applies word wrapping if needed.
SimpleSelectionTag::setValue() : Can only set allowed values.
MultipleSelectionTag::setValue() : Can only set allowed values. Any illegal value will result in a failure, but all correct values will be set.
SimpleOptionTag::setValue() : Does nothing.
SimpleRadioButtonTag::setValue() : The only allowed value sn the one in the "value" attribute.
SimpleCheckboxTag::setValue() : The only allowed value in the one in the "value" attribute. The default for this attribute is "on". If this widget is set to true, then the usual value will be taken.

write (line 328)

Dispatches the value into the form encoded packet.

access: public

void write ( &$encoding, SimpleEncoding $encoding)

SimpleEncoding $encoding: Form packet.
&$encoding

Redefined in descendants as:

SimpleImageSubmitTag::write() : Dispatches the value into the form encoded packet.
SimpleUploadTag::write() : Dispatches the value into the form encoded packet.

Inherited Methods

Inherited From SimpleTag

SimpleTag::SimpleTag()
SimpleTag::addContent()
SimpleTag::addTag()
SimpleTag::expectEndTag()
SimpleTag::getAttribute()
SimpleTag::getChildElements()
SimpleTag::getContent()
SimpleTag::getTagName()
SimpleTag::getText()
SimpleTag::isId()
SimpleTag::isPrivateContent()
SimpleTag::_setAttribute()