public class OwObjectListViewRow extends OwObjectListViewPluginCache implements OwFieldProvider
Object list view. Displays the results of searches.
Use setObjectList and setColumnInfo to set the objects and columns to display.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
OwObjectListViewPluginCache.OwPluginStatus, OwObjectListViewPluginCache.OwPluginStatusCachingUtility
OwObjectListView.OwFilter, OwObjectListView.OwFilterEntry, OwObjectListView.OwHtmlAlignmentMap, OwObjectListView.OwIcon, OwObjectListView.OwObjectListViewEventListner, OwObjectListView.OwPluginEntry
Modifier and Type | Field and Description |
---|---|
protected Collection |
m_ColumnInfoList
Deprecated.
since 4.2.0.0 use set-/
OwPageableListView.getColumnInfo() instead |
protected int |
m_iCurrentPage
Deprecated.
since 4.2.0.0 use
OwPageableListView.getCurrentPage() |
protected OwMainAppContext |
m_MainContext
reference to the cast AppContext
|
protected Set<Integer> |
m_occuredObjectTypes
object types found during rendering
|
protected OwClientRefreshContext |
m_RefreshContext
Deprecated.
since 4.2.0.0 use set-/
OwPageableListView.getRefreshContext() instead |
protected OwSort |
m_Sort
Deprecated.
since 4.2.0.0 use set-/
OwPageableListView.getSort() instead |
protected OwFieldManager |
m_theFieldManager
Deprecated.
since 4.2.0.0 use set-/
OwPageableListView.getFieldManager() instead |
protected boolean |
m_useContextMenu
flag indicating if context menu should be shown
|
m_HtmlAlignments, m_isStickyFooterInUse, m_pageSelectorComponent, m_pagingNode, MULTISELECT_COMOBO_MENU_NAME, OBJECT_INDEX_KEY, PLUG_INDEX_KEY, QUERY_KEY_PAGE, SELECT_DESELECT_NONCONSECUTIVE_OBJECTS_ACTION_ID, SORT_PROPERTY_KEY, VIEW_MASK_INLINE_EDITING, VIEW_MASK_INSTANCE_PLUGINS, VIEW_MASK_MULTI_SELECTION, VIEW_MASK_NO_PAGE_BUTTONS, VIEW_MASK_SINGLE_SELECTION, VIEW_MASK_USE_DOCUMENT_PLUGINS, VIEW_MASK_USE_SELECT_BUTTON
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL
EMPTY_STRING
Constructor and Description |
---|
OwObjectListViewRow()
Construct a object list view.By default, try to use sticky footer.
|
OwObjectListViewRow(int iViewMask_p)
Construct a object list view.
|
Modifier and Type | Method and Description |
---|---|
protected int |
computeEndIndex()
Deprecated.
since 4.2.0.0 use
OwPageableListView.getDisplayedPage() for rendering |
protected int |
computeStartIndex()
Deprecated.
since 4.2.0.0 use
OwPageableListView.getDisplayedPage() for rendering |
protected OwMimeManager |
createMimeManager()
(overridable)
Factory method to create the MimeManager for this instance.
|
void |
detach()
remove view and all subviews from context
|
OwField |
getField(String strFieldClassName_p)
get a field with the given field definition class name
|
String |
getFieldProviderName()
get a name that identifies the field provider, e.g.
|
Object |
getFieldProviderSource()
get the source object that originally provided the fields.
|
int |
getFieldProviderType()
get the type of field provider can be one or more of TYPE_...
|
Collection |
getFields()
get all the properties in the form
|
protected String |
getHtmlAlignment(int iAlignment_p)
method to retrieve HTML alignment attributes out of OwFieldColumnInfo alignment
|
String |
getIcon()
get the icon URL for this view to be displayed
|
boolean |
getIsList()
same as getIsListValid() && ( getCount() != 0 )
|
boolean |
getIsListEmpty()
Deprecated.
since 4.2.0.0 use
OwObjectListView.getCount() instead |
boolean |
getIsListValid()
check if list is configured well and can be displayed
|
boolean |
getIsPaging()
Deprecated.
since 4.2.0.0 use
OwObjectListView.hasPaging() instead |
OwMimeManager |
getMimeManager()
Get current OwMimeManager instance
|
String |
getPageAbsolutURL(int iPage_p)
Deprecated.
since 4.2.0.0 use
OwPageableListView.getPageAbsolutEventURL(String) |
String |
getPageNextURL()
Deprecated.
since 4.2.0.0 use
OwPageableListView.getPageNextEventURL() |
String |
getPagePrevURL()
Deprecated.
since 4.2.0.0 use
OwPageableListView.getPagePrevEventURL() |
Collection |
getRetrievalPropertyNames()
get a collection of property names that are needed to display the Objects in the list
i.e.
|
protected String |
getRowClassName(int iIndex_p,
OwObject obj_p)
overridable get the style class name for the row
|
Object |
getSafeFieldValue(String sName_p,
Object defaultvalue_p)
retrieve the value of a Field
|
protected String |
getSelectedRowClassName(int iIndex_p,
OwObject obj_p)
overridable get the style class name for the row
|
protected String |
getSortOrderImage(String strProperty_p)
gets the path to the sort order image, which designates the current sort order of the specified column
|
protected String |
getSortOrderType(String strProperty_p) |
String |
getTitle()
overridable title of the view
|
protected void |
init()
init the view after the context is set.
|
protected void |
insertDocumentFunctionPluginHeader(Writer w_p,
Collection<OwObjectListView.OwPluginEntry> instancePluginsList_p) |
protected void |
insertDocumentFunctionPluginRows(Writer w_p,
OwObject obj_p,
int iIndex_p,
Collection instancePluginsList_p)
insert the document function plugins for the requested row index and object
|
protected boolean |
isPagingEnabled()
check if paging is enabled
|
void |
onAjaxPersistSelection(javax.servlet.http.HttpServletRequest request_p,
javax.servlet.http.HttpServletResponse response_p)
Called upon AJAX request "PersistSelection"
|
void |
onColumnClickEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked on a plugin column
|
void |
onContextMenuEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked on a plugin link on the context menu
|
void |
onMultiSelectEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user submitted the mulitiselect form
|
void |
onPluginEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked on a plugin link of an object entry in the list
|
protected void |
onRender(Writer w_p)
render the view
|
void |
onSelect(javax.servlet.http.HttpServletRequest request_p)
event called when user selected an item
|
void |
onSort(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked a sort header
|
protected void |
renderCheckedOut(StringWriter rowBuffer,
OwObject obj) |
protected void |
renderExtraColumnHeader(Writer w_p)
overridable to render additional columns
|
protected void |
renderExtraColumnRows(Writer w_p,
OwObject obj_p,
int iIndex_p)
overridable to render additional columns
|
protected void |
renderIndex(StringWriter rowBuffer,
int i) |
protected void |
renderIndexHeader(Writer w_p) |
protected void |
renderLockedColumn(Writer w_p,
OwObject obj_p)
Render lock column.
|
protected void |
renderMainRegion(Writer w_p)
render the view JSP
|
protected void |
renderMimeType(StringWriter rowBuffer,
OwObject obj) |
protected void |
renderMimeTypeHeader(Writer w_p) |
void |
renderPageSelector(Writer w_p)
Render the page selector
|
protected void |
renderProperties(StringWriter rowBuffer,
OwObject obj) |
protected void |
renderPropertiesHeader(Writer w_p) |
protected void |
renderPropertyColumnHeader(Writer w_p,
OwFieldColumnInfo colInfo_p)
(overridable) render the property sort column
|
void |
renderRows(Writer w_p,
Collection<OwObjectListView.OwPluginEntry> instancePluginsList_p)
render the header portion of the object list
|
void |
renderSortHeader(Writer w_p,
Collection<OwObjectListView.OwPluginEntry> instancePluginsList_p)
render the header portion of the object list
|
void |
renderTableCaption(Writer w_p) |
protected void |
renderVersion(StringWriter rowBuffer,
OwObject obj) |
protected void |
renderVersionHeader(Writer w_p) |
void |
setField(String sName_p,
Object value_p)
modify a Field value, but does not save the value right away
|
void |
setMimeTypeContext(String context_p)
Set the context to be used for MIME type resolution
|
void |
setObjectIterable(OwIterable<OwObject> iterable,
OwObject parentObject_p)
set a pageable interface for retrieval of items to display.
|
void |
setObjectList(OwObjectCollection objectList_p,
OwObject parentObject_p)
set the list of objects to be displayed by this list view
|
void |
setRefreshContext(OwClientRefreshContext eventlister_p)
register an event listener with this view to receive notifications
|
boolean |
updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
boolean fSave_p)
update the target after a form event, so it can set its form fields
|
protected String |
usesFormWithAttributes()
to get additional form attributes used for the form
override if your view needs a form.
|
createPluginStatusCacheUtility, createPluginStatusCacheUtility, createPluginStatusCacheUtility, createPluginStatusCacheUtility, getPluginCache, setPluginCache
canPageNext, canPagePrev, getColumnInfo, getCurrentPage, getDisplayedPage, getFieldManager, getObjectIterable, getObjectList, getPageAbsolutEventURL, getPageCount, getPageNextEventURL, getPagePrevEventURL, getPageSize, getRefreshContext, getSort, isCollectionComplete, onClientRefreshContextUpdate, onPageAbsolut, onPageNext, onPagePrev, pageAbsolut, setColumnInfo, setFieldManager, setSort
addAjaxPersistenceService, addViewMask, clearViewMask, copy, createFilter, createFilter, createFilter, createPageSelector, getContextMenuFunction, getCount, getDocumentFunction, getDocumentFunctionPluginList, getEventListner, getFilter, getFilterOperators, getFilterSearch, getListViewID, getObjectByIndex, getParentObject, getPluginEntries, hasPaging, hasViewMask, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isShowMaximized, isStickyFooterInUse, persistAjaxTriggeredSelection, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, setConfigNode, setCurrentPage, setDocumentFunctionPluginList, setEventListner, setFilter, setParentObject, setRenderEmptyPluginColumn, setStickyFooterInUse, setViewMask
activate, addView, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getContext
getBreadcrumbPart, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion
protected OwMainAppContext m_MainContext
protected int m_iCurrentPage
OwPageableListView.getCurrentPage()
protected OwSort m_Sort
OwPageableListView.getSort()
insteadprotected boolean m_useContextMenu
protected Collection m_ColumnInfoList
OwPageableListView.getColumnInfo()
insteadprotected OwFieldManager m_theFieldManager
OwPageableListView.getFieldManager()
insteadprotected OwClientRefreshContext m_RefreshContext
OwPageableListView.getRefreshContext()
insteadpublic OwObjectListViewRow(int iViewMask_p)
iViewMask_p
- int combination of VIEW_MASK_... defined flagspublic OwObjectListViewRow()
protected OwMimeManager createMimeManager()
public void setMimeTypeContext(String context_p)
context_p
- the context to be used for MIME type resolution, can be null
protected String getHtmlAlignment(int iAlignment_p)
iAlignment_p
- int alignment as defined in OwFieldColumnInfopublic void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) throws Exception
setObjectList
in class OwPageableListView
objectList_p
- OwObjectCollectionparentObject_p
- OwObject parent which created the object list, can be null if no parent is specifiedException
public void setObjectIterable(OwIterable<OwObject> iterable, OwObject parentObject_p) throws Exception
OwObjectListView
setObjectIterable
in class OwPageableListView
iterable
- OwIterable returning OwObjectsparentObject_p
- OwObjectException
protected String usesFormWithAttributes()
usesFormWithAttributes
in class OwView
protected boolean isPagingEnabled()
isPagingEnabled
in class OwPageableListView
OwObjectListView.hasPaging()
public void setRefreshContext(OwClientRefreshContext eventlister_p)
OwObjectListView
setRefreshContext
in class OwPageableListView
eventlister_p
- OwClientRefreshContext interfaceprotected void init() throws Exception
init
in class OwObjectListView
Exception
public void detach()
detach
in class OwPageableListView
protected String getSortOrderType(String strProperty_p) throws Exception
strProperty_p
- Exception
protected String getSortOrderImage(String strProperty_p) throws Exception
strProperty_p
- columnException
protected void renderExtraColumnHeader(Writer w_p) throws Exception
Exception
protected void renderExtraColumnRows(Writer w_p, OwObject obj_p, int iIndex_p) throws Exception
Exception
protected void renderLockedColumn(Writer w_p, OwObject obj_p) throws Exception, IOException
w_p
- Writer to be used for renderingobj_p
- OwObject which should be checkedException
- If OwObject.getLock(int)
failIOException
- if can not use writerpublic void renderSortHeader(Writer w_p, Collection<OwObjectListView.OwPluginEntry> instancePluginsList_p) throws Exception
w_p
- Writer object to write HTML toinstancePluginsList_p
- Collection of plugins that are displayed for each instanceException
protected void renderPropertiesHeader(Writer w_p) throws IOException, Exception
w_p
- IOException
Exception
protected void renderVersionHeader(Writer w_p) throws IOException
w_p
- IOException
protected void renderMimeTypeHeader(Writer w_p) throws IOException
w_p
- IOException
protected void insertDocumentFunctionPluginHeader(Writer w_p, Collection<OwObjectListView.OwPluginEntry> instancePluginsList_p) throws IOException, Exception
w_p
- instancePluginsList_p
- IOException
Exception
protected void renderIndexHeader(Writer w_p) throws IOException, Exception
w_p
- IOException
Exception
protected void renderPropertyColumnHeader(Writer w_p, OwFieldColumnInfo colInfo_p) throws Exception
w_p
- java.io.WritercolInfo_p
- OwFieldColumnInfoException
protected String getRowClassName(int iIndex_p, OwObject obj_p)
iIndex_p
- int row indexobj_p
- current OwObjectprotected String getSelectedRowClassName(int iIndex_p, OwObject obj_p)
iIndex_p
- int row indexobj_p
- current OwObject@Deprecated protected int computeStartIndex()
OwPageableListView.getDisplayedPage()
for rendering@Deprecated protected int computeEndIndex()
OwPageableListView.getDisplayedPage()
for renderingpublic void renderRows(Writer w_p, Collection<OwObjectListView.OwPluginEntry> instancePluginsList_p) throws Exception
w_p
- Writer object to write HTML toinstancePluginsList_p
- Collection of plugins that are displayed for each instanceException
protected void renderProperties(StringWriter rowBuffer, OwObject obj) throws Exception
rowBuffer
- obj
- Exception
protected void renderMimeType(StringWriter rowBuffer, OwObject obj) throws Exception
rowBuffer
- obj
- Exception
protected void renderVersion(StringWriter rowBuffer, OwObject obj) throws Exception
rowBuffer
- output bufferobj
- Exception
protected void renderCheckedOut(StringWriter rowBuffer, OwObject obj) throws Exception
rowBuffer
- obj
- Exception
protected void renderIndex(StringWriter rowBuffer, int i)
rowBuffer
- output bufferi
- row indexpublic boolean getIsList()
public boolean getIsListValid()
@Deprecated public boolean getIsListEmpty()
OwObjectListView.getCount()
instead@Deprecated public boolean getIsPaging()
OwObjectListView.hasPaging()
insteadpublic void onAjaxPersistSelection(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) throws Exception
request_p
- response_p
- Exception
protected void renderMainRegion(Writer w_p) throws Exception
w_p
- Writer object to write HTML toException
protected void insertDocumentFunctionPluginRows(Writer w_p, OwObject obj_p, int iIndex_p, Collection instancePluginsList_p) throws Exception
w_p
- writer object for HTML outputobj_p
- OwObject to create Function plugin foriIndex_p
- the row / object indexinstancePluginsList_p
- Collection of plugins that are visible (have there own column) together with the global indexException
public void onSort(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onContextMenuEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onColumnClickEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onMultiSelectEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onPluginEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public void onSelect(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequestException
public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p, boolean fSave_p) throws Exception
updateExternalFormTarget
in class OwEventTarget
request_p
- HttpServletRequestfSave_p
- boolean true = save the changes of the form data, false = just update the form data, but do not saveException
public Collection getRetrievalPropertyNames() throws Exception
getRetrievalPropertyNames
in class OwPageableListView
Exception
public OwField getField(String strFieldClassName_p) throws Exception, OwObjectNotFoundException
OwFieldProvider
getField
in interface OwFieldProvider
strFieldClassName_p
- String class name of requested fieldsException
OwObjectNotFoundException
public int getFieldProviderType()
OwFieldProvider
getFieldProviderType
in interface OwFieldProvider
public Object getFieldProviderSource()
OwFieldProvider
getFieldProviderSource
in interface OwFieldProvider
public String getFieldProviderName()
OwFieldProvider
getFieldProviderName
in interface OwFieldProvider
public void setField(String sName_p, Object value_p) throws Exception, OwObjectNotFoundException
setField
in interface OwFieldProvider
sName_p
- value_p
- Exception
OwObjectNotFoundException
public Object getSafeFieldValue(String sName_p, Object defaultvalue_p)
getSafeFieldValue
in interface OwFieldProvider
sName_p
- defaultvalue_p
- public Collection getFields() throws Exception
getFields
in interface OwFieldProvider
Exception
public String getTitle()
getTitle
in interface OwBaseView
getTitle
in class OwView
public OwMimeManager getMimeManager()
public void renderPageSelector(Writer w_p) throws Exception
w_p
- Exception
@Deprecated public String getPagePrevURL()
OwPageableListView.getPagePrevEventURL()
@Deprecated public String getPageNextURL()
OwPageableListView.getPageNextEventURL()
@Deprecated public String getPageAbsolutURL(int iPage_p)
OwPageableListView.getPageAbsolutEventURL(String)
iPage_p
- int pageCopyright © 2014 Alfresco Business Solutions. All Rights Reserved.