Class SimpleTextAreaTag

Description

Content tag for text area.

Located in /tag.php (line 680)

SimpleTag
   |
   --SimpleWidget
      |
      --SimpleTextAreaTag
Method Summary
 SimpleTextAreaTag __construct (hash $attributes)
 string getDefault ()
 boolean isPrivateContent ()
 boolean setValue (string $value)
 string wrap (string $text)
Methods
Constructor __construct (line 687)

Starts with a named tag with attributes only.

SimpleTextAreaTag __construct (hash $attributes)
  • hash $attributes: Attribute names and string values.

Redefinition of:
SimpleWidget::__construct()
Starts with a named tag with attributes only.
getDefault (line 696)

Accessor for starting value.

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

Redefinition of:
SimpleWidget::getDefault()
Accessor for default value parsed with the tag.
isPrivateContent (line 755)

The content of textarea is not part of the page.

  • return: True.
  • access: public
boolean isPrivateContent ()

Redefinition of:
SimpleTag::isPrivateContent()
The current tag should not swallow all content for itself as it's searchable page content. Private content tags are usually widgets that contain default values.
setValue (line 706)

Applies word wrapping if needed.

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

Redefinition of:
SimpleWidget::setValue()
Sets the current form element value.
wrap (line 735)

Performs the formatting that is peculiar to this tag. There is strange behaviour in this one, including stripping a leading new line.

Go figure. I am using Firefox as a guide.

  • return: Text wrapped with carriage returns and line feeds
  • access: protected
string wrap (string $text)
  • string $text: Text to wrap.

Inherited Methods

Inherited From SimpleWidget

 SimpleWidget::__construct()
 SimpleWidget::getDefault()
 SimpleWidget::getName()
 SimpleWidget::getValue()
 SimpleWidget::isLabel()
 SimpleWidget::resetValue()
 SimpleWidget::setLabel()
 SimpleWidget::setValue()
 SimpleWidget::write()

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:39 -0500 by phpDocumentor 1.4.3