Class sap.m.PagingButtonModule: sap/m/PagingButton

extends Control

Enables users to navigate between items/entities.


Since: 1.30.
Constructor Summary
new sap.m.PagingButton(sId?, mSettings?)Constructor for a new PagingButton.
Event Summary
positionChange(oControlEvent)Fired when the current position is changed.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.PagingButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.PagingButton with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.PagingButton.getMetadata()Returns a metadata object for class sap.m.PagingButton.
attachPositionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the positionChange event of this sap.m.PagingButton.
detachPositionChange(fnFunction, oListener)Detaches event handler fnFunction from the positionChange event of this sap.m.PagingButton.
firePositionChange(mArguments?)Fires event positionChange to attached listeners.
getCount()Gets current value of property count.
getNextButtonTooltip()Gets current value of property nextButtonTooltip.
getPosition()Gets current value of property position.
getPreviousButtonTooltip()Gets current value of property previousButtonTooltip.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.PagingButton(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
positionChange(oControlEvent)
Fired when the current position is changed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{int}oControlEvent.getParameters.newPosition The number of the new position.
{int}oControlEvent.getParameters.oldPosition The number of the old position.
Method Detail
sap.m.PagingButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.m.PagingButton.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.PagingButton.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachPositionChange(oData?, fnFunction, oListener?): sap.m.PagingButton
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.PagingButton itself
Returns:
{sap.m.PagingButton} Reference to this in order to allow method chaining
detachPositionChange(fnFunction, oListener): sap.m.PagingButton
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.m.PagingButton} Reference to this in order to allow method chaining
firePositionChange(mArguments?): sap.m.PagingButton
Fires event positionChange to attached listeners.

Expects the following event parameters:

  • newPosition of type intThe number of the new position.
  • oldPosition of type intThe number of the old position.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.PagingButton} Reference to this in order to allow method chaining
getCount(): int
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.

Returns:
{int} Value of property count
getNextButtonTooltip(): string
Gets current value of property nextButtonTooltip.

Determines the tooltip of the next button.

Default value is .

Since:
1.36
Returns:
{string} Value of property nextButtonTooltip
getPosition(): int
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.

Returns:
{int} Value of property position
getPreviousButtonTooltip(): string
Gets current value of property previousButtonTooltip.

Determines the tooltip of the previous button.

Default value is .

Since:
1.36
Returns:
{string} Value of property previousButtonTooltip