trait PaginatorSnippet[T] extends Paginator[T]
This is the paginator snippet. It provides page navigation and column sorting links.
The values for the pagination are bound according to the classes specified in the paginate method, using a CSS selector transform.
- Alphabetic
- By Inheritance
- PaginatorSnippet
- Paginator
- Loggable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
_first: Long
- Attributes
- protected
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
curPage: Int
Calculates the current page number, based on the value of 'first.'
Calculates the current page number, based on the value of 'first.'
- Definition Classes
- Paginator
-
def
currentXml: NodeSeq
The status displayed when using <nav:records/> in the template.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
first: Long
Overrides the super's implementation so the first record can be overridden by a URL query parameter.
Overrides the super's implementation so the first record can be overridden by a URL query parameter.
- Definition Classes
- PaginatorSnippet → Paginator
-
def
firstXml: NodeSeq
The "first page" link text
-
def
first_=(f: Long): Unit
Sets the default starting record of the page (URL query parameters take precedence over this)
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
itemsPerPage: Int
How many items to put on each page
How many items to put on each page
- Definition Classes
- Paginator
-
def
lastXml: NodeSeq
The "last page" link text
-
val
logger: Logger
- Attributes
- protected
- Definition Classes
- Loggable
- Annotations
- @transient()
-
def
navPrefix: String
The template prefix for general navigation components
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nextXml: NodeSeq
The "next page" link text
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
numPages: Int
Calculates the number of pages the items will be spread across
Calculates the number of pages the items will be spread across
- Definition Classes
- Paginator
-
def
offsetParam: String
The URL query parameter to propagate the record the page should start at
-
def
pageUrl(offset: Long): String
Returns a URL used to link to a page starting at the given record offset.
-
def
pageXml(newFirst: Long, ns: NodeSeq): NodeSeq
Returns XML that links to a page starting at the given record offset, if the offset is valid and not the current one.
Returns XML that links to a page starting at the given record offset, if the offset is valid and not the current one.
- ns
The link text, if the offset is valid and not the current offset; or, if that is not the case, the static unlinked text to display
-
def
pagesXml(pages: Seq[Int])(sep: NodeSeq): NodeSeq
Generates links to multiple pages with arbitrary XML delimiting them.
-
def
paginate: CssSel
This method binds template HTML based according to the specified configuration.
This method binds template HTML based according to the specified configuration. You can reference this as a snippet method directly in your template; or you can call it directly as part of your binding code.
Classes used to bind:
first
: link to go back to the first page (populated byfirstXml
)prev
: link to go to previous page (populated byprevXml
)all-pages
: container for all pages (populated bypagesXml
)zoomed-pages
: container forzoomedPages
(populated bypagesXml
)next
: link to go to next page (populated bynextXml
)last
: link to go to last page (populated bylastXml
)records
: currently visible records + total count (populated bycurrentXml
)records-start
: start of currently visible recordsrecords-end
: end of currently visible recordsrecords-count
: total records count
-
def
prevXml: NodeSeq
The "previous page" link text
-
def
recordsFrom: String
How to display the page's starting record
-
def
recordsTo: String
How to display the page's ending record
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
zoomedPages: List[Int]
Returns a list of page numbers to be displayed in 'zoomed' mode, i.e., as the page numbers get further from the current page, they are more sparse.
Returns a list of page numbers to be displayed in 'zoomed' mode, i.e., as the page numbers get further from the current page, they are more sparse.
- Definition Classes
- Paginator