## P4A_Toolbar

Description

A toolbar is a buttons/images set.

Every button/image can have an action handler.

- author: Fabrizio Balliano <fabrizio.balliano@crealabs.it>
- author: Andrea Giardina <andrea.giardina@crealabs.it>

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

    P4A_Object
       |
       --P4A_Widget
          |
          --P4A_Toolbar

Direct descendents

Class | Description
--- | ---
P4A_Actions_Toolbar | Standard toolbar for data source operations.
P4A_Navigation_Toolbar | Navigation toolbar for data source operations.
P4A_Quit_Toolbar | Very simple toolbar.
P4A_Simple_Toolbar | Simple toolbar.
P4A_Standard_Toolbar | Standard toolbar for data source operations.

Variable Summary
array $buttons
integer $separators_counter
mixed $_size
Method Summary
P4A_Toolbar P4A_Toolbar (string $name, mask 1)
void &addButton (string $button_name, [string $icon = NULL], [mixed $position = "left"])
void addLabel (mixed $name, mixed $text, [mixed $position = "left"])
void addSeparator ([mixed $position = "left"])
void addSpacer ([integer $width = 10], [mixed $position = "left"])
void disable ([string $button_name = NULL])
void enable ([string $button_name = NULL])
string getAsString ()
void getSize ()
void setOrientation (string $orientation)
void setSize (mixed $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

Inherited from P4A_Object

> 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.

- see: P4A_Button
- access: public

void &addButton (string $button_name, [string $icon = NULL], [mixed $position = "left"])

- string $button_name: Mnemonic identifier for the object.
- string $icon: The icon taken from icon set (file name without extension).

addLabel (line 112)

Adds a label object.

- access: public

void addLabel (mixed $name, mixed $text, [mixed $position = "left"])
addSeparator (line 99)

Adds a separator image.

- access: public

void addSeparator ([mixed $position = "left"])
addSpacer (line 124)

Adds a spacer image of the desidered width.

- access: public

void addSpacer ([integer $width = 10], [mixed $position = "left"])

- integer $width: Width in pixel from the spacer.

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

Returns the HTML rendered widget.

- access: public

string getAsString ()

Redefinition of:

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

Redefined in descendants as:

- P4A_Standard_Toolbar::getAsString()

getSize (line 175)
void getSize ()
setOrientation (line 185)

Sets the rendering orientation for the toolbar.

- access: public

void setOrientation (string $orientation)

- string $orientation: Orientation (horizontal|vertical).

setSize (line 170)
void setSize (mixed $size)

#### Inherited Methods

Inherited From P4A_Widget

> P4A_Widget::addAction()
> 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::onChange()
> P4A_Widget::onClick()
> P4A_Widget::onKeyPress()
> P4A_Widget::onMouseOver()
> P4A_Widget::onReturnPress()
> P4A_Widget::p4a_widget()
> P4A_Widget::raise()
> 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::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()

Documentation generated on Fri, 26 May 2006 12:43:43 +0200 by phpDocumentor 1.3.0RC5