PhpExt : Toolbar [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Toolbar_Toolbar

Source Location: /PhpExt/Toolbar/Toolbar.php

Class PhpExt_Toolbar_Toolbar

Descendants
Child Class Description
PhpExt_Toolbar_PagingToolbar A specialized toolbar that is bound to a Ext.data.Store and provides automatic paging controls.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From PhpExt_Component

PhpExt_Component::$_layoutData
PhpExt_Component::$_ownerCollection
PhpExt_Component::$_plugins
PhpExt_Component::$_xType

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName
PhpExt_Object::$_extConfigProperties
PhpExt_Object::$_validExtConfigProperties
PhpExt_Object::$_varName

Inherited From PhpExt_BoxComponent

PhpExt_BoxComponent::__construct()
PhpExt_BoxComponent::getAutoHeight()
True to use height:'auto', false to use fixed height (defaults to false).
PhpExt_BoxComponent::getAutoWidth()
True to use width:'auto', false to use fixed width (defaults to false).
PhpExt_BoxComponent::getHeight()
The height of this component in pixels (defaults to auto).
PhpExt_BoxComponent::getWidth()
The width of this component in pixels (defaults to auto).
PhpExt_BoxComponent::setAutoHeight()
True to use height:'auto', false to use fixed height (defaults to false).
PhpExt_BoxComponent::setAutoWidth()
True to use width:'auto', false to use fixed width (defaults to false).
PhpExt_BoxComponent::setHeight()
The height of this component in pixels (defaults to auto).
PhpExt_BoxComponent::setWidth()
The width of this component in pixels (defaults to auto).

Inherited From PhpExt_Component

PhpExt_Component::__construct()
** Overrides ***
PhpExt_Component::getAllowDomMove()
Whether the component can move the Dom node when rendering (defaults to true).
PhpExt_Component::getApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
PhpExt_Component::getAutoShow()
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).
PhpExt_Component::getConfigParams()
PhpExt_Component::getContainerCssClass()
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Component::getCssClass()
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.
PhpExt_Component::getCssStyle()
A custom style specification to be applied to this component's Element.
PhpExt_Component::getDisabledCssClass()
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
PhpExt_Component::getEl()
The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.
PhpExt_Component::getHideMode()
How this component should hidden. Supported values are
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. PhpExt_Component::HIDE_MODE_DISPLAY
.
PhpExt_Component::getHideParent()
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.
PhpExt_Component::getId()
The unique id of this component (defaults to an auto-assigned id).
PhpExt_Component::getLayoutData()
PhpExt_Component::getOwnerCollection()
PhpExt_Component::getPlugins()
An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.
PhpExt_Component::getRenderTo()
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
PhpExt_Component::render()
** Ext Object Methods ***
PhpExt_Component::setAllowDomMove()
Whether the component can move the Dom node when rendering (defaults to true).
PhpExt_Component::setApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
PhpExt_Component::setAutoShow()
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).
PhpExt_Component::setContainerCssClass()
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Component::setCssClass()
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.
PhpExt_Component::setCssStyle()
A custom style specification to be applied to this component's Element.
PhpExt_Component::setDisabledCssClass()
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
PhpExt_Component::setEl()
The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.
PhpExt_Component::setExtClassInfo()
PhpExt_Component::setHideMode()
How this component should hidden. Supported values are
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. PhpExt_Component::HIDE_MODE_DISPLAY
.
PhpExt_Component::setHideParent()
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.
PhpExt_Component::setId()
The unique id of this component (defaults to an auto-assigned id).
PhpExt_Component::setLayoutData()
Layout specific properties for the corresponding layout of the container.
PhpExt_Component::setOwnerCollection()
PhpExt_Component::setRenderTo()
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()
PhpExt_Observable::attachListener()
Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.
PhpExt_Observable::getConfigParams()
PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()
PhpExt_Object::addValidConfigProperties()
PhpExt_Object::createMethodSignature()
PhpExt_Object::getConfigParams()
PhpExt_Object::getExtConfigProperty()
PhpExt_Object::getJavascript()
PhpExt_Object::getMethodInvokeStm()
PhpExt_Object::isExtObject()
PhpExt_Object::paramToString()
PhpExt_Object::setExtClassInfo()
PhpExt_Object::setExtConfigProperty()
PhpExt_Object::__get()
PhpExt_Object::__set()

