com.redhat.rhn.frontend.listview

Class ListControl

java.lang.Object

com.redhat.rhn.frontend.listview.ListControl

Direct Known Subclasses:

PageControl

public class ListControl
extends java.lang.Object

ListControl ListControl is the basic method of control for a list of dataresults to be shown with the ListDisplayTag. It provides filtering and indexing mechanisms for showing data.

Constructor Summary

Constructors

Constructor and Description
ListControl()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Character,java.lang.Integer>	createIndex(DataResult dr) Create index on the DataResult dr
void	filterData(DataResult dr) Restrict the data that is in the list so that it matches the requested data.
java.lang.String	getFilterColumn() Get the column on which to filter
java.lang.String	getFilterData() Get the data to filter for
boolean	hasFilter() Determine if this list should have a filter box
boolean	hasIndex() Determine if this list should have an indexData
void	setCustomFilter(ResultsFilter filterIn) set the ListFilter object to use in filtering the data results
void	setFilter(boolean filterIn) Set if this list should have a filter box
void	setFilterColumn(java.lang.String fColumn) Set the column on which to filter
void	setFilterData(java.lang.String fData) set the data to filter for
void	setIndexData(boolean abar) Set if this list should have an indexData

Methods inherited from class java.lang.Object

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

Constructor Detail

ListControl

public ListControl()

Method Detail

hasIndex

public boolean hasIndex()

Determine if this list should have an indexData

Returns:

True if an indexData is desired

setIndexData

public void setIndexData(boolean abar)

Set if this list should have an indexData

Parameters:

abar - True if an indexData is desired

hasFilter

public boolean hasFilter()

Determine if this list should have a filter box

Returns:

True if filter box is desired

setFilter

public void setFilter(boolean filterIn)

Set if this list should have a filter box

Parameters:

filterIn - True if filtering is desired

getFilterColumn

public java.lang.String getFilterColumn()

Get the column on which to filter

Returns:

Returns the filterColumn.

setFilterColumn

public void setFilterColumn(java.lang.String fColumn)

Set the column on which to filter

Parameters:

fColumn - The column on which to filter.

getFilterData

public java.lang.String getFilterData()

Get the data to filter for

Returns:

Returns the filterData.

setFilterData

public void setFilterData(java.lang.String fData)

set the data to filter for

Parameters:

fData - The to filter for.

setCustomFilter

public void setCustomFilter(ResultsFilter filterIn)

set the ListFilter object to use in filtering the data results

Parameters:

filterIn - filter to use

createIndex

public java.util.Map<java.lang.Character,java.lang.Integer> createIndex(DataResult dr)

Create index on the DataResult dr

Parameters:

dr - DataResult to create index on

Returns:

Map<Character, Integer> containing index

filterData

public void filterData(DataResult dr)

Restrict the data that is in the list so that it matches the requested data. Uses customFilter for filtering if a ListFilter was provided

Parameters:

dr - DataResult to filter