|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wewebu.ow.server.ui.OwEventTarget
com.wewebu.ow.server.ui.OwView
com.wewebu.ow.server.dmsdialogs.views.OwObjectListView
com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewPluginCache
com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewRow
public class OwObjectListViewRow
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
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewPluginCache |
---|
OwObjectListViewPluginCache.OwPluginStatus, OwObjectListViewPluginCache.OwPluginStatusCachingUtility |
Nested classes/interfaces inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView |
---|
OwObjectListView.OwFilter, OwObjectListView.OwFilterEntry, OwObjectListView.OwHtmlAlignmentMap, OwObjectListView.OwIcon, OwObjectListView.OwObjectListViewEventListner, OwObjectListView.OwPluginEntry |
Field Summary | |
---|---|
protected Collection |
m_ColumnInfoList
a list of column info, which describe the columns of the object list |
protected int |
m_iCurrentPage
current zero based page number in multiples of getPageSize() for paging the results |
protected OwMainAppContext |
m_MainContext
reference to the cast AppContext |
protected Set |
m_occuredObjectTypes
object types found during rendering |
protected OwClientRefreshContext |
m_RefreshContext
event listener for the function plugin refresh events |
protected OwSort |
m_Sort
the list with the sort criteria |
protected OwFieldManager |
m_theFieldManager
instance of the property field class |
protected boolean |
m_useContextMenu
flag indicating if context menu should be shown |
Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView |
---|
m_HtmlAlignments, m_isStickyFooterInUse, m_pageSelectorComponent, m_pagingNode, MULTISELECT_COMOBO_MENU_NAME, OBJECT_INDEX_KEY, PLUG_INDEX_KEY, QUERY_KEY_PAGE, 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 |
Fields inherited from class com.wewebu.ow.server.ui.OwView |
---|
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget |
Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider |
---|
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL |
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView |
---|
EMPTY_STRING |
Constructor Summary | |
---|---|
OwObjectListViewRow()
Construct a object list view.By default, try to use sticky footer. |
|
OwObjectListViewRow(int iViewMask_p)
Construct a object list view. |
Method Summary | |
---|---|
boolean |
canPageNext()
check if there is a next page |
boolean |
canPagePrev()
check if there is a previous page |
protected int |
computeEndIndex()
Compute the end index, the index for the last displayed object, when paging is used. |
protected int |
computeStartIndex()
Compute the start index, the index for the first object displayed in the list, when paging is used. |
protected OwMimeManager |
createMimeManager()
overridable factory method to create the MimeManager |
void |
detach()
remove view and all subviews from context |
Collection |
getColumnInfo()
get the list of column info to be used by this list view |
int |
getCount()
get number of items in the list |
int |
getCurrentPage()
get current zero based page number in multiples of getPageSize() |
OwField |
getField(String strFieldClassName_p)
get a field with the given field definition class name |
OwFieldManager |
getFieldManager()
get the internal fieldmanager |
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() && ( ! getIsListEmpty() ) |
boolean |
getIsListEmpty()
check if list contains any items |
boolean |
getIsListValid()
check if list is configured well and can be displayed |
boolean |
getIsPaging()
check if page buttons should be rendered |
OwMimeManager |
getMimeManager()
Get current OwMimeManager instance |
OwObjectCollection |
getObjectList()
get the current object list |
String |
getPageAbsolutURL(int iPage_p)
|
int |
getPageCount()
retrieve number of available pages |
String |
getPageNextURL()
|
String |
getPagePrevURL()
|
int |
getPageSize()
number of items in a page for lists which support paging |
protected OwClientRefreshContext |
getRefreshContext()
get an eventlistener with this view to receive notifications |
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 |
OwSort |
getSort()
get the current selected sort instance |
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 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 |
onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
display absolute page of objects |
void |
onPageNext(javax.servlet.http.HttpServletRequest request_p)
display next page of objects |
void |
onPagePrev(javax.servlet.http.HttpServletRequest request_p)
display previous page of objects |
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 |
pageAbsolut(int iPage_p)
move to the given zero based absolute page |
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 instancePluginsList_p)
render the header portion of the object list |
void |
renderSortHeader(Writer w_p,
Collection 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 |
setColumnInfo(Collection columnInfo_p)
set the list of column info to be used by this list view |
void |
setField(String sName_p,
Object value_p)
modify a Field value, but does not save the value right away |
void |
setFieldManager(OwFieldManager fielmanager_p)
set the internal fieldmanager in case you want a specific fieldmanager |
void |
setMimeTypeContext(String context_p)
Set the context to be used for MIME type resolution |
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 eventlistener with this view to receive notifications |
void |
setSort(OwSort sort_p)
set / override current sort to given sort |
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. |
Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewPluginCache |
---|
createPluginStatusCacheUtility, createPluginStatusCacheUtility, getPluginCache, setPluginCache |
Methods inherited from class com.wewebu.ow.server.ui.OwView |
---|
activate, addView, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal |
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget |
---|
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.wewebu.ow.server.dmsdialogs.views.OwPageableView |
---|
getContext |
Methods inherited from interface com.wewebu.ow.server.ui.OwBaseView |
---|
getBreadcrumbPart, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion |
Field Detail |
---|
protected OwMainAppContext m_MainContext
protected int m_iCurrentPage
protected OwSort m_Sort
protected boolean m_useContextMenu
protected Collection m_ColumnInfoList
protected OwFieldManager m_theFieldManager
protected OwClientRefreshContext m_RefreshContext
protected Set m_occuredObjectTypes
Constructor Detail |
---|
public OwObjectListViewRow(int iViewMask_p)
iViewMask_p
- int combination of VIEW_MASK_... defined flagspublic OwObjectListViewRow()
Method Detail |
---|
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 OwFieldColumnInfo
public void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) throws Exception
setObjectList
in class OwObjectListView
objectList_p
- OwObjectCollectionparentObject_p
- OwObject parent which created the object list, can be null if no parent is specified
Exception
protected String usesFormWithAttributes()
usesFormWithAttributes
in class OwView
public OwObjectCollection getObjectList()
getObjectList
in class OwObjectListView
protected boolean isPagingEnabled()
isPagingEnabled
in class OwObjectListView
public int getPageCount() throws Exception
getPageCount
in interface OwPageableView
getPageCount
in class OwObjectListView
Exception
public int getCurrentPage()
getCurrentPage
in interface OwPageableView
getCurrentPage
in class OwObjectListView
public void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p) throws Exception
onPageAbsolut
in interface OwPageableView
onPageAbsolut
in class OwObjectListView
Exception
OwPageableView.onPageAbsolut(javax.servlet.http.HttpServletRequest)
protected void pageAbsolut(int iPage_p) throws Exception
pageAbsolut
in class OwObjectListView
iPage_p
- int zero based page number in multiples of getPageSize()
Exception
public void onPageNext(javax.servlet.http.HttpServletRequest request_p) throws Exception
onPageNext
in interface OwPageableView
onPageNext
in class OwObjectListView
Exception
OwPageableView.onPageNext(javax.servlet.http.HttpServletRequest)
public void onPagePrev(javax.servlet.http.HttpServletRequest request_p) throws Exception
onPagePrev
in interface OwPageableView
onPagePrev
in class OwObjectListView
Exception
OwPageableView.onPagePrev(javax.servlet.http.HttpServletRequest)
public boolean canPagePrev()
canPagePrev
in interface OwPageableView
canPagePrev
in class OwObjectListView
public boolean canPageNext() throws Exception
canPageNext
in interface OwPageableView
canPageNext
in class OwObjectListView
Exception
public String getPagePrevURL()
public String getPageNextURL()
public String getPageAbsolutURL(int iPage_p)
public OwFieldManager getFieldManager()
getFieldManager
in class OwObjectListView
public void setFieldManager(OwFieldManager fielmanager_p)
setFieldManager
in class OwObjectListView
public void setRefreshContext(OwClientRefreshContext eventlister_p)
setRefreshContext
in class OwObjectListView
eventlister_p
- OwClientRefreshContext interfaceprotected OwClientRefreshContext getRefreshContext()
getRefreshContext
in class OwObjectListView
public int getCount()
getCount
in interface OwPageableView
getCount
in class OwObjectListView
public void setColumnInfo(Collection columnInfo_p)
setColumnInfo
in class OwObjectListView
columnInfo_p
- List of OwFieldColumnInfo'spublic Collection getColumnInfo()
getColumnInfo
in class OwObjectListView
protected void init() throws Exception
init
in class OwObjectListView
Exception
public void setSort(OwSort sort_p)
setSort
in class OwObjectListView
sort_p
- new OwSortpublic OwSort getSort()
getSort
in class OwObjectListView
public void detach()
detach
in class OwView
protected String getSortOrderType(String strProperty_p) throws Exception
strProperty_p
-
Exception
protected String getSortOrderImage(String strProperty_p) throws Exception
strProperty_p
- column
Exception
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 checked
Exception
- If OwObject.getLock(int)
fail
IOException
- if can not use writerpublic void renderTableCaption(Writer w_p) throws Exception
Exception
public void renderSortHeader(Writer w_p, Collection instancePluginsList_p) throws Exception
w_p
- Writer object to write HTML toinstancePluginsList_p
- Collection of plugins that are displayed for each instance
Exception
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 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
- OwFieldColumnInfo
Exception
protected String getRowClassName(int iIndex_p, OwObject obj_p)
iIndex_p
- int row indexobj_p
- current OwObject
protected String getSelectedRowClassName(int iIndex_p, OwObject obj_p)
iIndex_p
- int row indexobj_p
- current OwObject
protected int computeStartIndex()
protected int computeEndIndex()
public void renderRows(Writer w_p, Collection instancePluginsList_p) throws Exception
w_p
- Writer object to write HTML toinstancePluginsList_p
- Collection of plugins that are displayed for each instance
Exception
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()
public boolean getIsListEmpty()
public boolean getIsPaging()
protected void onRender(Writer w_p) throws Exception
onRender
in class OwView
w_p
- Writer object to write HTML to
Exception
public 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 to
Exception
public int getPageSize()
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 index
Exception
public void onSort(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onContextMenuEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onColumnClickEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onMultiSelectEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onPluginEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onSelect(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
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 save
Exception
public Collection getRetrievalPropertyNames() throws Exception
getRetrievalPropertyNames
in class OwObjectListView
Exception
public OwField getField(String strFieldClassName_p) throws Exception, OwObjectNotFoundException
OwFieldProvider
getField
in interface OwFieldProvider
strFieldClassName_p
- String class name of requested fields
Exception
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 String getIcon() throws Exception
getIcon
in class OwView
Exception
public OwMimeManager getMimeManager()
public void renderPageSelector(Writer w_p) throws Exception
w_p
-
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |