Class: PhpExt_Toolbar_PagingToolbar

Source Location: /PhpExt/Toolbar/PagingToolbar.php

Class PhpExt_Toolbar_PagingToolbar

Class Overview

A specialized toolbar that is bound to a Ext.data.Store and provides automatic paging controls.

Located in /PhpExt/Toolbar/PagingToolbar.php [line 25]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_BoxComponent
            |
            --PhpExt_Toolbar_Toolbar
               |
               --PhpExt_Toolbar_PagingToolbar

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Toolbar_Toolbar

PhpExt_Toolbar_Toolbar::$_items

PhpExt_Toolbar_Toolbar::$_mustRender

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_Toolbar_Toolbar

PhpExt_Toolbar_Toolbar::__construct()

PhpExt_Toolbar_Toolbar::addButton()

Helper function to quick add a button

PhpExt_Toolbar_Toolbar::addFill()

Helper function to quick add a fill

PhpExt_Toolbar_Toolbar::addItem()

Helper function to quick add a item

PhpExt_Toolbar_Toolbar::addSeparator()

Helper function to quick add a separator

PhpExt_Toolbar_Toolbar::addSpacer()

Helper function to quick add a spacer

PhpExt_Toolbar_Toolbar::addTextItem()

Helper function to quick add a textitem

PhpExt_Toolbar_Toolbar::getItem()

PhpExt_Toolbar_Toolbar::getItems()

PhpExt_Toolbar_Toolbar::getMustRender()

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

PhpExt_Toolbar_Toolbar::removeItem()

PhpExt_Toolbar_Toolbar::setMustRender()

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

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

Method Summary

PhpExt_Toolbar_PagingToolbar	__construct()
boolean	getDisplayInfo()	True to display the displayMsg (defaults to false)
string	getDisplayMessage()	The paging status message to display (defaults to "Displaying {0} - {1} of {2}"). Note that this string is formatted using the braced numbers 0-2 as tokens that are replaced by the values for start, end and total respectively. These tokens should be preserved when overriding this string if showing those values is desired.
string	getEmptyMessage()	The message to display when no records are found (defaults to "No data to display")
integer	getPageSize()	The number of records to display per page (defaults to 20)
PhpExt_Data_Store	getStore()	The PhpExt_Data_Store the paging toolbar should use as its data source (required).
PhpExt_Toolbar_PagingToolbar	setDisplayInfo()	True to display the displayMsg (defaults to false)
PhpExt_Toolbar_PagingToolbar	setDisplayMessage()	The paging status message to display (defaults to "Displaying {0} - {1} of {2}"). Note that this string is formatted using the braced numbers 0-2 as tokens that are replaced by the values for start, end and total respectively. These tokens should be preserved when overriding this string if showing those values is desired.
PhpExt_Toolbar_PagingToolbar	setEmptyMessage()	The message to display when no records are found (defaults to "No data to display")
PhpExt_Toolbar_PagingToolbar	setPageSize()	The number of records to display per page (defaults to 20)
PhpExt_Toolbar_PagingToolbar	setStore()	The PhpExt_Data_Store the paging toolbar should use as its data source (required).

[ Top ]

Properties

Methods

Constructor __construct [line 119]

PhpExt_Toolbar_PagingToolbar __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Toolbar_Toolbar::__construct()

[ Top ]

getDisplayInfo [line 41]

boolean getDisplayInfo(
)

True to display the displayMsg (defaults to false)

API Tags:

Access:

public

[ Top ]

getDisplayMessage [line 59]

string getDisplayMessage(
)

The paging status message to display (defaults to "Displaying {0} - {1} of {2}"). Note that this string is formatted using the braced numbers 0-2 as tokens that are replaced by the values for start, end and total respectively. These tokens should be preserved when overriding this string if showing those values is desired.

API Tags:

Access:

public

[ Top ]

getEmptyMessage [line 77]

string getEmptyMessage(
)

The message to display when no records are found (defaults to "No data to display")

API Tags:

Access:

public

[ Top ]

getPageSize [line 95]

integer getPageSize(
)

The number of records to display per page (defaults to 20)

API Tags:

Access:

public

[ Top ]

getStore [line 115]

PhpExt_Data_Store getStore(
)

The PhpExt_Data_Store the paging toolbar should use as its data source (required).

API Tags:

Access:	public
Uses:	PhpExt_Data_Store

[ Top ]

setDisplayInfo [line 33]

PhpExt_Toolbar_PagingToolbar setDisplayInfo(
boolean
$value 
)

True to display the displayMsg (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setDisplayMessage [line 51]

PhpExt_Toolbar_PagingToolbar setDisplayMessage(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setEmptyMessage [line 69]

PhpExt_Toolbar_PagingToolbar setEmptyMessage(
string
$value 
)

The message to display when no records are found (defaults to "No data to display")

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setPageSize [line 87]

PhpExt_Toolbar_PagingToolbar setPageSize(
integer
$value 
)

The number of records to display per page (defaults to 20)

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setStore [line 106]

PhpExt_Toolbar_PagingToolbar setStore(
PhpExt_Data_Store
$value 
)

The PhpExt_Data_Store the paging toolbar should use as its data source (required).

Parameters:

PhpExt_Data_Store

$value:

API Tags:

Access:	public
Uses:	PhpExt_Data_Store

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:57:34 -0500 by phpDocumentor 1.4.0