contentbox.models.ui

Class Paging

lucee.Component
    extended by contentbox.models.ui.Paging

A paging object for ContentBox

Class Attributes:
  • output : false
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any controller


    • access = public
    • returntype = any
    • inject = coldbox
    true false
    any PagingBandGap


    • access = public
    • returntype = any
    true false
    any pagingMaxRows


    • access = public
    • returntype = any
    true false
    Constructor Summary
    init(any settingService)
    Method Summary
    struct getboundaries([numeric pagingMaxRows])
         Calculate the startrow and maxrow.
    string getController()
    string getPagingBandGap()
    string getPagingMaxRows()
    any renderit(numeric foundRows, string link, [numeric pagingMaxRows], [boolean asList='false'])
         render tabs.
    any setController(any controller)
    any setPagingBandGap(any PagingBandGap)
    any setPagingMaxRows(any pagingMaxRows)
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init(any settingService)

    Parameters:
    settingService

    Property Detail

    controller

    property any controller

    Attributes:
    access - public
    required - false
    returntype - any
    inject - coldbox
    serializable - true

    PagingBandGap

    property any PagingBandGap

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    pagingMaxRows

    property any pagingMaxRows

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    getboundaries

    public struct getboundaries([numeric pagingMaxRows])

    Calculate the startrow and maxrow

    Parameters:
    pagingMaxRows - You can override the paging max rows here.

    getController

    public string getController()


    getPagingBandGap

    public string getPagingBandGap()


    getPagingMaxRows

    public string getPagingMaxRows()


    renderit

    public any renderit(numeric foundRows, string link, [numeric pagingMaxRows], [boolean asList='false'])

    render tabs

    Parameters:
    foundRows - The found rows to page
    link - The link to use, you must place the @page@ place holder so the link ca be created correctly
    pagingMaxRows - You can override the paging max rows here.
    asList - Render the paging links as lists or not

    setController

    public any setController(any controller)

    Parameters:
    controller

    setPagingBandGap

    public any setPagingBandGap(any PagingBandGap)

    Parameters:
    PagingBandGap

    setPagingMaxRows

    public any setPagingMaxRows(any pagingMaxRows)

    Parameters:
    pagingMaxRows