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

Class: PhpExt_Toolbar_SplitButton

Source Location: /PhpExt/Toolbar/SplitButton.php

Class PhpExt_Toolbar_SplitButton

Class Overview

Implements interfaces:

A menu button that renders into a toolbar.

Located in /PhpExt/Toolbar/SplitButton.php [line 28]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_Button
            |
            --PhpExt_SplitButton
               |
               --PhpExt_Toolbar_SplitButton

Methods

[ 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_SplitButton

PhpExt_SplitButton::__construct()
PhpExt_SplitButton::createSplitButton()
Helper function to create a SplitButton If $iconUrl is set it asigns the corresponding CssClass 'x-btn-text-icon' to show icon and text.
PhpExt_SplitButton::getArrowHandler()
A function called when the arrow button is clicked (can be used instead of click event)
PhpExt_SplitButton::getArrowTooltip()
The title attribute of the arrow
PhpExt_SplitButton::setArrowHandler()
A function called when the arrow button is clicked (can be used instead of click event)
PhpExt_SplitButton::setArrowTooltip()
The title attribute of the arrow

Inherited From PhpExt_Button

PhpExt_Button::__construct()
PhpExt_Button::createTextButton()
Helper function to create a new Text Button with optional handler, name, id and icon.
PhpExt_Button::getClickEvent()
The type of event to map to the button's event handler (defaults to 'click')
PhpExt_Button::getDisabled()
True to start disabled (defaults to false)
PhpExt_Button::getEnableToogle()
True to enable pressed/not pressed toggling (defaults to false)
PhpExt_Button::getHandleMouseEvents()
False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
PhpExt_Button::getHandler()
A function called when the button is clicked (can be used instead of click event)
PhpExt_Button::getHidden()
True to start hidden (defaults to false)
PhpExt_Button::getIcon()
The path to an image to display in the button (the image will be set as the background-image CSS property of the button by default, so if you want a mixed icon/text button, set CssClass:"x-btn-text-icon")
PhpExt_Button::getIconCssClass()
A css class which sets a background image to be used as the icon for this button
PhpExt_Button::getMenu()
Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
PhpExt_Button::getMenuAlign()
The position to align the menu to (see PhpExt_Ext for more details, defaults to 'tl-bl?').
PhpExt_Button::getMinWidth()
The minimum width for this button (used to give a set of buttons a common width)
PhpExt_Button::getName()
Button's DOM element name
PhpExt_Button::getPressed()
True to start pressed (only if enableToggle = true)
PhpExt_Button::getRepeat()
True to repeat fire the click event while the mouse is down. This can also be an Ext.util.ClickRepeater config object (defaults to false).
PhpExt_Button::getScope()
The scope of the handler
PhpExt_Button::getTabIndex()
Set a DOM tabIndex for this button (defaults to undefined)
PhpExt_Button::getText()
The button text
PhpExt_Button::getToogleGroup()
The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)
PhpExt_Button::getTooltip()
The tooltip for the button - can be a string or QuickTips config object
PhpExt_Button::getTooltipType()
The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.
PhpExt_Button::getType()
PhpExt_Button::BUTTON_TYPE_SUBMIT, PhpExt_Button::BUTTON_TYPE_RESET or PhpExt_Button::BUTTON_TYPE_BUTTON - defaults to PhpExt_Button::BUTTON_TYPE_BUTTON
PhpExt_Button::setClickEvent()
The type of event to map to the button's event handler (defaults to 'click')
PhpExt_Button::setDisabled()
True to start disabled (defaults to false)
PhpExt_Button::setEnableToogle()
True to enable pressed/not pressed toggling (defaults to false)
PhpExt_Button::setHandleMouseEvents()
False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
PhpExt_Button::setHandler()
A function called when the button is clicked (can be used instead of click event)
PhpExt_Button::setHidden()
True to start hidden (defaults to false)
PhpExt_Button::setIcon()
The path to an image to display in the button (the image will be set as the background-image CSS property of the button by default, so if you want a mixed icon/text button, set CssClass:"x-btn-text-icon")
PhpExt_Button::setIconCssClass()
A css class which sets a background image to be used as the icon for this button
PhpExt_Button::setMenu()
Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
PhpExt_Button::setMenuAlign()
The position to align the menu to (see PhpExt_Ext.combineAnchors for more details, defaults to 'tl-bl?').
PhpExt_Button::setMinWidth()
The minimum width for this button (used to give a set of buttons a common width)
PhpExt_Button::setName()
Button's DOM element name
PhpExt_Button::setPressed()
True to start pressed (only if enableToggle = true)
PhpExt_Button::setRepeat()
True to repeat fire the click event while the mouse is down. This can also be an Ext.util.ClickRepeater config object (defaults to false).
PhpExt_Button::setScope()
The scope of the handler
PhpExt_Button::setTabIndex()
Set a DOM tabIndex for this button (defaults to undefined)
PhpExt_Button::setText()
The button text
PhpExt_Button::setToogleGroup()
The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)
PhpExt_Button::setTooltip()
The tooltip for the button - can be a string or QuickTips config object
PhpExt_Button::setTooltipType()
The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.
PhpExt_Button::setType()
PhpExt_Button::BUTTON_TYPE_SUBMIT, PhpExt_Button::BUTTON_TYPE_RESET or PhpExt_Button::BUTTON_TYPE_BUTTON - defaults to PhpExt_Button::BUTTON_TYPE_BUTTON

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_Button

PhpExt_Button::BUTTON_TYPE_BUTTON
PhpExt_Button::BUTTON_TYPE_RESET
PhpExt_Button::BUTTON_TYPE_SUBMIT

Inherited From PhpExt_Component

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

[ Top ]
Method Summary
static PhpExt_Toolbar_Button   createSplitButton()   Helper function to create a Toolbar SplitButton If $iconUrl is set it asigns the corresponding CssClass 'x-btn-text-icon' to show icon and text.
PhpExt_Toolbar_SplitButton   __construct()  

[ Top ]
Methods
static method createSplitButton  [line 46]

  static PhpExt_Toolbar_Button createSplitButton( string $text, [string $iconUrl = null], [ $arrowHandler = null], PhpExt_Handler $handler  )

Helper function to create a Toolbar SplitButton If $iconUrl is set it asigns the corresponding CssClass 'x-btn-text-icon' to show icon and text.

Parameters:
string   $text: 
string   $iconUrl: 
PhpExt_Handler   $handler: 
   $arrowHandler: 

API Tags:
Access:  public


Redefinition of:
PhpExt_SplitButton::createSplitButton()
Helper function to create a SplitButton If $iconUrl is set it asigns the corresponding CssClass 'x-btn-text-icon' to show icon and text.

[ Top ]
Constructor __construct  [line 31]

  PhpExt_Toolbar_SplitButton __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_SplitButton::__construct()

[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:00:18 -0500 by phpDocumentor 1.4.0