ManiaLib 1.0b1 API Reference

 Class PageNavigator

Description

Page Navigator

Page navigation arrows at the bottom of the lists

Located in /gui-toolkit/cards/PageNavigator.class.php (line 14)

GuiComponent
   |
   --PageNavigator
Variable Summary
Method Summary
 PageNavigator __construct ([ $iconSize = 5])
 void isFastNextShown ()
 void isLastShown ()
 void isTextShown ()
 void save ()
 void setCurrentPage ( $currentPage)
 void setPageNumber ( $pageNumber)
 void setSize ([ $iconSize = 5], [ $nullValue = null])
 void showFastNext ([ $show = true])
 void showLast ([ $show = true])
 void showText ([ $show = true])
Variables
Icons64x64_1 $arrowFastNext (line 27)
  • access: public
mixed $arrowFastNextStyle = Icons64x64_1::ArrowFastNext (line 48)
  • access: public
Icons64x64_1 $arrowFastPrev (line 31)
  • access: public
mixed $arrowFastPrevStyle = Icons64x64_1::ArrowFastPrev (line 49)
  • access: public
Icons64x64_1 $arrowFirst (line 39)
  • access: public
mixed $arrowFirstStyle = Icons64x64_1::ArrowFirst (line 50)
  • access: public
Icons64x64_1 $arrowLast (line 35)
  • access: public
mixed $arrowLastStyle = Icons64x64_1::ArrowLast (line 51)
  • access: public
Icons64x64_1 $arrowNext (line 19)
  • access: public
mixed $arrowNextStyle = Icons64x64_1::ArrowNext (line 46)
  • access: public
mixed $arrowNoneStyle = Icons64x64_1::StarGold (line 45)
  • access: public
Icons64x64_1 $arrowPrev (line 23)
  • access: public
mixed $arrowPrevStyle = Icons64x64_1::ArrowPrev (line 47)
  • access: public
Label $text (line 43)
  • access: public
Methods
Constructor __construct (line 63)
PageNavigator __construct ([ $iconSize = 5])
  • $iconSize
isFastNextShown (line 141)

Returns whether the "fast prev/next" navigation icons are shown

void isFastNextShown ()
isLastShown (line 125)

Returns whether the "go to first/last" navigation icons are shown

void isLastShown ()
isTextShown (line 158)

Returns whether the text is shown

void isTextShown ()
save (line 166)

Saves the PageNavigator in the GUI objects stack

void save ()
setCurrentPage (line 109)

Sets the current page

void setCurrentPage ( $currentPage)
  • $currentPage
setPageNumber (line 101)

Sets the page number

void setPageNumber ( $pageNumber)
  • $pageNumber
setSize (line 88)

Sets the size of the navigation icons

void setSize ([ $iconSize = 5], [ $nullValue = null])
  • $iconSize
  • $nullValue

Redefinition of:
GuiComponent::setSize()
Sets the size of the element
showFastNext (line 133)

Shows or hides the "fast prev/next" navigation icons

void showFastNext ([ $show = true])
  • $show
showLast (line 117)

Shows or hides the "go to first/last" navigation icons

void showLast ([ $show = true])
  • $show
showText (line 150)

Shows or hides the text. Note that if the current page or the page number

isn't declared, the text won't be shown

void showText ([ $show = true])
  • $show

Inherited Methods

Inherited From GuiComponent

 GuiComponent::getPosX()
 GuiComponent::getPosY()
 GuiComponent::getPosZ()
 GuiComponent::getScale()
 GuiComponent::getSizeX()
 GuiComponent::getSizeY()
 GuiComponent::setPosition()
 GuiComponent::setPositionX()
 GuiComponent::setPositionY()
 GuiComponent::setPositionZ()
 GuiComponent::setScale()
 GuiComponent::setSize()
 GuiComponent::setSizeX()
 GuiComponent::setSizeY()