|
||||||||||
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.OwObjectListViewCombined
public class OwObjectListViewCombined
List View: OwObject List View Combined.
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 | |
---|---|
protected class |
OwObjectListViewCombined.OwObjectListViewRowCombined
|
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 ArrayList |
m_SubViews
|
protected static String |
QUERY_KEY_PAGE_COMBINED
query string key for the page index. |
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.ui.OwBaseView |
---|
EMPTY_STRING |
Constructor Summary | |
---|---|
OwObjectListViewCombined()
construct a object list view |
|
OwObjectListViewCombined(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 |
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() |
OwFieldManager |
getFieldManager()
get the internal fieldmanager |
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 |
OwObjectCollection |
getObjectList()
get the current object list |
int |
getPageCount()
retrieve number of available pages |
OwObject |
getParentObject()
get the parent object |
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. |
OwSort |
getSort()
get the current selected sort instance |
String |
getTitle()
overridable title of the view |
protected void |
init()
Initialize the view after the context is set. |
protected boolean |
isPagingEnabled()
check if paging is enabled |
boolean |
isShowMaximized()
checks if the view is shown maximized |
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 |
protected void |
onRender(Writer w_p)
called when the view should create its HTML content to be displayed |
protected void |
pageAbsolut(int iPage_p)
Move to the given zero based absolute page. |
protected void |
renderCombinedPageButtons(Writer w_p)
render the paging buttons for the combined view |
void |
setColumnInfo(Collection columnInfo_p)
set the list of column info to be used by this list view |
void |
setConfigNode(Node node_p)
optional use the default constructor and set a config node to configure the view with XML This may override the settings in the ViewMaks, see setViewMask |
void |
setDocumentFunctionPluginList(List pluginList_p)
Set a java.util.List of OwDocumentFunction to be used by this
list. |
void |
setEventListner(OwObjectListView.OwObjectListViewEventListner eventlister_p)
Register an eventlistener with this view to receive notifications. |
void |
setFieldManager(OwFieldManager fielmanager_p)
set the internal fieldmanager in case you want a specific fieldmanager |
void |
setObjectList(OwObjectCollection objectList_p,
OwObject parentObject_p)
set the list of objects to be displayed by this list view |
void |
setRefreshContext(OwClientRefreshContext eventlistner_p)
register an eventlistener with this view to receive notifications |
void |
setSort(OwSort sort_p)
set / override current sort to given sort |
Methods inherited from class com.wewebu.ow.server.ui.OwView |
---|
activate, addView, detach, 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, usesFormWithAttributes |
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget |
---|
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget |
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 ArrayList m_SubViews
protected Collection m_ColumnInfoList
protected static final String QUERY_KEY_PAGE_COMBINED
Constructor Detail |
---|
public OwObjectListViewCombined(int iViewMask_p)
iViewMask_p
- int combination of VIEW_MASK_... defined flagspublic OwObjectListViewCombined()
Method Detail |
---|
public void setConfigNode(Node node_p) throws Exception
setConfigNode
in class OwObjectListView
node_p
- XML node with configuration information
Exception
protected void init() throws Exception
init
in class OwObjectListView
Exception
public void setDocumentFunctionPluginList(List pluginList_p)
java.util.List
of OwDocumentFunction
to be used by this
list. This list overrides the default set of document functions that are retrieved from
the context during init.
setDocumentFunctionPluginList
in class OwObjectListView
pluginList_p
- the java.util.List
of OwDocumentFunction
to be used by this list. Must not be null
.protected void onRender(Writer w_p) throws Exception
onRender
in class OwView
w_p
- Writer object to write HTML to
Exception
public boolean isShowMaximized()
isShowMaximized
in class OwView
protected boolean isPagingEnabled()
isPagingEnabled
in class OwObjectListView
public boolean getIsList()
public boolean getIsListValid()
public boolean getIsListEmpty()
public boolean getIsPaging()
protected void renderCombinedPageButtons(Writer w_p) throws Exception
w_p
- Writer object to write HTML to
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 int getPageCount() throws Exception
OwObjectListView
getPageCount
in interface OwPageableView
getPageCount
in class OwObjectListView
Exception
public int getCurrentPage()
OwObjectListView
getCurrentPage
in interface OwPageableView
getCurrentPage
in class OwObjectListView
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 Collection getColumnInfo()
OwObjectListView
getColumnInfo
in class OwObjectListView
public int getCount()
OwObjectListView
getCount
in interface OwPageableView
getCount
in class OwObjectListView
public OwFieldManager getFieldManager()
OwObjectListView
getFieldManager
in class OwObjectListView
public void setFieldManager(OwFieldManager fielmanager_p)
setFieldManager
in class OwObjectListView
public OwObjectCollection getObjectList()
OwObjectListView
getObjectList
in class OwObjectListView
public OwObject getParentObject()
OwObjectListView
getParentObject
in class OwObjectListView
public Collection getRetrievalPropertyNames() throws Exception
OwObjectListView
getRetrievalPropertyNames
in class OwObjectListView
Exception
public OwSort getSort()
OwObjectListView
getSort
in class OwObjectListView
protected OwClientRefreshContext getRefreshContext()
OwObjectListView
getRefreshContext
in class OwObjectListView
protected void pageAbsolut(int iPage_p) throws Exception
OwObjectListView
pageAbsolut
in class OwObjectListView
iPage_p
- int zero based page number
Exception
public void setColumnInfo(Collection columnInfo_p)
OwObjectListView
setColumnInfo
in class OwObjectListView
columnInfo_p
- List of OwFieldColumnInfo'spublic void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) throws Exception
OwObjectListView
setObjectList
in class OwObjectListView
objectList_p
- OwObjectCollectionparentObject_p
- OwObject parent which created the object list, can be null if no parent is specified
Exception
public void setRefreshContext(OwClientRefreshContext eventlistner_p)
OwObjectListView
setRefreshContext
in class OwObjectListView
eventlistner_p
- OwClientRefreshContext interfacepublic void setSort(OwSort sort_p)
OwObjectListView
setSort
in class OwObjectListView
sort_p
- new OwSortpublic String getTitle()
getTitle
in interface OwBaseView
getTitle
in class OwView
public String getIcon() throws Exception
getIcon
in class OwView
Exception
public void setEventListner(OwObjectListView.OwObjectListViewEventListner eventlister_p)
setEventListner
in class OwObjectListView
eventlister_p
- OwObjectListCollectionEventListner interfacepublic void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p) throws Exception
OwPageableView
onPageAbsolut
in interface OwPageableView
onPageAbsolut
in class OwObjectListView
Exception
OwObjectListView.onPageAbsolut(javax.servlet.http.HttpServletRequest)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |