CmsListState (OpenCms Workplace Modules API, version 17.0)

java.lang.Object
- org.opencms.workplace.list.CmsListState

```
public class CmsListState
extends java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getColumn()`	Returns the column.
`java.lang.String`	`getFilter()`	Returns the filter.
`CmsListOrderEnum`	`getOrder()`	Returns the order.
`int`	`getPage()`	Returns the page.
`void`	`setColumn(java.lang.String column)`	Sets the column.
`void`	`setFilter(java.lang.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 Detail
  - 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 Detail
  - getColumn
```
public java.lang.String getColumn()
```
    Returns the column.
    
    Returns:
    
    the column
  - getFilter
```
public java.lang.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(java.lang.String column)
```
    Sets the column.
    
    Parameters:
    
    column - the column to set
  - setFilter
```
public void setFilter(java.lang.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