Package org.apache.empire.jsf2.pageelements

Class ListPageElement<T>

java.lang.Object

org.apache.empire.jsf2.pages.PageElement<Page>

org.apache.empire.jsf2.pageelements.ListPageElement<T>

Direct Known Subclasses:

BeanListPageElement, StaticListPageElement

public abstract class ListPageElement<T>
extends PageElement<Page>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListPageElement.ListTableInfo	This class holds information about the list view to display.
static interface	ListPageElement.ParameterizedItem	Interface to uniquely identify a list item This will be used for selection and navigation
static class	ListPageElement.SelectableItem	Abstract superclass to make a list item selectable
static class	ListPageElement.SelectionSet	SelectionSet Contains the key of all items implementing "SelectableItem"

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<T>	beanClass
protected List<T>	items
protected ListPageElement.SelectionSet	selectedItemKeys

Fields inherited from class org.apache.empire.jsf2.pages.PageElement

page

Constructor Summary

Constructors

Constructor	Description
ListPageElement(Page page, Class<T> beanClass, String propertyName)

Method Summary

Modifier and Type	Method	Description
void	clearItems()
void	clearSelection()	Selection
int	getItemCount()	returns the total item count of the entire list (not just the visible part)
List<T>	getItems()
int	getSelectedItemCount()
Set<Object[]>	getSelectedItemKeys()
List<T>	getSelectedItems()
abstract ListPageElement.ListTableInfo	getTableInfo()
final boolean	isBlank()	added as "isEmpty" is not accessible from EL.
final boolean	isEmpty()	returns true if the either the item list is not valid or if it contains no items
boolean	isHasSelection()
boolean	isInvertSelection()
final boolean	isNotEmpty()	returns whether the item list is valid and contains at least one item
boolean	isSingleSelection()
final boolean	isValid()	returns whether the item list has been loaded
void	setInvertSelection(boolean invertSelection)
void	setSelectedItems(Set<Object[]> items)
void	setSelection(ListPageElement.SelectableItem item)
void	setSelection(ListPageElement.SelectableItem[] items)
void	setSingleSelection(boolean singleSelection)

Methods inherited from class org.apache.empire.jsf2.pages.PageElement

getDefaultPropertyName, getPage, getPropertyName, getSessionObject, onInitPage, onRefreshPage, removeSessionObject, setSessionObject

Methods inherited from class java.lang.Object

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

Field Details

beanClass

protected Class<T> beanClass

items

protected List<T> items

selectedItemKeys

protected ListPageElement.SelectionSet selectedItemKeys

Constructor Details

ListPageElement

public ListPageElement(Page page,
 Class<T> beanClass,
 String propertyName)

Method Details

getTableInfo

public abstract ListPageElement.ListTableInfo getTableInfo()

getItems

public List<T> getItems()

isValid

public final boolean isValid()

returns whether the item list has been loaded

Returns:

true if the item list has been loaded even it contains no items for false otherwise

isEmpty

public final boolean isEmpty()

returns true if the either the item list is not valid or if it contains no items

Returns:

true if the either the item list is not valid or if it contains no items

isNotEmpty

public final boolean isNotEmpty()

returns whether the item list is valid and contains at least one item

Returns:

true if the item list contains one or more items or false otherwise

isBlank

public final boolean isBlank()

added as "isEmpty" is not accessible from EL.

Returns:

true if the either the item list is not valid or if it contains no items

getItemCount

public int getItemCount()

returns the total item count of the entire list (not just the visible part)

Returns:

the total number of items in the list

clearItems

public void clearItems()

clearSelection

public void clearSelection()

Selection

isHasSelection

public boolean isHasSelection()

getSelectedItemCount

public int getSelectedItemCount()

getSelectedItems

public List<T> getSelectedItems()

getSelectedItemKeys

public Set<Object[]> getSelectedItemKeys()

setSelectedItems

public void setSelectedItems(Set<Object[]> items)

isInvertSelection

public boolean isInvertSelection()

setInvertSelection

public void setInvertSelection(boolean invertSelection)

isSingleSelection

public boolean isSingleSelection()

setSingleSelection

public void setSingleSelection(boolean singleSelection)

setSelection

public void setSelection(ListPageElement.SelectableItem item)

setSelection

public void setSelection(ListPageElement.SelectableItem[] items)