com.wewebu.ow.server.dmsdialogs.views
Class OwObjectListViewPluginCache

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwView
          extended by com.wewebu.ow.server.dmsdialogs.views.OwObjectListView
              extended by com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewPluginCache
All Implemented Interfaces:
OwPageableView, OwBaseView, OwUpdateTarget
Direct Known Subclasses:
OwObjectListViewEXTJSGrid, OwObjectListViewRow

public abstract class OwObjectListViewPluginCache
extends OwObjectListView

Abstract list view which contains a plugin cache utility class. Providing setter and getter methods for derived classes and also some simplified factory methods for utility instance creation.

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

Since:
3.1.0.4

Nested Class Summary
protected static class OwObjectListViewPluginCache.OwPluginStatus
           Class which holds the plugin status.
protected static class OwObjectListViewPluginCache.OwPluginStatusCachingUtility
           Utility class for caching the enabled/disabled status for a plugin, for each visible object in list.
 
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
 
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
OwObjectListViewPluginCache()
           
OwObjectListViewPluginCache(int viewMask)
           
 
Method Summary
protected  OwObjectListViewPluginCache.OwPluginStatusCachingUtility createPluginStatusCacheUtility(int startIndex, int endIndex, Collection pluginEntries)
          Create the plugin status cache.
protected  OwObjectListViewPluginCache.OwPluginStatusCachingUtility createPluginStatusCacheUtility(int startIndex, int endIndex, List objectList, OwObject parentObject, Collection pluginEntries, boolean displayEmptyPluginColumn)
          Create the plugin status cache instance for provided information.
protected  OwObjectListViewPluginCache.OwPluginStatusCachingUtility getPluginCache()
          Simple getter method for the plugin cache utility.
protected  void setPluginCache(OwObjectListViewPluginCache.OwPluginStatusCachingUtility newCache)
          Simple setter for used cache instance.
 
Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView
addAjaxPersistenceService, addViewMask, canPageNext, canPagePrev, clearViewMask, copy, createFilter, createFilter, createFilter, createPageSelector, getColumnInfo, getContextMenuFunction, getCount, getCurrentPage, getDocumentFunction, getDocumentFunctionPluginList, getEventListner, getFieldManager, getFilter, getFilterOperators, getFilterSearch, getListViewID, getObjectList, getPageAbsolutEventURL, getPageCount, getPageNextEventURL, getPagePrevEventURL, getParentObject, getPluginEntries, getRefreshContext, getRetrievalPropertyNames, getSort, hasPaging, hasViewMask, init, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isPagingEnabled, isStickyFooterInUse, onPageAbsolut, onPageNext, onPagePrev, pageAbsolut, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, setColumnInfo, setConfigNode, setCurrentPage, setDocumentFunctionPluginList, setEventListner, setFieldManager, setFilter, setObjectList, setParentObject, setRefreshContext, setRenderEmptyPluginColumn, setSort, setStickyFooterInUse, setViewMask
 
Methods inherited from class com.wewebu.ow.server.ui.OwView
activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onRender, 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, getTitle, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion
 

Constructor Detail

OwObjectListViewPluginCache

public OwObjectListViewPluginCache()

OwObjectListViewPluginCache

public OwObjectListViewPluginCache(int viewMask)
Method Detail

getPluginCache

protected OwObjectListViewPluginCache.OwPluginStatusCachingUtility getPluginCache()
Simple getter method for the plugin cache utility.

Returns:
OwPluginStatusCachingUtility which is currently set (can return null if not set)

setPluginCache

protected void setPluginCache(OwObjectListViewPluginCache.OwPluginStatusCachingUtility newCache)
Simple setter for used cache instance.

Parameters:
newCache - OwPluginStatusCachingUtility

createPluginStatusCacheUtility

protected OwObjectListViewPluginCache.OwPluginStatusCachingUtility createPluginStatusCacheUtility(int startIndex,
                                                                                                  int endIndex,
                                                                                                  Collection pluginEntries)
                                                                                           throws Exception
Create the plugin status cache. Requesting all other information from extended class.

Parameters:
startIndex - int the index of first object visible in list
endIndex - int the index of last object visible in list
pluginEntries - Collection of OwPluginEntry
Returns:
a OwObjectListViewPluginCache.OwPluginStatusCachingUtility object.
Throws:
Exception

createPluginStatusCacheUtility

protected OwObjectListViewPluginCache.OwPluginStatusCachingUtility createPluginStatusCacheUtility(int startIndex,
                                                                                                  int endIndex,
                                                                                                  List objectList,
                                                                                                  OwObject parentObject,
                                                                                                  Collection pluginEntries,
                                                                                                  boolean displayEmptyPluginColumn)
                                                                                           throws Exception
Create the plugin status cache instance for provided information.

Parameters:
startIndex - int the index of first object visible in list
endIndex - int the index of last object visible in list
objectList - List the list of OwObjects
parentObject - OwObject parent of current object list (can be null)
pluginEntries - Collection of OwPluginEntry
displayEmptyPluginColumn - boolean configuration if empty columns should be displayed
Returns:
OwPluginStatusCachingUtility
Throws:
Exception - if initialization fails


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.