Inherited From PhpExt_Component

PhpExt_Component::HIDE_MODE_DISPLAY
PhpExt_Component::HIDE_MODE_OFFSETS
PhpExt_Component::HIDE_MODE_VISIBILITY

[ Top ]
Method Summary
PhpExt_Toolbar_Toolbar   __construct()  
PhpExt_Toolbar_Button   addButton()   Helper function to quick add a button
PhpExt_Toolbar_Fill   addFill()   Helper function to quick add a fill
PhpExt_Toolbar_Item   addItem()   Helper function to quick add a item
PhpExt_Toolbar_Toolbar   addSeparator()   Helper function to quick add a separator
PhpExt_Toolbar_Spacer   addSpacer()   Helper function to quick add a spacer
PhpExt_Toolbar_TextItem   addTextItem()   Helper function to quick add a textitem
void   &getItem()  
PhpExt_Toolbar_IToolbarItemCollection   getItems()  
boolean   getMustRender()   True to render the toolbar even if it does not have items.
void   removeItem()  
void   setMustRender()   True to render the toolbar even if it does not have items

[ Top ]
Properties
PhpExt_Toolbar_IToolbarItemCollection   $_items = null [line 36]

Object Collection

API Tags:
Access:  protected


[ Top ]
mixed   $_mustRender = false [line 138]

[ Top ]
Methods
Constructor __construct  [line 49]

  PhpExt_Toolbar_Toolbar __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_BoxComponent::__construct()

Redefined in descendants as:

[ Top ]
addButton  [line 120]

  PhpExt_Toolbar_Button addButton( string $key, string $text, [string $iconUrl = null], [ $handler = null]  )

Helper function to quick add a button

Parameters:
string   $key: 
string   $text:  The text to show in the button
string   $iconUrl:  The URL of and image to show as button's icon
   $handler: 

API Tags:
Access:  public


[ Top ]
addFill  [line 93]

  PhpExt_Toolbar_Fill addFill( string $key  )

Helper function to quick add a fill

Parameters:
string   $key: 

API Tags:
Access:  public


[ Top ]
addItem  [line 133]

  PhpExt_Toolbar_Item addItem( string $key, &$item, string $item  )

Helper function to quick add a item

Parameters:
string   $key: 
string   $item: 
   &$item: 

API Tags:
Access:  public


[ Top ]
addSeparator  [line 69]

  PhpExt_Toolbar_Toolbar addSeparator( string $key  )

Helper function to quick add a separator

Parameters:
string   $key: 

API Tags:
Access:  public


[ Top ]
addSpacer  [line 81]

  PhpExt_Toolbar_Spacer addSpacer( string $key  )

Helper function to quick add a spacer

Parameters:
string   $key: 

API Tags:
Access:  public


[ Top ]
addTextItem  [line 106]

  PhpExt_Toolbar_TextItem addTextItem( string $key, string $text  )

Helper function to quick add a textitem

Parameters:
string   $key: 
string   $text:  The text to show in the item

API Tags:
Access:  public


[ Top ]
getItem  [line 162]

  void &getItem( $key  )

Parameters:
   $key: 

API Tags:
Access:  public


[ Top ]
getItems  [line 43]


API Tags:
Access:  public


[ Top ]
getMustRender  [line 144]

  boolean getMustRender( )

True to render the toolbar even if it does not have items.


API Tags:
Access:  public


[ Top ]
removeItem  [line 158]

  void removeItem( $key  )

Parameters:
   $key: 

API Tags:
Access:  public


[ Top ]
setMustRender  [line 153]

  void setMustRender( boolean $mustRender  )

True to render the toolbar even if it does not have items

Parameters:
boolean   $mustRender: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:01:32 -0500 by phpDocumentor 1.4.0