# Class TextBox

Text HTML input box custom widget

Package: alpha::view::widgets
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, are permitted provided that the
    following conditions are met:

    * Redistributions of source code must retain the above
      copyright notice, this list of conditions and the
      following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the
      following disclaimer in the documentation and/or other
      materials provided with the distribution.
    * Neither the name of the Alpha Framework nor the names
      of its contributors may be used to endorse or promote
      products derived from this software without specific
      prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: TextBox.inc 1548 2012-07-29 17:07:07Z alphadevx $
Since: 1.0
Located at view/widgets/TextBox.inc

Methods summary
`public` | # `__construct( `Text` $text, string $label, string $name, integer $rows = 5, integer $identifier = 0 )` The constructor The constructor #### Parameters $text ``Text`` $text The text object that will be edited by this text box. $label `string` $label The data label for the text object. $name `string` $name The name of the HTML input box. $rows `integer` $rows The display size (rows). $identifier `integer` $identifier An additional idenitfier to append to the id of the text box. #### Throws ``IllegalArguementException`` #### Since 1.0
`public string` | # `render( boolean $tableTags = true, boolean $markdown = false )` Renders the HTML and javascript for the text box Renders the HTML and javascript for the text box #### Parameters $tableTags `boolean` $tableTags Determines if table tags are also rendered for the TextBox $markdown `boolean` $markdown Set to true when rendering Markdown text content fields #### Returns `string` #### Since 1.0
`public` | # `setTextObject( string $text )` Setter for text object Setter for text object #### Parameters $text `string` $text #### Throws ``IllegalArguementException`` #### Since 1.0
`public `Text`` | # `getTextObject( )` Getter for text object Getter for text object #### Returns ``Text`` #### Since 1.0

Properties summary
`public `Text`` | $textObject | `` | # The text object that will be edited by this text box The text object that will be edited by this text box #### Since 1.0
`public string` | $label | `` | # The data label for the text object The data label for the text object #### Since 1.0
`public string` | $name | `` | # The name of the HTML input box The name of the HTML input box #### Since 1.0
`public integer` | $rows | `` | # The amount of rows to display by default The amount of rows to display by default #### Since 1.0
`public integer` | $identifier | `` | # An optional additional idenitfier to append to the id of the text box where many are on one page An optional additional idenitfier to append to the id of the text box where many are on one page #### Since 1.0