| alpha--view--widgets

# Class: Button Source Location: /view/widgets/Button.inc ## Class Button Class Overview
Button HTML custom widget Located in /view/widgets/Button.inc [line 47]
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: Button.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
| Methods __construct render renderJavascript
[ Top ] Method Summary
static string | renderJavascript() | Returns the Javascript for injecting into <head> to control the behaviour of the buttons.
Button | __construct() | The constructor
string | render() | Renders the HTML and javascript for the button.
[ Top ] Methods static method renderJavascript [line 153]
`static string renderJavascript( )`
Returns the Javascript for injecting into <head> to control the behaviour of the buttons. API Tags:
Deprecated: | Now using JQuery UI Button widget, so this custom JavaScript is no longer required
Access: | public
Information Tags:
Since: | 1.0
[ Top ] Constructor __construct [line 89]
`Button __construct( string $action, string $title, string $id, [string $imgURL = ''] )`
The constructor Parameters:
string | $action: | The javascript action to be carried out (or set to "submit" to make a submit button, "file" for file uploads).
string | $title: | The title to appear on the button.
string | $id: | The HTML id attribute for the button.
string | $imgURL: | If provided, the button will be a clickable image using this image.
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] render [line 104]
`string render( [integer $width = 0] )`
Renders the HTML and javascript for the button. Parameters:
integer | $width: | The width in pixels of the button (will also accept percentage values), defaults to 0 meaning auto-width to fit text.
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] Documentation generated on Tue, 13 Dec 2011 20:26:33 +0000 by phpDocumentor 1.4.3