Alpha Framework alpha--view--widgets
[ class tree: alpha--view--widgets ] [ index: alpha--view--widgets ] [ all elements ]

Class: StringBox

Source Location: /view/widgets/StringBox.inc

Class StringBox

Class Overview

String HTML input box custom widget

Located in /view/widgets/StringBox.inc [line 49]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: StringBox.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

Methods

[ Top ]
Property Summary
string   $label   The data label for the string object
string   $name   The name of the HTML input box
integer   $size   The display size of the input box
String   $stringObject   The string object that will be edited by this string box

[ Top ]
Method Summary
StringBox   __construct()   The constructor
String   getStringObject()   Qetter for string object
string   render()   Renders the HTML and javascript for the string box
void   setStringObject()   Setter for string object

[ Top ]
Properties
string   $label [line 64]

The data label for the string object

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
string   $name [line 72]

The name of the HTML input box

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
integer   $size [line 81]

The display size of the input box

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
String   $stringObject [line 56]

The string object that will be edited by this string box

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
Methods
Constructor __construct  [line 93]

  StringBox __construct( String $string, string $label, string $name, [integer $size = 0]  )

The constructor

Parameters:
String   $string:  The string object that will be edited by this text box.
string   $label:  The data label for the string object.
string   $name:  The name of the HTML input box.
integer   $size:  The display size (characters).

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
getStringObject  [line 155]

  String getStringObject( )

Qetter for string object


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
render  [line 112]

  string render( [bool $tableTags = true], [bool $readOnly = false]  )

Renders the HTML and javascript for the string box

Parameters:
bool   $tableTags:  determines if table tags are also rendered for the StringBox
bool   $readOnly:  set to true to make the text box readonly (defaults to false)

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setStringObject  [line 142]

  void setStringObject( String $string  )

Setter for string object

Parameters:
String   $string: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:27:33 +0000 by phpDocumentor 1.4.3