class sap.m.PagingButton

Control sample: sap.m.PagingButton
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/PagingButton
Application Component: CA-UI5-CTR

Enables users to navigate between items/entities.


Constructor

Constructor for a new PagingButton.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.m.PagingButton(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
count int 1

Determines the total count of items/entities that the control navigates through. The minimum number of items/entities is 1.

Visibility: public
nextButtonTooltip string empty string

Determines the tooltip of the next button.

Since: 1.36.

Visibility: public
position int 1

Determines the current position in the items/entities that the control navigates through. Starting (minimum) number is 1.

Visibility: public
previousButtonTooltip string empty string

Determines the tooltip of the previous button.

Since: 1.36.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
nextButton 0..1 sap.m.Button
previousButton 0..1 sap.m.Button

Events Overview

Event Description
positionChange

Fired when the current position is changed.

positionChange

Fired when the current position is changed.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
newPosition int

The number of the new position.

oldPosition int

The number of the old position.


Methods Overview

Method Description
attachPositionChange

Attaches event handler fnFunction to the positionChange event of this sap.m.PagingButton.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PagingButton itself.

Fired when the current position is changed.

detachPositionChange

Detaches event handler fnFunction from the positionChange event of this sap.m.PagingButton.

The passed function and listener object must match the ones used for event registration.

sap.m.PagingButton.extend

Creates a new subclass of class sap.m.PagingButton with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

firePositionChange

Fires event positionChange to attached listeners.

getCount

Gets current value of property count.

Determines the total count of items/entities that the control navigates through. The minimum number of items/entities is 1.

Default value is 1.

sap.m.PagingButton.getMetadata

Returns a metadata object for class sap.m.PagingButton.

getNextButtonTooltip

Gets current value of property nextButtonTooltip.

Determines the tooltip of the next button.

Default value is empty string.

getPosition

Gets current value of property position.

Determines the current position in the items/entities that the control navigates through. Starting (minimum) number is 1.

Default value is 1.

getPreviousButtonTooltip

Gets current value of property previousButtonTooltip.

Determines the tooltip of the previous button.

Default value is empty string.

setCount

Sets a new value for property count.

Determines the total count of items/entities that the control navigates through. The minimum number of items/entities is 1.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

setNextButtonTooltip

Sets a new value for property nextButtonTooltip.

Determines the tooltip of the next button.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setPosition

Sets a new value for property position.

Determines the current position in the items/entities that the control navigates through. Starting (minimum) number is 1.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

setPreviousButtonTooltip

Sets a new value for property previousButtonTooltip.

Determines the tooltip of the previous button.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

attachPositionChange

Attaches event handler fnFunction to the positionChange event of this sap.m.PagingButton.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PagingButton itself.

Fired when the current position is changed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.m.PagingButton itself

detachPositionChange

Detaches event handler fnFunction from the positionChange event of this sap.m.PagingButton.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.m.PagingButton.extend

Creates a new subclass of class sap.m.PagingButton with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

firePositionChange

Fires event positionChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

newPosition int

The number of the new position.

oldPosition int

The number of the old position.

getCount

Gets current value of property count.

Determines the total count of items/entities that the control navigates through. The minimum number of items/entities is 1.

Default value is 1.

sap.m.PagingButton.getMetadata

Returns a metadata object for class sap.m.PagingButton.

getNextButtonTooltip

Gets current value of property nextButtonTooltip.

Determines the tooltip of the next button.

Default value is empty string.

getPosition

Gets current value of property position.

Determines the current position in the items/entities that the control navigates through. Starting (minimum) number is 1.

Default value is 1.

getPreviousButtonTooltip

Gets current value of property previousButtonTooltip.

Determines the tooltip of the previous button.

Default value is empty string.

setCount

Sets a new value for property count.

Determines the total count of items/entities that the control navigates through. The minimum number of items/entities is 1.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

Param Type DefaultValue Description
iCount int 1

New value for property count

setNextButtonTooltip

Sets a new value for property nextButtonTooltip.

Determines the tooltip of the next button.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sNextButtonTooltip string ""

New value for property nextButtonTooltip

setPosition

Sets a new value for property position.

Determines the current position in the items/entities that the control navigates through. Starting (minimum) number is 1.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

Param Type DefaultValue Description
iPosition int 1

New value for property position

setPreviousButtonTooltip

Sets a new value for property previousButtonTooltip.

Determines the tooltip of the previous button.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sPreviousButtonTooltip string ""

New value for property previousButtonTooltip