Alpha Framework 3.1.0 API Documentation

Button

Button HTML custom widget.

Tags
since
1.0
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2019, 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.

Table of Contents

$action  : string
The Javascript action to carry out when the button is pressed.
$glyphIcon  : string
If provided, the Bootsrap glyphIcon to use for this button.
$id  : string
The HTML id attribute for the button.
$imgURL  : string
If provided, the button will be a clickable image using this image.
$title  : string
The title to display on the button.
$tooltip  : string
If provided, the Bootsrap tooltip to use for this button.
$tooltipPosition  : string
If provided, the Bootsrap tooltip position (left|right|top|bottom) to use for this button.
__construct()  : mixed
The constructor.
render()  : string
Renders the HTML and javascript for the button.

Properties

$action

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

private string $action
Tags
since
1.0

$glyphIcon

If provided, the Bootsrap glyphIcon to use for this button.

private string $glyphIcon
Tags
since
3.0

$id

The HTML id attribute for the button.

private string $id
Tags
since
1.0

$imgURL

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

private string $imgURL
Tags
since
1.0

$title

The title to display on the button.

private string $title
Tags
since
1.0

$tooltip

If provided, the Bootsrap tooltip to use for this button.

private string $tooltip
Tags
since
3.0

$tooltipPosition

If provided, the Bootsrap tooltip position (left|right|top|bottom) to use for this button.

private string $tooltipPosition
Tags
since
3.0

Methods

__construct()

The constructor.

public __construct(string $action, string $title, string $id[, string $imgURL = '' ][, string $glyphIcon = '' ][, string $tooltip = '' ][, string $tooltipPosition = '' ]) : mixed
Parameters
$action : string

The javascript action to be carried out (or set to "submit" to make a submit button, "file" for file uploads).

$title : string

The title to appear on the button.

$id : string

The HTML id attribute for the button.

$imgURL : string = ''

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

$glyphIcon : string = ''

If provided, the Bootsrap glyphIcon to use for this button.

$tooltip : string = ''

If provided, the Bootsrap tooltip to use for this button.

$tooltipPosition : string = ''

If provided, the Bootsrap tooltip position (left|right|top|bottom) to use for this button.

Tags
since
1.0
Return values
mixed —

render()

Renders the HTML and javascript for the button.

public render(int $width[, string $cssClasses = '' ]) : string
Parameters
$width : int

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

$cssClasses : string = ''

List of CSS classes to apply to the button (optional)

Tags
since
1.0
Return values
string —

Search results