Overview

Packages

  • alpha::controller
  • alpha::controller::front
  • alpha::exceptions
  • alpha::model
  • alpha::model::types
  • alpha::tasks
  • alpha::tests
  • alpha::util
  • alpha::util::cache
  • alpha::util::codehighlight
  • alpha::util::convertors
  • alpha::util::feeds
  • alpha::util::filters
  • alpha::util::graphs
  • alpha::util::helpers
  • alpha::util::metrics
  • alpha::view
  • alpha::view::renderers
  • alpha::view::widgets

Classes

  • Button
  • DateBox
  • Image
  • RecordSelector
  • StringBox
  • TagCloud
  • TextBox
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class StringBox

String 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: StringBox.inc 1497 2012-02-14 20:28:45Z alphadev $
Since: 1.0
Located at view/widgets/StringBox.inc
Methods summary
public
# __construct( String $string, string $label, string $name, integer $size = 0 )

The constructor

The constructor

Parameters

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

Throws

IllegalArguementException

Since

1.0
public string
# render( boolean $tableTags = true, boolean $readOnly = false )

Renders the HTML and javascript for the string box

Renders the HTML and javascript for the string box

Parameters

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

Returns

string

Since

1.0
public
# setStringObject( String $string )

Setter for string object

Setter for string object

Parameters

$string
String
$string

Throws

IllegalArguementException

Since

1.0
public String
# getStringObject( )

Qetter for string object

Qetter for string object

Returns

String

Since

1.0
Properties summary
public String $stringObject
#

The string object that will be edited by this string box

The string object that will be edited by this string box

Since

1.0
public string $label
#

The data label for the string object

The data label for the string 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 $size
#

The display size of the input box

The display size of the input box

Since

1.0
Alpha Framework API Documentation API documentation generated by ApiGen 2.8.0