public class OwObjectListViewCombined extends OwPageableListView
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
OwObjectListView.OwFilter, OwObjectListView.OwFilterEntry, OwObjectListView.OwHtmlAlignmentMap, OwObjectListView.OwIcon, OwObjectListView.OwObjectListViewEventListner, OwObjectListView.OwPluginEntry
Modifier and Type | Field and Description |
---|---|
protected static String |
QUERY_KEY_PAGE_COMBINED
query string key for the page index.
|
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
EMPTY_STRING
Constructor and Description |
---|
OwObjectListViewCombined() |
OwObjectListViewCombined(int iViewMask_p)
construct a object list view
|
Modifier and Type | Method and Description |
---|---|
void |
detach()
remove view and all subviews from context
|
protected OwXMLUtil |
getConfigNode()
Simple getter of configuration
|
String |
getIcon()
get the icon URL for this view to be displayed
|
boolean |
getIsList()
same as getIsListValid() && ( ! getIsListEmpty() )
|
boolean |
getIsListEmpty()
Deprecated.
since 4.2.0.0 use
instead |
boolean |
getIsListValid()
check if list is configured well and can be displayed
|
boolean |
getIsPaging()
Deprecated.
since 4.2.0.0 use
OwObjectListView.hasPaging() |
Collection<String> |
getRetrievalPropertyNames()
get a collection of property names that are needed to display the Objects in the list
i.e.
|
String |
getTitle()
overridable title of the view
|
protected void |
init()
Initialize the view after the context is set.
|
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<? extends OwFieldColumnInfo> 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 fieldmanager_p)
set the internal fieldmanager
in case you want a specific fieldmanager
|
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 eventlistner_p)
register an event listener with this view to receive notifications
|
void |
setSort(OwSort sort_p)
set / override current sort to given sort
|
canPageNext, canPagePrev, getColumnInfo, getCurrentPage, getDisplayedPage, getFieldManager, getObjectIterable, getObjectList, getPageAbsolutEventURL, getPageCount, getPageNextEventURL, getPagePrevEventURL, getPageSize, getRefreshContext, getSort, isCollectionComplete, isPagingEnabled, onClientRefreshContextUpdate, onPageAbsolut, onPageNext, onPagePrev
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, setCurrentPage, 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, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getContext
getBreadcrumbPart, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion
protected static final String QUERY_KEY_PAGE_COMBINED
public OwObjectListViewCombined(int iViewMask_p)
iViewMask_p
- int combination of VIEW_MASK_... defined flagspublic OwObjectListViewCombined()
public void setConfigNode(Node node_p) throws Exception
setConfigNode
in class OwObjectListView
node_p
- XML node with configuration informationException
protected OwXMLUtil getConfigNode()
setConfigNode(Node)
was not called yet)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
public boolean getIsList()
public boolean getIsListValid()
@Deprecated public boolean getIsListEmpty()
OwObjectListView.getCount()
!= 0
instead@Deprecated public boolean getIsPaging()
OwObjectListView.hasPaging()
protected void renderCombinedPageButtons(Writer w_p) throws Exception
w_p
- Writer object to write HTML toException
public void setFieldManager(OwFieldManager fieldmanager_p)
OwObjectListView
setFieldManager
in class OwPageableListView
public Collection<String> getRetrievalPropertyNames() throws Exception
OwObjectListView
getRetrievalPropertyNames
in class OwPageableListView
Exception
protected void pageAbsolut(int iPage_p)
OwObjectListView
pageAbsolut
in class OwPageableListView
iPage_p
- int zero based page numberpublic void setColumnInfo(Collection<? extends OwFieldColumnInfo> columnInfo_p)
OwObjectListView
setColumnInfo
in class OwPageableListView
columnInfo_p
- List of OwFieldColumnInfo'spublic void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) throws Exception
OwObjectListView
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
public void setRefreshContext(OwClientRefreshContext eventlistner_p)
OwObjectListView
setRefreshContext
in class OwPageableListView
eventlistner_p
- OwClientRefreshContext interfacepublic void setSort(OwSort sort_p)
OwObjectListView
setSort
in class OwPageableListView
sort_p
- new OwSortpublic String getTitle()
OwView
getTitle
in interface OwBaseView
getTitle
in class OwView
public void setEventListner(OwObjectListView.OwObjectListViewEventListner eventlister_p)
setEventListner
in class OwObjectListView
eventlister_p
- OwObjectListCollectionEventListner interfacepublic void detach()
OwView
detach
in class OwPageableListView
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.