com.businessobjects.jsf.sdk.properties
Class PagingProps

java.lang.Object
  |
  +--com.businessobjects.jsf.sdk.properties.PagingProps
All Implemented Interfaces:
java.io.Serializable

public class PagingProps
extends java.lang.Object
implements java.io.Serializable

Contains properties for specifying how to perform paging.

See Also:
Serialized Form

Constructor Summary
PagingProps()
           
PagingProps(boolean enabled, int nObjs, int nPages)
           
 
Method Summary
 int getPageSize()
           Gets the number of items per page.
 int getRangeSize()
           Gets the number of pages per page range.
 boolean hasSameValues(PagingProps paging)
           Returns whether or not the PagingProps object passed in has the same values as this PagingProps object.
 boolean isEnabled()
           Returns a value that indicates whether paging is enabled.
 void setEnabled(boolean enabled)
           Sets a value that indicates whether paging is enabled.
 void setPageSize(int pageSize)
           Sets the number of items per page.
 void setRangeSize(int rangeSize)
           Sets the number of pages per page range.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PagingProps

public PagingProps()

PagingProps

public PagingProps(boolean enabled,
                   int nObjs,
                   int nPages)
Method Detail

hasSameValues

public boolean hasSameValues(PagingProps paging)

Returns whether or not the PagingProps object passed in has the same values as this PagingProps object.

Parameters:
paging - the PagingProps object whose values to check

isEnabled

public boolean isEnabled()

Returns a value that indicates whether paging is enabled.

Returns:
true if paging is enabled, otherwise, false.

setEnabled

public void setEnabled(boolean enabled)

Sets a value that indicates whether paging is enabled.

Parameters:
enabled - true to enable paging, otherwise, false.

getPageSize

public int getPageSize()

Gets the number of items per page.

Returns:
An int representing the number of items per page.

setPageSize

public void setPageSize(int pageSize)

Sets the number of items per page.


getRangeSize

public int getRangeSize()

Gets the number of pages per page range.

Returns:
An int representing the number of pages per page range.

setRangeSize

public void setRangeSize(int rangeSize)

Sets the number of pages per page range.