|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.alfresco.web.ui.common.component.data.UIRichList
public class UIRichList
| Field Summary | |
|---|---|
protected java.util.Map |
viewRenderers
map of available IRichListRenderer instances |
| Fields inherited from interface org.alfresco.web.data.IDataContainer |
|---|
SORT_CASEINSENSITIVE, SORT_CASESENSITIVE |
| Constructor Summary | |
|---|---|
UIRichList()
Default constructor |
|
| Method Summary | |
|---|---|
void |
bind()
Method called to bind the RichList component state to the data model value |
void |
clearSort()
Clear the current sorting settings back to the defaults |
int |
getCurrentPage()
Return the current page the list is displaying |
java.lang.String |
getCurrentSortColumn()
Return the currently sorted column if any |
javax.faces.component.UIComponent |
getEmptyMessage()
Return the UI Component to be used as the "no items available" message |
java.lang.String |
getFamily()
|
java.lang.String |
getInitialSortColumn()
|
int |
getPageCount()
Return the count of max available pages |
int |
getPageSize()
Returns the current page size used for this list, or -1 for no paging. |
boolean |
getRefreshOnBind()
Get the refreshOnBind flag. |
java.lang.Object |
getValue()
Get the value (for this component the value is an object used as the DataModel) |
java.lang.String |
getViewMode()
Get the view mode for this Rich List |
IRichListRenderer |
getViewRenderer()
|
boolean |
isCurrentSortDescending()
Returns the current sort direction. |
boolean |
isDataAvailable()
Returns true if a row of data is available |
boolean |
isInitialSortDescending()
|
java.lang.Object |
nextRow()
Returns the next row of data from the data model |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setCurrentPage(int index)
Set the current page to display. |
void |
setInitialSortColumn(java.lang.String initialSortColumn)
|
void |
setInitialSortDescending(boolean initialSortDescending)
|
void |
setPageSize(int val)
Sets the current page size used for the list. |
void |
setRefreshOnBind(boolean refreshOnBind)
Set the refreshOnBind flag. |
void |
setValue(java.lang.Object value)
Set the value (for this component the value is an object used as the DataModel) |
void |
setViewMode(java.lang.String viewMode)
Set the current view mode for this Rich List |
void |
sort(java.lang.String column,
boolean descending,
java.lang.String mode)
Sort the dataset using the specified sort parameters |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final java.util.Map viewRenderers
| Constructor Detail |
|---|
public UIRichList()
| Method Detail |
|---|
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIComponentUIComponent.getFamily()
public void restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UIComponentBaseStateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class javax.faces.component.UIComponentBaseStateHolder.saveState(javax.faces.context.FacesContext)public java.lang.Object getValue()
public void setValue(java.lang.Object value)
value - the valuepublic void clearSort()
public java.lang.String getViewMode()
public void setViewMode(java.lang.String viewMode)
viewMode - the view mode as a Stringpublic boolean getRefreshOnBind()
public void setRefreshOnBind(boolean refreshOnBind)
refreshOnBind - the refreshOnBindpublic javax.faces.component.UIComponent getEmptyMessage()
public java.lang.String getCurrentSortColumn()
getCurrentSortColumn in interface IDataContainerpublic boolean isCurrentSortDescending()
IDataContainer
isCurrentSortDescending in interface IDataContainerIDataContainer.isCurrentSortDescending()public java.lang.String getInitialSortColumn()
public void setInitialSortColumn(java.lang.String initialSortColumn)
initialSortColumn - The initialSortColumn to set.public boolean isInitialSortDescending()
public void setInitialSortDescending(boolean initialSortDescending)
initialSortDescending - The initialSortDescending to set.public int getPageSize()
getPageSize in interface IDataContainerpublic void setPageSize(int val)
val - public int getPageCount()
IDataContainer
getPageCount in interface IDataContainerIDataContainer.getPageCount()public int getCurrentPage()
getCurrentPage in interface IDataContainerpublic void setCurrentPage(int index)
IDataContainer
setCurrentPage in interface IDataContainerindex - Zero based page index to displayIDataContainer.setCurrentPage(int)public boolean isDataAvailable()
isDataAvailable in interface IDataContainerpublic java.lang.Object nextRow()
nextRow in interface IDataContainer
public void sort(java.lang.String column,
boolean descending,
java.lang.String mode)
sort in interface IDataContainercolumn - Column to sortdescending - True for descending sort, false for ascendingmode - Sort mode to use (see IDataContainer constants)public void bind()
public IRichListRenderer getViewRenderer()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||