AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Paginator.Url Class

    Defined in: yui3/src/paginator/js/paginator-url.js:1
    Module: paginator-url
    Parent Module: paginator

    Adds in URL options for paginator links.

    Index

    Methods

    Attributes

    Methods

    formatPageUrl

    (
    • [page]
    )
    String | null

    Defined in yui3/src/paginator/js/paginator-url.js:43

    Returns a formated URL for the provided page number.

    Parameters:

    • [page] Number optional

      Page value to be used in the formatted URL. If empty, page will be the value of the page ATTRS.

    Returns:

    String | null:

    Formatted URL for the page or null if there is not a pageUrl set.

    nextPageUrl

    () String | null

    Defined in yui3/src/paginator/js/paginator-url.js:34

    Returns a formated URL for the next page.

    Returns:

    String | null:

    Formatted URL for the next page or null if there is no next page.

    prevPageUrl

    () String | null

    Defined in yui3/src/paginator/js/paginator-url.js:25

    Returns a formated URL for the previous page.

    Returns:

    String | null:

    Formatted URL for the previous page, or null if there is no previous page.

    Attributes

    pageUrl

    String

    Defined in yui3/src/paginator/js/paginator-url.js:13

    URL to return formatted with the page number. URL uses Y.Lang.sub for page number stubstitutions.

    For example, if the page number is 3, setting the pageUrl to "?pg={page}", will result in ?pg=3