Package org.opencms.workplace.list

Class CmsListState

java.lang.Object

org.opencms.workplace.list.CmsListState

public class CmsListState
extends Object

Class for storing the state of a list.

A list state includes:

• The current sorted Column
• The sorted column Order
• The current displayed Page
• The current search Filter

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsListState()	Empty constructor, with default values.
CmsListState(CmsHtmlList list)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
String	getColumn()	Returns the column.
String	getFilter()	Returns the filter.
CmsListOrderEnum	getOrder()	Returns the order.
int	getPage()	Returns the page.
void	setColumn(String column)	Sets the column.
void	setFilter(String filter)	Sets the filter.
void	setOrder(CmsListOrderEnum order)	Sets the order.
void	setPage(int page)	Sets the page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsListState

public CmsListState()

Empty constructor, with default values.

CmsListState

public CmsListState(CmsHtmlList list)

Default Constructor.

Parameters:

list - the list to read the state from

Method Details

getColumn

public String getColumn()

Returns the column.

Returns:

the column

getFilter

public String getFilter()

Returns the filter.

Returns:

the filter

getOrder

public CmsListOrderEnum getOrder()

Returns the order.

Returns:

the order

getPage

public int getPage()

Returns the page.

Returns:

the page

setColumn

public void setColumn(String column)

Sets the column.

Parameters:

column - the column to set

setFilter

public void setFilter(String filter)

Sets the filter.

Parameters:

filter - the filter to set

setOrder

public void setOrder(CmsListOrderEnum order)

Sets the order.

Parameters:

order - the order to set

setPage

public void setPage(int page)

Sets the page.

Parameters:

page - the page to set