Class: PhpExt_Button

Source Location: /PhpExt/Button.php

Class PhpExt_Button

Class Overview

Simple Button class

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_Button

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_SplitButton	Simple Button class
PhpExt_Toolbar_Button	A button that renders into a toolbar.

[ 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_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
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
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
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
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 ]

Constant Summary

BUTTON_TYPE_BUTTON
BUTTON_TYPE_RESET
BUTTON_TYPE_SUBMIT

[ Top ]

Method Summary

static PhpExt_Button	createTextButton()	Helper function to create a new Text Button with optional handler, name, id and icon.
PhpExt_Button	__construct()
string	getClickEvent()	The type of event to map to the button's event handler (defaults to 'click')
boolean	getDisabled()	True to start disabled (defaults to false)
boolean	getEnableToogle()	True to enable pressed/not pressed toggling (defaults to false)
boolean	getHandleMouseEvents()	False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)
PhpExt_Handler\|PhpExt_JavascriptStm	getHandler()	A function called when the button is clicked (can be used instead of click event)
boolean	getHidden()	True to start hidden (defaults to false)
string	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")
string	getIconCssClass()	A css class which sets a background image to be used as the icon for this button
PhpExt_Menu_Menu	getMenu()	Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).
string	getMenuAlign()	The position to align the menu to (see PhpExt_Ext for more details, defaults to 'tl-bl?').
integer	getMinWidth()	The minimum width for this button (used to give a set of buttons a common width)
string	getName()	Button's DOM element name
boolean	getPressed()	True to start pressed (only if enableToggle = true)
boolean	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_JavascriptStm	getScope()	The scope of the handler
integer	getTabIndex()	Set a DOM tabIndex for this button (defaults to undefined)
string	getText()	The button text
string	getToogleGroup()	The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)
string	getTooltip()	The tooltip for the button - can be a string or QuickTips config object
string	getTooltipType()	The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.
string	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

[ Top ]

Properties

Methods

static method createTextButton [line 451]

static PhpExt_Button createTextButton(
string
$text, [PhpExt_Handler
$handler = null], [string
$name = null], [string
$id = null], [string
$icon = null] 
)

Helper function to create a new Text Button with optional handler, name, id and icon.

If $iconUrl is set it asigns the corresponding CssClass 'x-btn-text-icon' to show icon and text.

Parameters:

string	$text:
PhpExt_Handler	$handler:
string	$name:
string	$id:
string	$icon:

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 409]

PhpExt_Button __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Component::__construct(): ** Overrides ***

Redefined in descendants as:

[ Top ]

getClickEvent [line 43]

string getClickEvent(
)

The type of event to map to the button's event handler (defaults to 'click')

API Tags:

Access:

public

[ Top ]

getDisabled [line 61]

boolean getDisabled(
)

True to start disabled (defaults to false)

API Tags:

Access:

public

[ Top ]

getEnableToogle [line 79]

boolean getEnableToogle(
)

True to enable pressed/not pressed toggling (defaults to false)

API Tags:

Access:

public

[ Top ]

getHandleMouseEvents [line 97]

boolean getHandleMouseEvents(
)

False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)

API Tags:

Access:

public

[ Top ]

getHandler [line 115]

PhpExt_Handler|PhpExt_JavascriptStm getHandler(
)

A function called when the button is clicked (can be used instead of click event)

API Tags:

Access:

public

[ Top ]

getHidden [line 133]

boolean getHidden(
)

True to start hidden (defaults to false)

API Tags:

Access:

public

[ Top ]

getIcon [line 151]

string 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")

API Tags:

Access:

public

[ Top ]

getIconCssClass [line 169]

string getIconCssClass(
)

A css class which sets a background image to be used as the icon for this button

API Tags:

Access:

public

[ Top ]

getMenu [line 187]

PhpExt_Menu_Menu getMenu(
)

Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).

API Tags:

Access:

public

[ Top ]

getMenuAlign [line 206]

string getMenuAlign(
)

The position to align the menu to (see PhpExt_Ext for more details, defaults to 'tl-bl?').

API Tags:

Access:

public

[ Top ]

getMinWidth [line 224]

integer getMinWidth(
)

The minimum width for this button (used to give a set of buttons a common width)

API Tags:

Access:

public

[ Top ]

getName [line 242]

string getName(
)

Button's DOM element name

API Tags:

Access:

public

[ Top ]

getPressed [line 260]

boolean getPressed(
)

True to start pressed (only if enableToggle = true)

API Tags:

Access:

public

[ Top ]

getRepeat [line 278]

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

API Tags:

Access:

public

[ Top ]

getScope [line 296]

