Class Ext.PagingToolbar

Package:	Ext
Class:	PagingToolbar
Extends:	Toolbar
Defined In:	PagingToolbar.js

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

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	afterPageText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "of %0")	PagingToolbar
	beforePageText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "Page")	PagingToolbar
	firstText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "First Page")	PagingToolbar
	lastText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "Last Page")	PagingToolbar
	nextText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "Next Page")	PagingToolbar
	prevText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "Previous Page")	PagingToolbar
	refreshText : String	PagingToolbar
	Customizable piece of the default paging text (defaults to "Refresh")	PagingToolbar

Public Methods

Method		Defined By
	PagingToolbar( `String/HTMLElement/Element container`, `Ext.data.Store store`, `Object config` )	PagingToolbar
	Create a new PagingToolbar	PagingToolbar
	add( `Mixed arg1`, `Mixed arg2`, `Mixed etc.` ) : void	Toolbar
	Adds element(s) to the toolbar -- this function takes a variable number of arguments of mixed type and adds them to ...	Toolbar
	addButton( `Object/Array config` ) : Ext.Toolbar.Button/Array	Toolbar
	Adds a button (or buttons). See Ext.Toolbar.Button for more info on the config.	Toolbar
	addDom( `Object config` ) : Ext.Toolbar.Item	Toolbar
	Adds a new element to the toolbar from the passed Ext.DomHelper config.	Toolbar
	addElement( `String/HTMLElement/Element el` ) : Ext.Toolbar.Item	Toolbar
	Adds any standard HTML element to the toolbar	Toolbar
	addField( `Ext.form.Field field` ) : Ext.ToolbarItem	Toolbar
	Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have been rendered ...	Toolbar
	addFill() : Ext.Toolbar.Fill	Toolbar
	Adds a fill element that forces subsequent additions to the right side of the toolbar	Toolbar
	addItem( `Ext.Toolbar.Item item` ) : Ext.Toolbar.Item	Toolbar
	Adds any Toolbar.Item or subclass	Toolbar
	addSeparator() : Ext.Toolbar.Item	Toolbar
	Adds a separator	Toolbar
	addSpacer() : Ext.Toolbar.Spacer	Toolbar
	Adds a spacer element	Toolbar
	addText( `String text` ) : Ext.Toolbar.Item	Toolbar
	Adds text to the toolbar	Toolbar
	bind( `Ext.data.Store store` ) : void	PagingToolbar
	Binds the paging toolbar to the specified Ext.data.Store	PagingToolbar
	getEl() : Ext.Element	Toolbar
	Returns the Element for this toolbar.	Toolbar
	insertButton( `Number index`, `Object/Ext.Toolbar.Item/Ext.Toolbar.Button (may` ) : Ext.Toolbar.Button/Item	Toolbar
	Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index.	Toolbar
	unbind( `Ext.data.Store store` ) : void	PagingToolbar
	Unbinds the paging toolbar from the specified Ext.data.Store	PagingToolbar

Public Events

This class has no public events.

Config Options

Config Options		Defined By
	displayInfo : Boolean	PagingToolbar
	True to display the displayMsg (defaults to false)	PagingToolbar
	displayMsg : String	PagingToolbar
	The paging status message to display (defaults to "Displaying {start} - {end} of {total}")	PagingToolbar
	emptyMsg : String	PagingToolbar
	The message to display when no records are found (defaults to "No data to display")	PagingToolbar
	pageSize : Number	PagingToolbar
	The number of records to display per page (defaults to 20)	PagingToolbar

Property Details

afterPageText

public String afterPageText

Customizable piece of the default paging text (defaults to "of %0")

This property is defined by PagingToolbar.

beforePageText

public String beforePageText

Customizable piece of the default paging text (defaults to "Page")

This property is defined by PagingToolbar.

firstText

public String firstText

Customizable piece of the default paging text (defaults to "First Page")

This property is defined by PagingToolbar.

lastText

public String lastText

Customizable piece of the default paging text (defaults to "Last Page")

This property is defined by PagingToolbar.

nextText

public String nextText

Customizable piece of the default paging text (defaults to "Next Page")

This property is defined by PagingToolbar.

prevText

public String prevText

Customizable piece of the default paging text (defaults to "Previous Page")

This property is defined by PagingToolbar.

refreshText

public String refreshText

Customizable piece of the default paging text (defaults to "Refresh")

This property is defined by PagingToolbar.

Constructor Details

PagingToolbar

public function PagingToolbar( String/HTMLElement/Element container, Ext.data.Store store, Object config )

Create a new PagingToolbar

Parameters:

