ContentBox Core API 1.6.0

contentbox.plugins
Class Paging

WEB-INF.cftags.component
        extended by contentbox.plugins.Paging

public class Paging
extends WEB-INF.cftags.component

A paging plugin for ContentBox

Property Summary
Type Property & Description Default Serializable Required
 any PagingBandGap


Attributes:
true false
 any pagingMaxRows


Attributes:
true false
 
Constructor Summary
init(any settingService)
 
Method Summary
 any GETPAGINGBANDGAP()
          get:
 any GETPAGINGMAXROWS()
          get:
 Paging SETPAGINGBANDGAP(any PagingBandGap)
          set:
 Paging SETPAGINGMAXROWS(any pagingMaxRows)
          set:
 struct getboundaries([numeric pagingMaxRows])
          Calculate the startrow and maxrow
 any renderit(numeric foundRows, string link, [numeric pagingMaxRows], [boolean asList='false'])
          render plugin tabs
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any settingService)

Parameters:
settingService
Property Detail

PagingBandGap

any PagingBandGap

Attributes:
default -
serializable - true
required - false

pagingMaxRows

any pagingMaxRows

Attributes:
default -
serializable - true
required - false

Method Detail

GETPAGINGBANDGAP

public any GETPAGINGBANDGAP()
get:


GETPAGINGMAXROWS

public any GETPAGINGMAXROWS()
get:


SETPAGINGBANDGAP

public Paging SETPAGINGBANDGAP(any PagingBandGap)
set:

Parameters:
PagingBandGap

SETPAGINGMAXROWS

public Paging SETPAGINGMAXROWS(any pagingMaxRows)
set:

Parameters:
pagingMaxRows

getboundaries

public struct getboundaries([numeric pagingMaxRows])
Calculate the startrow and maxrow

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

renderit

public any renderit(numeric foundRows, string link, [numeric pagingMaxRows], [boolean asList='false'])
render plugin 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

ContentBox Core API 1.6.0