| alpha--view--widgets

# Class: TextBox Source Location: /view/widgets/TextBox.inc ## Class TextBox Class Overview
Text HTML input box custom widget Located in /view/widgets/TextBox.inc [line 50]
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: TextBox.inc 1453 2011-12-04 15:12:54Z johnc $
Copyright: | Copyright (c) 2011, 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.
Since: | 1.0
License: | The BSD License
| Properties $identifier $label $name $rows $textObject | Methods __construct getTextObject render setTextObject
[ Top ] Property Summary
integer | $identifier | An optional additional idenitfier to append to the id of the text box where many are on one page
string | $label | The data label for the text object
string | $name | The name of the HTML input box
integer | $rows | The amount of rows to display by default
Text | $textObject | The text object that will be edited by this text box
[ Top ] Method Summary
TextBox | __construct() | The constructor
Text | getTextObject() | Getter for text object
string | render() | Renders the HTML and javascript for the text box
void | setTextObject() | Setter for text object
[ Top ] Properties integer $identifier [line 89] An optional additional idenitfier to append to the id of the text box where many are on one page API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] string $label [line 65] The data label for the text object API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] string $name [line 73] The name of the HTML input box API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] integer $rows [line 81] The amount of rows to display by default API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] Text $textObject [line 57] The text object that will be edited by this text box API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] Methods Constructor __construct [line 102]
`TextBox __construct( Text $text, string $label, string $name, [integer $rows = 5], [integer $identifier = 0] )`
The constructor Parameters:
Text | $text: | The text object that will be edited by this text box.
string | $label: | The data label for the text object.
string | $name: | The name of the HTML input box.
integer | $rows: | The display size (rows).
integer | $identifier: | An additional idenitfier to append to the id of the text box.
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] getTextObject [line 211]
`Text getTextObject( )`
Getter for text object Information Tags:
Since: | 1.0
[ Top ] render [line 122]
`string render( [bool $tableTags = true], [bool $markdown = false] )`
Renders the HTML and javascript for the text box Parameters:
bool | $tableTags: | Determines if table tags are also rendered for the TextBox
bool | $markdown: | Set to true when rendering Markdown text content fields
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] setTextObject [line 198]
`void setTextObject( string $text )`
Setter for text object Parameters:
string | $text: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] Documentation generated on Tue, 13 Dec 2011 20:27:41 +0000 by phpDocumentor 1.4.3