Class SimpleWidget

Description

Form element.

Located in /tag.php (line 337)

SimpleTag
   |
   --SimpleWidget
Direct descendents
Class Description
 class SimpleTextTag Text, password and hidden field.
 class SimpleSubmitTag Submit button as input tag.
 class SimpleImageSubmitTag Image button as input tag.
 class SimpleButtonTag Submit button as button tag.
 class SimpleTextAreaTag Content tag for text area.
 class SimpleUploadTag File upload widget.
 class SimpleSelectionTag Drop down widget.
 class MultipleSelectionTag Drop down widget.
 class SimpleOptionTag Option for selection field.
 class SimpleRadioButtonTag Radio button.
 class SimpleCheckboxTag Checkbox widget.
Method Summary
 SimpleWidget __construct (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 (SimpleEncoding $encoding)
Methods
Constructor __construct (line 348)

Starts with a named tag with attributes only.

SimpleWidget __construct (string $name, hash $attributes)
  • string $name: Tag name.
  • hash $attributes: Attribute names and string values.

Redefinition of:
SimpleTag::__construct()
Starts with a named tag with attributes only.

Redefined in descendants as:
getDefault (line 370)

Accessor for default value parsed with the tag.

  • return: Parsed value.
  • access: public
string getDefault ()

Redefined in descendants as:
getName (line 361)

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

  • return: Parsed value.
  • access: public
string getName ()
getValue (line 381)

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:
isLabel (line 426)

Reads external or internal label.

  • return: True is match.
  • access: public
boolean isLabel (string $label)
  • string $label: Label to test.

Redefined in descendants as:
resetValue (line 405)

Resets the form element value back to the default.

  • access: public
void resetValue ()
setLabel (line 415)

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

  • access: public
void setLabel (string $label)
  • string $label: Label to attach.
setValue (line 394)

Sets the current form element value.

  • return: True if allowed.
  • access: public
boolean setValue (string $value)
  • string $value: New value.

Redefined in descendants as:
write (line 435)

Dispatches the value into the form encoded packet.

  • access: public
void write (SimpleEncoding $encoding)

Redefined in descendants as:

Inherited Methods

Inherited From SimpleTag

 SimpleTag::__construct()
 SimpleTag::addContent()
 SimpleTag::addTag()
 SimpleTag::addTags()
 SimpleTag::expectEndTag()
 SimpleTag::getAttribute()
 SimpleTag::getChildElements()
 SimpleTag::getContent()
 SimpleTag::getTagName()
 SimpleTag::getText()
 SimpleTag::isId()
 SimpleTag::isPrivateContent()
 SimpleTag::setAttribute()

Documentation generated on Sun, 31 Oct 2010 16:32:40 -0500 by phpDocumentor 1.4.3