com.cc.framework.ui.model
Interface ListStateModel

All Superinterfaces:

StateModel

All Known Subinterfaces:

TreelistStateModel

All Known Implementing Classes:

ListStateModelImp, SimpleListControl, TreelistControl, TreelistStateModelImp

public interface ListStateModel

extends StateModel

State model for the ListControl

Since:

1.0

Version:

$Revision: 1.13 $

Author:

Harald Schulz

Field Summary

static java.lang.String

PROP_PAGE State property for the current page

Fields inherited from interface com.cc.framework.ui.model.StateModel

PROP_CONTROL

Method Summary

int	getCurrentPage() Returns the zero based index of the page which is currently display.
java.lang.String[]	getMarked() Retrieves all marked items
java.lang.String	getSortColumn() Returns the name of the column which is currently used for sorting.
SortOrder	getSortOrder() Returns the sort order
boolean	isMarked(java.lang.String uniqueKey) Checks if the specified row is selected.
void	mark(java.lang.String uniqueKey) Selects a specified row.
void	resetSortInfo() Resets any sorting Information
void	setCurrentPage(int page) Sets the index for the page which is currently display to another value.
void	setSortInfo(java.lang.String column, SortOrder direction) Sets the sort order for the specified column
void	unmark(java.lang.String uniqueKey) Unselects a specified row.
void	unmarkAll() Unselects all selected rows

Methods inherited from interface com.cc.framework.ui.model.StateModel

reset, synchronizeState

Field Detail

PROP_PAGE

public static final java.lang.String PROP_PAGE

State property for the current page

See Also:

Constant Field Values

Method Detail

getCurrentPage

public int getCurrentPage()

Returns the zero based index of the page which is currently display.

Returns:

Zero based index of the page which is currently displayed

setCurrentPage

public void setCurrentPage(int page)

Sets the index for the page which is currently display to another value.

Parameters:

page - The new page index

getSortColumn

public java.lang.String getSortColumn()

Returns the name of the column which is currently used for sorting.

Returns:

The name of the column which is currently used for sorting

getSortOrder

public SortOrder getSortOrder()

Returns the sort order

Returns:

The sort order

mark

public void mark(java.lang.String uniqueKey)

Selects a specified row.

Parameters:

uniqueKey - The unique key of the row which should be selected

isMarked

public boolean isMarked(java.lang.String uniqueKey)

Checks if the specified row is selected.

Parameters:

uniqueKey - The unique key

Returns:

boolean Returns true if the row is selected; false otherwise

getMarked

public java.lang.String[] getMarked()

Retrieves all marked items

Returns:

Array with the keys of the marked items

unmark

public void unmark(java.lang.String uniqueKey)

Unselects a specified row.

Parameters:

uniqueKey - The unique key of the row which should be unselected

unmarkAll

public void unmarkAll()

Unselects all selected rows

setSortInfo

public void setSortInfo(java.lang.String column,
                        SortOrder direction)

Sets the sort order for the specified column

Parameters:

column - Name of the column

direction - The sort order

resetSortInfo

public void resetSortInfo()

Resets any sorting Information