Class P4A_Toolbar

Description

A toolbar is a buttons/images set.

Every button/image can have an action handler.

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

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_Toolbar
Direct descendents
Class Description
 class P4A_Quit_Toolbar Very simple toolbar.
 class P4A_Navigation_Toolbar Navigation toolbar for data source operations.
 class P4A_Simple_Toolbar Simple toolbar.
 class P4A_Full_Toolbar Standard toolbar for data source operations.
 class P4A_Actions_Toolbar Standard toolbar for data source operations.
Variable Summary
 array $buttons
 integer $_size
Method Summary
 P4A_Toolbar __construct (string $name)
 P4A_Box addBox (string $name, string $text, [string $position = "left"])
 void addButton (string $button_name, [string $icon = null], [string $position = "left"])
 P4A_Image addSeparator ([string $position = "left"])
 P4A_Image addSpacer ([integer $width = 10], [string $position = "left"])
 P4A_Toolbar enable ([boolean $enabled = true])
 string getAsString ()
 integer getSize ()
 P4A_Toolbar setSize (integer $size)
Variables
array $buttons = null (line 59)

Buttons collection

  • access: public
integer $separators_counter = 0 (line 48)

Counts the number of separators/spacers in the toolbar

  • access: protected
integer $_size = 32 (line 53)
  • 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 64)
  • access: public
P4A_Toolbar __construct (string $name)
  • string $name: Mnemonic identifier for the object

Redefinition of:
P4A_Widget::__construct()

Redefined in descendants as:
addBox (line 109)

Adds a P4A_Box object

P4A_Box addBox (string $name, string $text, [string $position = "left"])
  • string $name
  • string $text
  • string $position: (left|right)
addButton (line 77)

Istances a new p4a_button object and than adds it to the toolbar

void addButton (string $button_name, [string $icon = null], [string $position = "left"])
  • string $button_name: Mnemonic identifier for the object
  • string $icon: The icon taken from icon set (file name without extension)
  • string $position: (left|right)
addSeparator (line 93)

Adds a separator image

  • access: public
P4A_Image addSeparator ([string $position = "left"])
  • string $position: (left|right)
addSpacer (line 123)

Adds a spacer image of the desidered width

  • access: public
P4A_Image addSpacer ([integer $width = 10], [string $position = "left"])
  • integer $width
  • string $position: (left|right)
disable (line 138)

Disables all buttons

  • access: public
P4A_Toolbar disable ()

Redefinition of:
P4A_Widget::disable()
enable (line 151)

Enable/disable all buttons

  • access: public
P4A_Toolbar enable ([boolean $enabled = true])
  • boolean $enabled

Redefinition of:
P4A_Widget::enable()
getAsString (line 191)

Returns the HTML rendered widget

  • access: public
string getAsString ()

Redefinition of:
P4A_Widget::getAsString()
Returns the HTML rendered widget.
getSize (line 182)
  • access: public
integer getSize ()
setSize (line 163)
  • access: public
P4A_Toolbar 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:04:07 +0200 by phpDocumentor 1.4.2