net.liftweb.http

SortedPaginatorSnippet

trait SortedPaginatorSnippet [T, C] extends SortedPaginator[T, C] with PaginatorSnippet[T]

This trait adds snippet functionality for sorted paginators. You can place bind points in your template for column headers, and it turns them into links That you can click to sort by that column. Simply write, e.g., <th><sort:name/></th><th><sort:email/></th> etc.

linear super types: PaginatorSnippet[T], SortedPaginator[T, C], Paginator[T], Loggable, AnyRef, Any
known subclasses: StatefulSortedPaginatorSnippet, SortedMapperPaginatorSnippet
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SortedPaginatorSnippet
  2. PaginatorSnippet
  3. SortedPaginator
  4. Paginator
  5. Loggable
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. type SortState = (Int, Boolean)

    Pair of (column index, ascending)

    Pair of (column index, ascending)

    definition classes: SortedPaginator

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. var _first : Long

    attributes: protected
    definition classes: PaginatorSnippet
  9. var _sort : (Int, Boolean)

    attributes: protected
    definition classes: SortedPaginator
  10. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  11. def ascendingParam : String

    The URL query parameter to specify the sort direction

    The URL query parameter to specify the sort direction

  12. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  13. def count : Long

    The total number of items

    The total number of items

    attributes: abstract
    definition classes: Paginator
  14. 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
  15. def currentXml : NodeSeq

    The status displayed when using <nav:records/> in the template.

    The status displayed when using <nav:records/> in the template.

    definition classes: PaginatorSnippet
  16. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  17. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  18. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  19. 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: PaginatorSnippetPaginator
  20. def firstXml : NodeSeq

    The "first page" link text

    The "first page" link text

    definition classes: PaginatorSnippet
  21. def first_= (f: Long) : Unit

    Sets the default starting record of the page (URL query parameters take precedence over this)

    Sets the default starting record of the page (URL query parameters take precedence over this)

    definition classes: PaginatorSnippet
  22. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  23. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  24. def headers : List[(String, C)]

    The sort headers: pairs of column labels, and column identifier objects of type C.

    The sort headers: pairs of column labels, and column identifier objects of type C.

    attributes: abstract
    definition classes: SortedPaginator
  25. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  26. def itemsPerPage : Int

    How many items to put on each page

    How many items to put on each page

    definition classes: Paginator
  27. def lastXml : NodeSeq

    The "last page" link text

    The "last page" link text

    definition classes: PaginatorSnippet
  28. val logger : Logger

    attributes: protected
    definition classes: Loggable
  29. def navPrefix : String

    The template prefix for general navigation components

    The template prefix for general navigation components

    definition classes: PaginatorSnippet
  30. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  31. def nextXml : NodeSeq

    The "next page" link text

    The "next page" link text

    definition classes: PaginatorSnippet
  32. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  33. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  34. 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
  35. def offsetParam : String

    The URL query parameter to propagate the record the page should start at

    The URL query parameter to propagate the record the page should start at

    definition classes: PaginatorSnippet
  36. def page : Seq[T]

    The items displayed on the current page

    The items displayed on the current page

    attributes: abstract
    definition classes: Paginator
  37. def pageUrl (offset: Long) : String

    Overrides pageUrl and delegates to sortedPageUrl using the current sort

    Overrides pageUrl and delegates to sortedPageUrl using the current sort

    definition classes: SortedPaginatorSnippetPaginatorSnippet
  38. 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

    definition classes: PaginatorSnippet
  39. def pagesXml (pages: Seq[Int], sep: NodeSeq) : NodeSeq

    Generates links to multiple pages with arbitrary XML delimiting them.

    Generates links to multiple pages with arbitrary XML delimiting them.

    definition classes: PaginatorSnippet
  40. def paginate (xhtml: NodeSeq) : NodeSeq

    This is the snippet method, which you can reference in your template or call directly.

    This is the snippet method, which you can reference in your template or call directly.

    definition classes: SortedPaginatorSnippetPaginatorSnippet
  41. def prevXml : NodeSeq

    The "previous page" link text

    The "previous page" link text

    definition classes: PaginatorSnippet
  42. def recordsFrom : String

    How to display the page's starting record

    How to display the page's starting record

    definition classes: PaginatorSnippet
  43. def recordsTo : String

    How to display the page's ending record

    How to display the page's ending record

    definition classes: PaginatorSnippet
  44. def sort : ()

    Overrides sort, giving the URL query parameters precedence

    Overrides sort, giving the URL query parameters precedence

    definition classes: SortedPaginatorSnippetSortedPaginator
  45. def sortParam : String

    The URL query parameter to specify the sort column

    The URL query parameter to specify the sort column

  46. def sortPrefix : String

    The prefix to bind the sorting column headers

    The prefix to bind the sorting column headers

  47. def sort_= (s: ()) : Unit

    Set the current sort state: Pair of (column index, ascending?)

    Set the current sort state: Pair of (column index, ascending?)

    definition classes: SortedPaginator
  48. def sortedBy (column: Int) : ()

    Returns a new SortState based on a column index.

    Returns a new SortState based on a column index. If the paginator is already sorted by that column, it toggles the direction; otherwise the direction is ascending. Note that this method does not alter the sort state in the paginator; it only calculates the direction toggle. Example usage: sortedPaginator.sort = sortedPaginator.sortedBy(columns.indexOf(clickedColumn))

    definition classes: SortedPaginator
  49. def sortedPageUrl (offset: Long, sort: (Int, Boolean)) : String

    Calculates the page url taking sorting into account.

    Calculates the page url taking sorting into account.

  50. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  51. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  52. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  53. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  54. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  55. def zoomedPages : List[Int]

    Returns a list of page numbers to be displayed in 'zoomed' mode, i.

    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

Inherited from PaginatorSnippet[T]

Inherited from SortedPaginator[T, C]

Inherited from Paginator[T]

Inherited from Loggable

Inherited from AnyRef

Inherited from Any