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::util::search
  • alpha::view
  • alpha::view::renderers
  • alpha::view::widgets

Classes

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

Class Button

Button HTML custom widget

Package: alpha::view::widgets
Copyright: Copyright (c) 2014, 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: Button.inc 1745 2014-03-29 15:19:05Z alphadevx $
Since: 1.0
Located at view/widgets/Button.inc
Methods summary
public
# __construct( string $action, string $title, string $id, string $imgURL = '', string $glyphIcon = '' )

The constructor

The constructor

Parameters

$action
string
$action The javascript action to be carried out (or set to "submit" to make a submit button, "file" for file uploads).
$title
string
$title The title to appear on the button.
$id
string
$id The HTML id attribute for the button.
$imgURL
string
$imgURL If provided, the button will be a clickable image using this image.
$glyphIcon
string
$glyphIcon If provided, the Bootsrap glyphIcon to use for this button.

Since

1.0
public string
# render( integer $width = 0 )

Renders the HTML and javascript for the button.

Renders the HTML and javascript for the button.

Parameters

$width
integer
$width The width in pixels of the button (will also accept percentage values), defaults to 0 meaning auto-width to fit text.

Returns

string

Since

1.0
Properties summary
private string $action
#

The Javascript action to carry out when the button is pressed.

The Javascript action to carry out when the button is pressed.

Since

1.0
private string $title
#

The title to display on the button.

The title to display on the button.

Since

1.0
private string $id
#

The HTML id attribute for the button.

The HTML id attribute for the button.

Since

1.0
private string $imgURL
#

If provided, the button will be a clickable image using this image.

If provided, the button will be a clickable image using this image.

Since

1.0
Alpha Framework 1.2.4 API Documentation API documentation generated by ApiGen 2.8.0