Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Button
  • DateBox
  • Image
  • RecordSelector
  • SmallTextBox
  • TagCloud
  • TextBox

Class SmallTextBox

String HTML input box custom widget.

Namespace: Alpha\View\Widget
Copyright:

Copyright (c) 2018, 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
Since: 1.0
Located at View/Widget/SmallTextBox.php

Methods summary

public
# __construct( Alpha\Model\Type\SmallText $string, string $label, string $name, integer $size = 0 )

The constructor.

The constructor.

Parameters

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

Throws

Alpha\Exception\IllegalArguementException

Since

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

Renders the HTML and javascript for the string box.

Renders the HTML and javascript for the string box.

Parameters

$readOnly
set to true to make the text box readonly (defaults to false)

Returns

string

Since

1.0
public
# setStringObject( Alpha\Model\Type\SmallText $string )

Setter for string object.

Setter for string object.

Parameters

$string

Throws

Alpha\Exception\IllegalArguementException

Since

1.0
public Alpha\Model\Type\SmallText
# getStringObject( )

Getter for string object.

Getter for string object.

Returns

Alpha\Model\Type\SmallText

Since

1.0

Properties summary

public Alpha\Model\Type\SmallText $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 3.0.0 API Documentation API documentation generated by ApiGen