container : String/HTMLElement/Element
The id or element that will contain the toolbar
store : Ext.data.Store
The underlying data store providing the paged data
config : Object
The config object

Method Details

add

public function add( Mixed arg1, Mixed arg2, Mixed etc. )

Adds element(s) to the toolbar -- this function takes a variable number of arguments of mixed type and adds them to the toolbar.

Parameters:

arg1 : Mixed
The following types of arguments are all valid:
- Ext.Toolbar.Button config: A valid button config object (equivalent to addButton)
- HtmlElement: Any standard HTML element (equivalent to addElement)
- Field: Any form field (equivalent to addField)
- Item: Any subclass of Ext.Toolbar.Item (equivalent to addItem)
- String: Any generic string (gets wrapped in a Ext.Toolbar.TextItem, equivalent to addText). Note that there are a few special strings that are treated differently as explained next.
- 'separator' or '-': Creates a separator element (equivalent to addSeparator)
- ' ': Creates a spacer element (equivalent to addSpacer)
- '->': Creates a fill element (equivalent to addFill)
arg2 : Mixed
etc. : Mixed

Returns:

void

This method is defined by Toolbar.

addButton

public function addButton( Object/Array config )

Adds a button (or buttons). See Ext.Toolbar.Button for more info on the config.

Parameters:

config : Object/Array
A button config or array of configs

Returns:

Ext.Toolbar.Button/Array

This method is defined by Toolbar.

addDom

public function addDom( Object config )

Adds a new element to the toolbar from the passed Ext.DomHelper config.

Parameters:

config : Object

Returns:

Ext.Toolbar.Item
The element's item

This method is defined by Toolbar.

addElement

public function addElement( String/HTMLElement/Element el )

Adds any standard HTML element to the toolbar

Parameters:

el : String/HTMLElement/Element
The element or id of the element to add

Returns:

Ext.Toolbar.Item
The element's item

This method is defined by Toolbar.

addField

public function addField( Ext.form.Field field )

Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have been rendered yet. For a field that has already been rendered, use addElement.

Parameters:

field : Ext.form.Field

Returns:

Ext.ToolbarItem

This method is defined by Toolbar.

addFill

public function addFill()

Adds a fill element that forces subsequent additions to the right side of the toolbar

Parameters:

None.

Returns:

Ext.Toolbar.Fill
The fill item

This method is defined by Toolbar.

addItem

public function addItem( Ext.Toolbar.Item item )

Adds any Toolbar.Item or subclass

Parameters:

item : Ext.Toolbar.Item

Returns:

Ext.Toolbar.Item
The item

This method is defined by Toolbar.

addSeparator

public function addSeparator()

Adds a separator

Parameters:

None.

Returns:

Ext.Toolbar.Item
The separator item

This method is defined by Toolbar.

addSpacer

public function addSpacer()

Adds a spacer element

Parameters:

None.

Returns:

Ext.Toolbar.Spacer
The spacer item

This method is defined by Toolbar.

addText

public function addText( String text )

Adds text to the toolbar

Parameters:

text : String
The text to add

Returns:

Ext.Toolbar.Item
The element's item

This method is defined by Toolbar.

bind

public function bind( Ext.data.Store store )

Binds the paging toolbar to the specified Ext.data.Store

Parameters:

store : Ext.data.Store
The data store to bind

Returns:

void

This method is defined by PagingToolbar.

getEl

public function getEl()

Returns the Element for this toolbar.

Parameters:

None.

Returns:

Ext.Element

This method is defined by Toolbar.

insertButton

public function insertButton( Number index, Object/Ext.Toolbar.Item/Ext.Toolbar.Button (may )

Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index.

Parameters:

index : Number
The index where the item is to be inserted
(may : Object/Ext.Toolbar.Item/Ext.Toolbar.Button
be Array)} item The button, or button config object to be inserted.

Returns:

Ext.Toolbar.Button/Item

This method is defined by Toolbar.

unbind

public function unbind( Ext.data.Store store )

Unbinds the paging toolbar from the specified Ext.data.Store

Parameters:

store : Ext.data.Store
The data store to unbind

Returns:

void

This method is defined by PagingToolbar.

Config Details

displayInfo

displayInfo : Boolean

True to display the displayMsg (defaults to false)

This config option is defined by PagingToolbar.

displayMsg

displayMsg : String

The paging status message to display (defaults to "Displaying {start} - {end} of {total}")

This config option is defined by PagingToolbar.

emptyMsg

emptyMsg : String

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

This config option is defined by PagingToolbar.

pageSize

pageSize : Number

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

This config option is defined by PagingToolbar.