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 45)

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_Toolbar
Direct descendents
Class Description
 class P4A_Simple_Toolbar Simple toolbar.
 class P4A_Navigation_Toolbar Navigation toolbar for data source operations.
 class P4A_Actions_Toolbar Standard toolbar for data source operations.
 class P4A_Standard_Toolbar Standard toolbar for data source operations.
 class P4A_Quit_Toolbar Very simple toolbar.
Variable Summary
 array $buttons
 mixed $_size
Method Summary
 P4A_Toolbar P4A_Toolbar (string $name, mask 1)
 void &addButton (string $button_name, [string $icon = NULL], [ $position = "left"])
 void addLabel ( $name,  $text, [ $position = "left"])
 void addSeparator ([ $position = "left"])
 void addSpacer ([integer $width = 10], [ $position = "left"])
 void disable ([string $button_name = NULL])
 void enable ([string $button_name = NULL])
 string getAsString ()
 void getSize ()
 void setOrientation (string $orientation)
 void setSize ( $size)
Variables
array $buttons = NULL (line 59)

Buttons collection.

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

Counts the number of separators/spacers in the toolbar.

  • access: private
mixed $_size = NULL (line 61)

Inherited Variables

Inherited from P4A_Widget

P4A_Widget::$actions
P4A_Widget::$enabled
P4A_Widget::$label
P4A_Widget::$map_actions
P4A_Widget::$properties
P4A_Widget::$style
P4A_Widget::$template_name
P4A_Widget::$use_template
P4A_Widget::$value
P4A_Widget::$visible
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 P4A_Toolbar (line 69)

Class costructor.

  • access: private
P4A_Toolbar P4A_Toolbar (string $name, mask 1)
  • mask 1: The mask on wich the toolbar will operate.
  • string $name: Mnemonic identifier for the object.
addButton (line 84)

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

void &addButton (string $button_name, [string $icon = NULL], [ $position = "left"])
  • string $button_name: Mnemonic identifier for the object.
  • string $icon: The icon taken from icon set (file name without extension).
  • $position
addLabel (line 112)

Adds a label object.

  • access: public
void addLabel ( $name,  $text, [ $position = "left"])
  • $name
  • $text
  • $position
addSeparator (line 99)

Adds a separator image.

  • access: public
void addSeparator ([ $position = "left"])
  • $position
addSpacer (line 124)

Adds a spacer image of the desidered width.

  • access: public
void addSpacer ([integer $width = 10], [ $position = "left"])
  • integer $width: Width in pixel from the spacer.
  • $position
disable (line 139)

Turns off the action handler for the desidered button.

  • access: public
void disable ([string $button_name = NULL])
  • string $button_name: Button identifier.

Redefinition of:
P4A_Widget::disable()
Sets the widget disabled.
enable (line 157)

Turns on the action handler for the desidered button.

  • access: public
void enable ([string $button_name = NULL])
  • string $button_name: Button identifier.

Redefinition of:
P4A_Widget::enable()
Sets the widget enabled.
getAsString (line 199)

Returns the HTML rendered widget.

  • access: public
string getAsString ()

Redefinition of:
P4A_Widget::getAsString()
Returns the HTML rendered widget.

Redefined in descendants as:
getSize (line 179)
void getSize ()
setOrientation (line 189)

Sets the rendering orientation for the toolbar.

  • access: public
void setOrientation (string $orientation)
  • string $orientation: Orientation (horizontal|vertical).
setSize (line 170)
void setSize ( $size)
  • $size

Inherited Methods

Inherited From P4A_Widget

 P4A_Widget::addAction()
 P4A_Widget::addAjaxAction()
 P4A_Widget::addTempVar()
 P4A_Widget::changeEvent()
 P4A_Widget::clearTemplateVars()
 P4A_Widget::clearTempVars()
 P4A_Widget::composeStringActions()
 P4A_Widget::composeStringClassStyle()
 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::getHeight()
 P4A_Widget::getLabel()
 P4A_Widget::getProperty()
 P4A_Widget::getStyleProperty()
 P4A_Widget::getValue()
 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::p4a_widget()
 P4A_Widget::raise()
 P4A_Widget::redesign()
 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::setValue()
 P4A_Widget::setVisible()
 P4A_Widget::setWidth()
 P4A_Widget::unrequireConfirmation()
 P4A_Widget::unsetProperty()
 P4A_Widget::unsetStyleProperty()
 P4A_Widget::useTemplate()

Inherited From P4A_Object

 P4A_Object::actionHandler()
 P4A_Object::build()
 P4A_Object::destroy()
 P4A_Object::dropIntercept()
 P4A_Object::errorHandler()
 P4A_Object::getId()
 P4A_Object::getName()
 P4A_Object::getObjectType()
 P4A_Object::getParentID()
 P4A_Object::implementMethod()
 P4A_Object::intercept()
 P4A_Object::isActionTriggered()
 P4A_Object::p4a_object()
 P4A_Object::setName()
 P4A_Object::setParentID()
 P4A_Object::void()
 P4A_Object::_loadHelper()
 P4A_Object::__call()

Documentation generated on Mon, 07 Jan 2008 11:29:37 +0100 by phpDocumentor 1.4.0