Class SweetDevRia.PageBar
Extends
RiaComponent, RiaComponent.
Defined in: PageBar.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
This is the PageBar component class
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
SweetDevRia.PageBar.GO_PAGE_EVENT
This event type is fired when change page
|
| Method Attributes | Method Name and Description |
|---|---|
|
afterGoToPage(pageNumber)
This method is called after Change the page
To be overridden !!
|
|
|
afterSetActualPage(the)
This method is called after Set the selected page number
To be overridden !!
|
|
|
afterSetPageNumber(pageNumber)
This method is called after Set the total page number
To be overridden !!
|
|
|
Resize pageBar container
|
|
|
beforeGoToPage(pageNumber)
This method is called before Change the page
To be overridden !!
|
|
|
beforeSetActualPage(the)
This method is called before Set the selected page number
To be overridden !!
|
|
|
beforeSetPageNumber(pageNumber)
This method is called before Set the total page number
To be overridden !!
|
|
|
formatPageNumber(pageNumber)
Allow to format the text for a page number.
|
|
|
goToFirstPage(evt)
Go to the first page
|
|
|
goToLastPage(evt)
Go to the last page
|
|
|
goToNextPage(evt)
Go to the next page
|
|
|
goToPage(pageNumber)
Change the page.
|
|
| <private> |
goToPageEvt(evt, pageNumber)
|
|
goToPreviousPage(evt)
Go to the previous page
|
|
|
SWTRIA-1306
|
|
|
onNoNextPageEvent(the)
SWTRIA-943
This method is called when clicking on next page button when the pagebar is on the last page already.
|
|
|
SWTRIA-943
This method is called when clicking on previous page button when the pagebar is on the first page already.
|
|
|
setActualPage(the)
Set the selected page number
|
|
|
setAlwaysVisible(visible)
If setted to 'true' the page bar is displayed even if there is only one page.
|
|
|
setLinkedId(linkedId)
Set the associated component identifiant.
|
|
|
setPageNumber(pageNumber)
Set the total page number
|
|
|
setVisibility(visible)
|
Class Detail
SweetDevRia.PageBar(id)
This is the PageBar component class
- Parameters:
- {String} id
- Id of this PageBar
Field Detail
<static>
SweetDevRia.PageBar.GO_PAGE_EVENT
This event type is fired when change page
Method Detail
afterGoToPage(pageNumber)
This method is called after Change the page
To be overridden !!
- Parameters:
- {int} pageNumber
- The new selected page number
afterSetActualPage(the)
This method is called after Set the selected page number
To be overridden !!
- Parameters:
- {int} the
- new selected page number
afterSetPageNumber(pageNumber)
This method is called after Set the total page number
To be overridden !!
- Parameters:
- {int} pageNumber
- total page number of this page bar
{int}
ajustContainerWidth()
Resize pageBar container
- Returns:
- {int} the new Width
{boolean}
beforeGoToPage(pageNumber)
This method is called before Change the page
To be overridden !!
- Parameters:
- {int} pageNumber
- The new selected page number
- Returns:
- True if this method can be called, else false.
{boolean}
beforeSetActualPage(the)
This method is called before Set the selected page number
To be overridden !!
- Parameters:
- {int} the
- new selected page number
- Returns:
- True if this method can be called, else false.
{boolean}
beforeSetPageNumber(pageNumber)
This method is called before Set the total page number
To be overridden !!
- Parameters:
- {int} pageNumber
- total page number of this page bar
- Returns:
- True if this method can be called, else false.
formatPageNumber(pageNumber)
Allow to format the text for a page number. For example : "50..99" for page 2.
- Parameters:
- {int} pageNumber
- The page number to format
goToFirstPage(evt)
Go to the first page
- Parameters:
- evt
goToLastPage(evt)
Go to the last page
- Parameters:
- evt
goToNextPage(evt)
Go to the next page
- Parameters:
- evt
goToPage(pageNumber)
Change the page. Called by the linked component, or if none, by itself.
- Parameters:
- {int} pageNumber
- The new selected page number
<private>
goToPageEvt(evt, pageNumber)
- Parameters:
- evt
- pageNumber
goToPreviousPage(evt)
Go to the previous page
- Parameters:
- evt
isAlwaysVisible()
SWTRIA-1306
onNoNextPageEvent(the)
SWTRIA-943
This method is called when clicking on next page button when the pagebar is on the last page already.
To be overridden !!
- Parameters:
- {event} the
- click event
onNoPreviousPageEvent(the)
SWTRIA-943
This method is called when clicking on previous page button when the pagebar is on the first page already.
To be overridden !!
- Parameters:
- {event} the
- click event
setActualPage(the)
Set the selected page number
- Parameters:
- {int} the
- new selected page number
setAlwaysVisible(visible)
If setted to 'true' the page bar is displayed even if there is only one page.
SWTRIA-1306
- Parameters:
- visible
setLinkedId(linkedId)
Set the associated component identifiant. The page bar will call the goToPage method of this sweetdevria component.
- Parameters:
- {String} linkedId
- Associated component identifiant
setPageNumber(pageNumber)
Set the total page number
- Parameters:
- {int} pageNumber
- total page number of this page bar
setVisibility(visible)
- Parameters:
- visible