org.alfresco.web.data
Interface IDataContainer

All Known Implementing Classes:
UIAVMList, UIRichList

public interface IDataContainer


Field Summary
static java.lang.String SORT_CASEINSENSITIVE
           
static java.lang.String SORT_CASESENSITIVE
           
 
Method Summary
 int getCurrentPage()
          Return the current page the list is displaying
 java.lang.String getCurrentSortColumn()
          Return the currently sorted column if any
 int getPageCount()
          Return the count of max available pages
 int getPageSize()
          Returns the current page size used for this list, or -1 for no paging.
 boolean isCurrentSortDescending()
          Returns the current sort direction.
 boolean isDataAvailable()
          Returns true if a row of data is available
 java.lang.Object nextRow()
          Returns the next row of data from the data model
 void setCurrentPage(int index)
          Set the current page to display.
 void sort(java.lang.String column, boolean descending, java.lang.String mode)
          Sort the dataset using the specified sort parameters
 

Field Detail

SORT_CASEINSENSITIVE

static final java.lang.String SORT_CASEINSENSITIVE
See Also:
Constant Field Values

SORT_CASESENSITIVE

static final java.lang.String SORT_CASESENSITIVE
See Also:
Constant Field Values
Method Detail

getCurrentSortColumn

java.lang.String getCurrentSortColumn()
Return the currently sorted column if any

Returns:
current sorted column if any

isCurrentSortDescending

boolean isCurrentSortDescending()
Returns the current sort direction. Only valid if a sort column is set. True is returned for descending sort, false for accending sort.

Returns:
true for descending sort, false for accending sort

getPageSize

int getPageSize()
Returns the current page size used for this list, or -1 for no paging.


getCurrentPage

int getCurrentPage()
Return the current page the list is displaying

Returns:
Current page with zero based index

setCurrentPage

void setCurrentPage(int index)
Set the current page to display.

Parameters:
index - Zero based page index to display

getPageCount

int getPageCount()
Return the count of max available pages

Returns:
count of max available pages

isDataAvailable

boolean isDataAvailable()
Returns true if a row of data is available

Returns:
true if data is available, false otherwise

nextRow

java.lang.Object nextRow()
Returns the next row of data from the data model

Returns:
next row of data as a Bean object

sort

void sort(java.lang.String column,
          boolean descending,
          java.lang.String mode)
Sort the dataset using the specified sort parameters

Parameters:
column - Column to sort
descending - True for descending sort, false for ascending
mode - Sort mode to use (see IDataContainer constants)


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.