PageLabelCollection
Inheritance: java.lang.Object
public class PageLabelCollection
Class represeingting page label collection.
Methods
Method | Description |
---|---|
getLabel(int pageIndex) | Gets page label by page index (page index is started from 0). |
updateLabel(int pageIndex, PageLabel pageLabel) | Update label for given page index (page index is started from 0). |
removeLabel(int pageIndex) | Remove label by page index (page index is started from 0). |
getPages() | Gets page indexes in collection. |
getLabel(int pageIndex)
public PageLabel getLabel(int pageIndex)
Gets page label by page index (page index is started from 0).
Parameters:
Parameter | Type | Description |
---|---|---|
pageIndex | int | Index of the page. |
Returns: PageLabel - Page label for specified page index or null if page label does not exist.
updateLabel(int pageIndex, PageLabel pageLabel)
public void updateLabel(int pageIndex, PageLabel pageLabel)
Update label for given page index (page index is started from 0).
Parameters:
Parameter | Type | Description |
---|---|---|
pageIndex | int | Index of page to change lable of the page. |
pageLabel | PageLabel | New label of the page. |
removeLabel(int pageIndex)
public boolean removeLabel(int pageIndex)
Remove label by page index (page index is started from 0).
Parameters:
Parameter | Type | Description |
---|---|---|
pageIndex | int | Index of page where label must be deleted. |
Returns: boolean - true if operation was executed successfully.
getPages()
public int[] getPages()
Gets page indexes in collection.
Returns: int[] - Array of integers which contains indexes of the pages.