PhpExt_JavascriptStm getScope(
)

The scope of the handler

API Tags:

Access:

public

[ Top ]

getTabIndex [line 314]

integer getTabIndex(
)

Set a DOM tabIndex for this button (defaults to undefined)

API Tags:

Access:

public

[ Top ]

getText [line 332]

string getText(
)

The button text

API Tags:

Access:

public

[ Top ]

getToogleGroup [line 350]

string getToogleGroup(
)

The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)

API Tags:

Access:

public

[ Top ]

getTooltip [line 368]

string getTooltip(
)

The tooltip for the button - can be a string or QuickTips config object

API Tags:

Access:

public

[ Top ]

getTooltipType [line 386]

string getTooltipType(
)

The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.

API Tags:

Access:

public

[ Top ]

getType [line 404]

string getType(
)

PhpExt_Button::BUTTON_TYPE_SUBMIT, PhpExt_Button::BUTTON_TYPE_RESET or PhpExt_Button::BUTTON_TYPE_BUTTON - defaults to PhpExt_Button::BUTTON_TYPE_BUTTON

API Tags:

Access:

public

[ Top ]

setClickEvent [line 35]

PhpExt_Button setClickEvent(
string
$value 
)

The type of event to map to the button's event handler (defaults to 'click')

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setDisabled [line 53]

PhpExt_Button setDisabled(
boolean
$value 
)

True to start disabled (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableToogle [line 71]

PhpExt_Button setEnableToogle(
boolean
$value 
)

True to enable pressed/not pressed toggling (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHandleMouseEvents [line 89]

PhpExt_Button setHandleMouseEvents(
boolean
$value 
)

False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHandler [line 107]

PhpExt_Button setHandler(
PhpExt_Handler|PhpExt_JavascriptStm
$value 
)

A function called when the button is clicked (can be used instead of click event)

Parameters:

PhpExt_Handler|PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setHidden [line 125]

PhpExt_Button setHidden(
boolean
$value 
)

True to start hidden (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setIcon [line 143]

PhpExt_Button setIcon(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setIconCssClass [line 161]

PhpExt_Button setIconCssClass(
string
$value 
)

A css class which sets a background image to be used as the icon for this button

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMenu [line 179]

PhpExt_Button setMenu(
PhpExt_Menu_Menu
$value 
)

Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).

Parameters:

PhpExt_Menu_Menu

$value:

API Tags:

Access:

public

[ Top ]

setMenuAlign [line 198]

PhpExt_Button setMenuAlign(
string
$value 
)

The position to align the menu to (see PhpExt_Ext.combineAnchors for more details, defaults to 'tl-bl?').

Parameters:

string

$value:

API Tags:

See:	PhpExt_Ext::combineAnchors
Access:	public

[ Top ]

setMinWidth [line 216]

PhpExt_Button setMinWidth(
integer
$value 
)

The minimum width for this button (used to give a set of buttons a common width)

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setName [line 234]

PhpExt_Button setName(
string
$value 
)

Button's DOM element name

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setPressed [line 252]

PhpExt_Button setPressed(
boolean
$value 
)

True to start pressed (only if enableToggle = true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setRepeat [line 270]

PhpExt_Button setRepeat(
boolean
$value 
)

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

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setScope [line 288]

PhpExt_Button setScope(

$value 
)

The scope of the handler

Parameters:

PhpExt_JavascriptStm

$value:

API Tags:

Access:

public

[ Top ]

setTabIndex [line 306]

PhpExt_Button setTabIndex(
integer
$value 
)

Set a DOM tabIndex for this button (defaults to undefined)

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setText [line 324]

PhpExt_Button setText(
string
$value 
)

The button text

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setToogleGroup [line 342]

PhpExt_Button setToogleGroup(
string
$value 
)

The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTooltip [line 360]

PhpExt_Button setTooltip(
string
$value 
)

The tooltip for the button - can be a string or QuickTips config object

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTooltipType [line 378]

PhpExt_Button setTooltipType(
string
$value 
)

The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setType [line 396]

PhpExt_Button setType(
string
$value 
)

PhpExt_Button::BUTTON_TYPE_SUBMIT, PhpExt_Button::BUTTON_TYPE_RESET or PhpExt_Button::BUTTON_TYPE_BUTTON - defaults to PhpExt_Button::BUTTON_TYPE_BUTTON

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

Constants

BUTTON_TYPE_BUTTON = 'button' [line 25]

[ Top ]

BUTTON_TYPE_RESET = 'reset' [line 27]

[ Top ]

BUTTON_TYPE_SUBMIT = 'submit' [line 26]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:50:36 -0500 by phpDocumentor 1.4.0