public class PortalContainerModel extends PageableTableContentProvider
SelectableListTableContentProvider.Row, SelectableListTableContentProvider.RowComparator
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_PAGE_SIZE |
protected String |
m_containerID |
protected boolean |
m_isAutoRefresh |
protected boolean |
m_needRefresh |
static String |
ROW_VARIABLE |
array, arraySet, list, listSet, pageRowIndex, refreshPageBinding, rowCache, rowCount, table, tableSet
m_autoIdCounter, m_map, m_originalList, m_selectableHelper
m_array, m_canTemplateRow, m_index, m_list, m_onCreateRow, m_onDeleteRow, m_rowId, m_rowType, m_sort, m_templateRow, m_var
fExpireWithPageFlow
Constructor and Description |
---|
PortalContainerModel() |
Modifier and Type | Method and Description |
---|---|
protected String |
calculateRowId(int index,
Object data)
Calculates row id from the row data object using
ListTableContentProvider.getRowIdBinding() expression. |
protected String |
calculateRowId(Object item) |
protected PortalItemModel |
createItemModel(IThingID thingID)
Create the model object for the requested thing
|
String |
getContainerID() |
PortalItemModel |
getItem() |
boolean |
getNeedRefresh()
Returns
true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from
the data source by executing IRefreshable.refresh() method. |
static IURI |
getURI(String id) |
boolean |
isAutoRefresh()
Returns false
|
protected void |
refreshPage()
Refreshes the associated page data provider.
|
void |
setAutoRefresh(boolean autoRefresh)
Sets auto refresh mode on.
|
void |
setContainerID(String containerID) |
void |
setNeedRefresh(boolean needRefresh)
Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any
output property is requested via
IContentProvider.getValue(Object) . |
String |
toString()
Returns string representation of content.
|
getArray, getList, getPageRowIndex, getRefreshPageBinding, getRefreshPageExpression, getRowCount, getTable, isRowAvailable, loadPageData, refresh, setArray, setList, setPageRowIndex, setRefreshPageBinding, setRefreshPageExpression, setRowCount, setTable
createRow, deleteRow, getCurrentRow, getRowId, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getSelectedRows, getUseUnselectedModel, isAddressable, isRowSelected, moveTo, setCurrentRow, setRowById, setRowSelected, setRowSelectedIds, setRowUnselectedIds, setRowVariable, setTemplateRow, sort, supportsAutoRefresh, updateOriginalList
getCanTemplateRow, getOnCreateRow, getOnCreateRowExpression, getOnDeleteRow, getOnDeleteRowExpression, getPropertyKeys, getRowIdBinding, getRowIdExpression, getRowIndex, getRowType, getRowVariable, getSort, getType, getValue, hasProperty, isReadOnly, isReorderable, isTemplateRow, newRow, setCanTemplateRow, setOnCreateRow, setOnCreateRowExpression, setOnDeleteRow, setOnDeleteRowExpression, setRowId, setRowIdBinding, setRowIdExpression, setRowIndex, setRowType, setSort, setValue
getExpireWithPageFlow, setExpireWithPageFlow
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getCurrentRow, getRowIndex, getRowVariable, setRowIndex, setRowVariable
getPropertyKeys, getType, getValue, hasProperty
public static final String ROW_VARIABLE
public static final int DEFAULT_PAGE_SIZE
protected boolean m_isAutoRefresh
protected boolean m_needRefresh
protected String m_containerID
public String getContainerID()
public void setContainerID(String containerID)
public PortalItemModel getItem()
protected String calculateRowId(Object item)
calculateRowId
in class ListTableContentProvider
item
- row data objectprotected String calculateRowId(int index, Object data)
ListTableContentProvider
ListTableContentProvider.getRowIdBinding()
expression.calculateRowId
in class ListTableContentProvider
index
- row indexdata
- row data objectpublic boolean getNeedRefresh()
IRefreshable
Returns true
when IRefreshable.isAutoRefresh()
is on and the result properties need to be refreshed from
the data source by executing IRefreshable.refresh()
method.
Implementations may return an accurate value from this method if they can track the changes to the input parameter
properties or they may require the clients to call IRefreshable.setNeedRefresh(boolean)
explicitely.
getNeedRefresh
in interface IRefreshable
getNeedRefresh
in class SelectableListTableContentProvider
true
when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh()
needs to be executed manually or automatically.public boolean isAutoRefresh()
SelectableListTableContentProvider
isAutoRefresh
in interface IRefreshable
isAutoRefresh
in class SelectableListTableContentProvider
public void setAutoRefresh(boolean autoRefresh) throws ContentProviderException
IRefreshable
Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh()
to determine whether the refresh needs to be done before returning any result properties. If it returns
true
, the provider calls IRefreshable.refresh()
method to updated the result properties.
setAutoRefresh
in interface IRefreshable
setAutoRefresh
in class SelectableListTableContentProvider
autoRefresh
- true to turn it onContentProviderException
- if autorefresh is trueIRefreshable.supportsAutoRefresh()
,
IRefreshable.getNeedRefresh()
,
IRefreshable.setNeedRefresh(boolean)
public void setNeedRefresh(boolean needRefresh)
IRefreshable
IContentProvider.getValue(Object)
.setNeedRefresh
in interface IRefreshable
setNeedRefresh
in class SelectableListTableContentProvider
needRefresh
- true
if the input parameters have changedprotected void refreshPage()
PageableTableContentProvider
PageableTableContentProvider.getRefreshPageBinding()
method
if not nullrefreshPage
in class PageableTableContentProvider
protected PortalItemModel createItemModel(IThingID thingID)
thingID
- the id of the itempublic static IURI getURI(String id) throws ContentProviderException
ContentProviderException
public String toString()
IContentProvider
toString
in interface IContentProvider
toString
in class ListTableContentProvider
String
representation of the wrapped content