Class P4A_Button

Description

HTML "button".

It's useful to trigger actions in easy way (with/without graphics).

Located in /p4a/objects/widgets/button.php (line 42)

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_Button
Variable Summary
 string $_icon
 boolean $_label_visible
 integer $_size
Method Summary
 P4A_Button __construct (string $name, [string $icon = null])
 string getAsString ()
 string getIcon ()
 integer getSize ()
 P4A_Button setIcon (string $icon)
 P4A_Button setLabel (string $label, [boolean $visible = false])
 P4A_Button setSize (integer $size)
Variables
string $_icon = null (line 48)

The icon used by button, if null standard html button is used.

  • access: protected
boolean $_label_visible = false (line 59)
  • access: protected
integer $_size = 32 (line 54)

Height of the button

  • access: protected

Inherited Variables

Inherited from P4A_Widget

P4A_Widget::$actions
P4A_Widget::$enabled
P4A_Widget::$label
P4A_Widget::$properties
P4A_Widget::$style
P4A_Widget::$template_name
P4A_Widget::$use_template
P4A_Widget::$visible
P4A_Widget::$_css_classes
P4A_Widget::$_temp_vars
P4A_Widget::$_tpl_vars

Inherited from P4A_Object

P4A_Object::$_helpers
P4A_Object::$_id
P4A_Object::$_map_actions
P4A_Object::$_name
P4A_Object::$_objects
P4A_Object::$_parent_id
Methods
Constructor __construct (line 65)
  • access: public
P4A_Button __construct (string $name, [string $icon = null])
  • string $name: Mnemonic identifier for the object
  • string $icon: The icon taken from icon set (file name without extension)

Redefinition of:
P4A_Widget::__construct()
getAsString (line 127)

Retuns the HTML rendered button

  • access: public
string getAsString ()

Redefinition of:
P4A_Widget::getAsString()
Returns the HTML rendered widget.
getIcon (line 85)
  • access: public
string getIcon ()
getSize (line 103)
  • access: public
integer getSize ()
setIcon (line 76)
  • access: public
P4A_Button setIcon (string $icon)
  • string $icon: The icon taken from icon set (file name without extension) or path to an external image
setLabel (line 117)

Sets the label and its visibility When a label is visible it will be rendered next to the icon (if there's an icon), otherwise you'll see the lable as a tooltip.

  • access: public
P4A_Button setLabel (string $label, [boolean $visible = false])
  • string $label
  • boolean $visible

Redefinition of:
P4A_Widget::setLabel()
Sets the label for the widget.
setSize (line 94)
  • access: public
P4A_Button setSize (integer $size)
  • integer $size

Inherited Methods

Inherited From P4A_Widget

 P4A_Widget::__construct()
 P4A_Widget::addAction()
 P4A_Widget::addAjaxAction()
 P4A_Widget::addCSSClass()
 P4A_Widget::addTempVar()
 P4A_Widget::changeEvent()
 P4A_Widget::clearTemplateVars()
 P4A_Widget::clearTempVars()
 P4A_Widget::composeStringActions()
 P4A_Widget::composeStringClass()
 P4A_Widget::composeStringProperties()
 P4A_Widget::composeStringStyle()
 P4A_Widget::disable()
 P4A_Widget::display()
 P4A_Widget::dropAction()
 P4A_Widget::dropTempVar()
 P4A_Widget::enable()
 P4A_Widget::fetchTemplate()
 P4A_Widget::getAccessKey()
 P4A_Widget::getAsString()
 P4A_Widget::getCSSClasses()
 P4A_Widget::getHeight()
 P4A_Widget::getLabel()
 P4A_Widget::getProperty()
 P4A_Widget::getStyleProperty()
 P4A_Widget::getWidth()
 P4A_Widget::isEnabled()
 P4A_Widget::isVisible()
 P4A_Widget::onBlur()
 P4A_Widget::onChange()
 P4A_Widget::onClick()
 P4A_Widget::onDblClick()
 P4A_Widget::onFocus()
 P4A_Widget::onKeyDown()
 P4A_Widget::onKeyPress()
 P4A_Widget::onKeyUp()
 P4A_Widget::onMouseDown()
 P4A_Widget::onMouseMove()
 P4A_Widget::onMouseOver()
 P4A_Widget::onMouseUp()
 P4A_Widget::onReturnPress()
 P4A_Widget::onSelect()
 P4A_Widget::redesign()
 P4A_Widget::removeCSSClass()
 P4A_Widget::requireConfirmation()
 P4A_Widget::setAccessKey()
 P4A_Widget::setBgcolor()
 P4A_Widget::setBgimage()
 P4A_Widget::setDefaultLabel()
 P4A_Widget::setFontColor()
 P4A_Widget::setFontWeight()
 P4A_Widget::setHeight()
 P4A_Widget::setInvisible()
 P4A_Widget::setLabel()
 P4A_Widget::setProperty()
 P4A_Widget::setStyleProperty()
 P4A_Widget::setVisible()
 P4A_Widget::setWidth()
 P4A_Widget::unrequireConfirmation()
 P4A_Widget::unsetProperty()
 P4A_Widget::unsetStyleProperty()
 P4A_Widget::useTemplate()

Inherited From P4A_Object

 P4A_Object::__construct()
 P4A_Object::actionHandler()
 P4A_Object::build()
 P4A_Object::destroy()
 P4A_Object::dropImplement()
 P4A_Object::dropMethod()
 P4A_Object::errorHandler()
 P4A_Object::getId()
 P4A_Object::getName()
 P4A_Object::getObjectType()
 P4A_Object::getParentID()
 P4A_Object::implement()
 P4A_Object::intercept()
 P4A_Object::isActionTriggered()
 P4A_Object::setName()
 P4A_Object::setParentID()
 P4A_Object::void()
 P4A_Object::_loadHelper()
 P4A_Object::__call()

Documentation generated on Tue, 02 Sep 2008 10:03:58 +0200 by phpDocumentor 1.4.2