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

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
All Implemented Interfaces:
OwPageableView, OwBaseView, OwUpdateTarget
Direct Known Subclasses:
OwObjectListViewCombined, OwObjectListViewPluginCache, OwObjectListViewThumbnails

public abstract class OwObjectListView
extends OwView
implements OwPageableView

Base class to all views that display object collections. Object collection view.

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
static class OwObjectListView.OwFilter
           A map of filter settings.
static class OwObjectListView.OwFilterEntry
           Single filter setting.
protected static class OwObjectListView.OwHtmlAlignmentMap
           Static class to retrieve HTML alignment attributes out of OwFieldColumnInfo alignment.
static class OwObjectListView.OwIcon
           Helper class to determine how many icons exists in a given string.
static interface OwObjectListView.OwObjectListViewEventListner
           Event listener interface for OwObjectCollectionView's.
 class OwObjectListView.OwPluginEntry
          a single entry for a plugins with its original index
 
Field Summary
protected static OwObjectListView.OwHtmlAlignmentMap m_HtmlAlignments
          singleton class to retrieve HTML alignment attributes out of OwFieldColumnInfo alignment
protected  boolean m_isStickyFooterInUse
          Deprecated. 
protected  OwPageSelectorComponent m_pageSelectorComponent
          page selector component
protected  Node m_pagingNode
          the paging node
protected static String MULTISELECT_COMOBO_MENU_NAME
          name of the combobox for multi select events
protected static String OBJECT_INDEX_KEY
          query string key for the object list index to find the selected object upon onMimeOpenObject.
protected static String PLUG_INDEX_KEY
          query string key for the plugin index.
protected static String QUERY_KEY_PAGE
          query string key for the page index.
protected static String SORT_PROPERTY_KEY
          query string key for the sort property.
static int VIEW_MASK_INLINE_EDITING
          view mask flag to control the display behavior Enable inline editing of column data.
static int VIEW_MASK_INSTANCE_PLUGINS
          view mask flag to control the display behavior Enable plug-in invoke icons on each item row.
static int VIEW_MASK_MULTI_SELECTION
          view mask flag to control the display behavior Enable multi selection.
static int VIEW_MASK_NO_PAGE_BUTTONS
          view mask flag to control the display behavior Disable the paging buttons on the resultlist.
static int VIEW_MASK_SINGLE_SELECTION
          view mask flag to control the display behavior Enable single selection.
static int VIEW_MASK_USE_DOCUMENT_PLUGINS
          view mask flag to control the display behavior Display document plug-ins if enabled, otherwise disable document plug-ins in the result list.
static int VIEW_MASK_USE_SELECT_BUTTON
          view mask flag to control the display behavior Enables a select button on each resultlist row.
 
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
OwObjectListView()
          construct a object list view
OwObjectListView(int iViewMask_p)
          construct a object list view
 
Method Summary
protected  void addAjaxPersistenceService(Writer w_p, String eventName_p)
          Outputs JavaScript service end point (onAjax[eventName] callback method) for the specified event on a given Writer.
 void addViewMask(int iViewMask_p)
          add a view property
 boolean canPageNext()
          check if there is a next page
 boolean canPagePrev()
          check if there is a previous page
protected  void clearViewMask(int iViewMask_p)
          clears a view property
 void copy(OwObjectListView oldview_p)
          Copy the contents and state of the given view.
static OwObjectListView.OwFilter createFilter(Collection filterprops_p, OwFieldDefinitionProvider fieldDefinitionProvider_p, String sResourceName_p, String sID_p, OwDocument doc_p)
          Create a filter with a Collection of OwFieldDefinition for the properties to be filtered and fieldDefinitionProvider for wildcard conversion
static OwObjectListView.OwFilter createFilter(Collection filterprops_p, String sID_p, OwDocument doc_p)
          create a filter with a Collection of OwFieldDefinition for the properties to be filtered
static OwObjectListView.OwFilter createFilter(String sID_p)
          create an empty filter
 OwPageSelectorComponent createPageSelector()
          Create the paging component, according with the configuration setting.
abstract  Collection getColumnInfo()
          get the list of column info to be used by this list view
protected  List getContextMenuFunction()
          Return a list of document function which should be displayed in the context menu of current view.
abstract  int getCount()
          get number of items in the list
 int getCurrentPage()
          get current zero based page number in multiples of getPageSize()
protected  OwDocumentFunction getDocumentFunction(int globalPluginIndex_p)
          Returning the document function which has the given plugin index, can return null if plugin not found or plugin list is empty.
 List getDocumentFunctionPluginList()
          Return the current set document function list, which is used by the view to display in context menu and plugin column.
protected  OwObjectListView.OwObjectListViewEventListner getEventListner()
          get the event listener
abstract  OwFieldManager getFieldManager()
          get the internal fieldmanager
 OwObjectListView.OwFilter getFilter()
           
static Collection getFilterOperators(OwFieldDefinition fielddef_p)
          get a collection of possible filter operators for a given field
 OwSearchNode getFilterSearch()
          get the current filter search node to filter with
 int getListViewID()
          Unique list view ID getter.
Unique list view IDs are used as a discriminant in rendering multiple list view instances in one page.
abstract  OwObjectCollection getObjectList()
          get the current object list
 String getPageAbsolutEventURL(String aditionalParameters_p)
          Get URL for a given page number
 int getPageCount()
          retrieve number of available pages
 String getPageNextEventURL()
          Get the next page URL.
 String getPagePrevEventURL()
          Get the previous page URL.
 OwObject getParentObject()
          get the parent object
 List getPluginEntries()
          This method returns a list of document plugins, which should be displayed next to the document in the document function column.
protected abstract  OwClientRefreshContext getRefreshContext()
          get an eventlistener with this view to receive notifications
abstract  Collection getRetrievalPropertyNames()
          get a collection of property names that are needed to display the Objects in the list i.e.
abstract  OwSort getSort()
          get the current selected sort instance
 boolean hasPaging()
          Check if the current view must show the paging component.
protected  boolean hasViewMask(int iViewMask_p)
          check if a certain view property is enabled
protected  void init()
          init the view after the context is set.
 boolean isEmptyPluginColumnRendered()
          Flag to check if empty plugin columns should be rendered.
protected  boolean isObjectSelectionPersisted(int objectIndex_p)
          Persistence selection state query method.
protected  boolean isObjectTypeSupportedByPlugin(OwDocumentFunction plugIn_p, Set objectTypes_p)
          Helper method to check if a document function plugin (plugIn_p) supports one type, which is given by the list (objectTypes_p).
protected  boolean isPagingEnabled()
          check if paging is enabled
 boolean isStickyFooterInUse()
          Deprecated. since 4.1.1.0 this method is no longer used and it will be soon removed.
 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 pageAbsolut(int iPage_p)
          Move to the given zero based absolute page.
protected  void persistAjaxTriggeredSelection(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p, OwObjectCollection objects_p)
          Ajax selection persistence request support method.
Subclasses should use this method on their AJAX selection persistence methods providing their current object collection.
protected  void persistObjectSelectionState(int iObjid_p, boolean status_p)
          Persist selection state for given object ID (number in list)
protected  void renderContextMenu(Writer w_p, Set occuredObjectTypes_p)
          Default method to render the context menu.
protected  void resetPersistedSelectionState()
          Resets all previously persist selection states.
No object state will be persisted as selected.
abstract  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 setCurrentPage(int iPage_p)
          Public setter of current page.
The implementation relays on pageAbsolut(int)
 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
abstract  void setFieldManager(OwFieldManager fielmanager_p)
          set the internal fieldmanager in case you want a specific fieldmanager
 void setFilter(OwObjectListView.OwFilter filter_p)
          set the filter to be used
abstract  void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p)
          set the list of objects to be displayed by this list view
protected  void setParentObject(OwObject newParent_p)
           
abstract  void setRefreshContext(OwClientRefreshContext eventlister_p)
          register an eventlistener with this view to receive notifications
 void setRenderEmptyPluginColumn(boolean renderEmptyColumn_p)
          Set flag to enable/disable empty column rendering.
abstract  void setSort(OwSort sort_p)
          set / override current sort to given sort
 void setStickyFooterInUse(boolean stickyFooterInUse_p)
          Set the stickyFooter flag.
 void setViewMask(int iViewMask_p)
          set the view properties
 
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
 

Field Detail

MULTISELECT_COMOBO_MENU_NAME

protected static final String MULTISELECT_COMOBO_MENU_NAME
name of the combobox for multi select events

See Also:
Constant Field Values

OBJECT_INDEX_KEY

protected static final String OBJECT_INDEX_KEY
query string key for the object list index to find the selected object upon onMimeOpenObject.

See Also:
Constant Field Values

SORT_PROPERTY_KEY

protected static final String SORT_PROPERTY_KEY
query string key for the sort property.

See Also:
Constant Field Values

PLUG_INDEX_KEY

protected static final String PLUG_INDEX_KEY
query string key for the plugin index.

See Also:
Constant Field Values

QUERY_KEY_PAGE

protected static final String QUERY_KEY_PAGE
query string key for the page index.

See Also:
Constant Field Values

m_HtmlAlignments

protected static final OwObjectListView.OwHtmlAlignmentMap m_HtmlAlignments
singleton class to retrieve HTML alignment attributes out of OwFieldColumnInfo alignment


VIEW_MASK_USE_DOCUMENT_PLUGINS

public static final int VIEW_MASK_USE_DOCUMENT_PLUGINS
view mask flag to control the display behavior Display document plug-ins if enabled, otherwise disable document plug-ins in the result list.

See Also:
Constant Field Values

VIEW_MASK_USE_SELECT_BUTTON

public static final int VIEW_MASK_USE_SELECT_BUTTON
view mask flag to control the display behavior Enables a select button on each resultlist row. The select button will send a select event via the result list listener. The select event can be used to select an item in a other context.

See Also:
OwObjectListView.OwObjectListViewEventListner.onObjectListViewSelect(OwObject, OwObject), Constant Field Values

VIEW_MASK_MULTI_SELECTION

public static final int VIEW_MASK_MULTI_SELECTION
view mask flag to control the display behavior Enable multi selection. If neither VIEW_MASK_MULTI_SELECTION nor VIEW_MASK_SINGLE_SELECTION is selected, the resultlist does not allow selection at all.

See Also:
Constant Field Values

VIEW_MASK_SINGLE_SELECTION

public static final int VIEW_MASK_SINGLE_SELECTION
view mask flag to control the display behavior Enable single selection. If neither VIEW_MASK_MULTI_SELECTION nor VIEW_MASK_SINGLE_SELECTION is selected, the resultlist does not allow selection at all.

See Also:
Constant Field Values

VIEW_MASK_NO_PAGE_BUTTONS

public static final int VIEW_MASK_NO_PAGE_BUTTONS
view mask flag to control the display behavior Disable the paging buttons on the resultlist.

See Also:
Constant Field Values

VIEW_MASK_INSTANCE_PLUGINS

public static final int VIEW_MASK_INSTANCE_PLUGINS
view mask flag to control the display behavior Enable plug-in invoke icons on each item row. Otherwise the plug-ins appear only in the context menu.

See Also:
Constant Field Values

VIEW_MASK_INLINE_EDITING

public static final int VIEW_MASK_INLINE_EDITING
view mask flag to control the display behavior Enable inline editing of column data.

See Also:
Constant Field Values

m_pageSelectorComponent

protected OwPageSelectorComponent m_pageSelectorComponent
page selector component


m_isStickyFooterInUse

@Deprecated
protected boolean m_isStickyFooterInUse
Deprecated. 
sticky footer flag


m_pagingNode

protected Node m_pagingNode
the paging node

Constructor Detail

OwObjectListView

public OwObjectListView(int iViewMask_p)
construct a object list view

Parameters:
iViewMask_p - int combination of VIEW_MASK_... defined flags

OwObjectListView

public OwObjectListView()
construct a object list view

Method Detail

getListViewID

public int getListViewID()
Unique list view ID getter.
Unique list view IDs are used as a discriminant in rendering multiple list view instances in one page. If no ID was generated before (ie. m_listViewID is 0) and this list does not have an OwObjectListView parent a new unique ID is generated.
If this list has an OwObjectListView a combined list aggregation is assumed and the ID of the parent becomes the ID of this list.

Returns:
the unique ID of this list view
Since:
2.5.2.0
See Also:
OwObjectListViewCombined

resetPersistedSelectionState

protected void resetPersistedSelectionState()
Resets all previously persist selection states.
No object state will be persisted as selected.

Since:
2.5.2.0

isObjectSelectionPersisted

protected boolean isObjectSelectionPersisted(int objectIndex_p)
Persistence selection state query method.

Parameters:
objectIndex_p - object index
Returns:
true if the object with the given index has its selection state persisted as selected
false otherwise
Since:
2.5.2.0

persistAjaxTriggeredSelection

protected void persistAjaxTriggeredSelection(javax.servlet.http.HttpServletRequest request_p,
                                             javax.servlet.http.HttpServletResponse response_p,
                                             OwObjectCollection objects_p)
                                      throws Exception
Ajax selection persistence request support method.
Subclasses should use this method on their AJAX selection persistence methods providing their current object collection.

Parameters:
request_p -
response_p -
objects_p - the collection of objects this list view handles
Throws:
Exception
Since:
2.5.2.0

persistObjectSelectionState

protected void persistObjectSelectionState(int iObjid_p,
                                           boolean status_p)
Persist selection state for given object ID (number in list)

Parameters:
iObjid_p - - the object ID (index in list)
status_p - - the status of the object (true means selected)
Since:
3.0.0.0

addAjaxPersistenceService

protected void addAjaxPersistenceService(Writer w_p,
                                         String eventName_p)
                                  throws Exception
Outputs JavaScript service end point (onAjax[eventName] callback method) for the specified event on a given Writer.

Parameters:
w_p -
eventName_p - the AJAX event name
Throws:
Exception
Since:
2.5.2.0

createFilter

public static OwObjectListView.OwFilter createFilter(Collection filterprops_p,
                                                     OwFieldDefinitionProvider fieldDefinitionProvider_p,
                                                     String sResourceName_p,
                                                     String sID_p,
                                                     OwDocument doc_p)
                                              throws Exception
Create a filter with a Collection of OwFieldDefinition for the properties to be filtered and fieldDefinitionProvider for wildcard conversion

Parameters:
filterprops_p - Collection of OwFieldDefinition for the properties to be filtered, may be null
fieldDefinitionProvider_p - OwFieldDefinitionProvider to resolve wildcards
sResourceName_p - for fieldDefinitionProvider_p
sID_p - String ID of the filter, if you keep a collection of several filters for one list, otherwise empty string
doc_p - OwDocument can be null if no persistence should be used
Returns:
OwFilter to be used in setFilter
Throws:
Exception

createFilter

public static OwObjectListView.OwFilter createFilter(Collection filterprops_p,
                                                     String sID_p,
                                                     OwDocument doc_p)
                                              throws Exception
create a filter with a Collection of OwFieldDefinition for the properties to be filtered

Parameters:
filterprops_p - Collection of OwFieldDefinition for the properties to be filtered, can be null to create an empty filter
sID_p - String ID of the filter, if you keep a collection of several filters for one list, otherwise empty string
doc_p - OwDocument can be null if no persistence should be used
Returns:
OwFilter to be used in setFilter
Throws:
Exception

createFilter

public static OwObjectListView.OwFilter createFilter(String sID_p)
                                              throws Exception
create an empty filter

Parameters:
sID_p - String ID of the filter, if you keep a collection of several filters for one list, otherwise empty string
Returns:
OwFilter to be used in setFilter
Throws:
Exception

getFilterOperators

public static Collection getFilterOperators(OwFieldDefinition fielddef_p)
                                     throws Exception
get a collection of possible filter operators for a given field

Parameters:
fielddef_p - OwFieldDefinition
Returns:
Collection of operators as defined with OwSearchOperator.CRIT_OP_...
Throws:
Exception

getFilter

public OwObjectListView.OwFilter getFilter()

setFilter

public void setFilter(OwObjectListView.OwFilter filter_p)
set the filter to be used

Parameters:
filter_p - an OwObjectListView.OwFilter

getFilterSearch

public OwSearchNode getFilterSearch()
                             throws Exception
get the current filter search node to filter with

Returns:
OwSearchNode or null if no filter is set
Throws:
Exception

setEventListner

public void setEventListner(OwObjectListView.OwObjectListViewEventListner eventlister_p)
register an eventlistener with this view to receive notifications

Parameters:
eventlister_p - OwObjectListCollectionEventListner interface

getEventListner

protected OwObjectListView.OwObjectListViewEventListner getEventListner()
get the event listener


getPluginEntries

public List getPluginEntries()
This method returns a list of document plugins, which should be displayed next to the document in the document function column.

This method filters from the list of document functions (getDocumentFunctionPluginList() ), all functions where <ObjectInstance> is false.
Also this method check if a document function need a parent object, if getParentObject() is null the document function is skipped.

Returns:
List of OwPluginEntry, which are filtered document plugins or empty list if VIEW_MASK_INSTANCE_PLUGINS not set

getDocumentFunction

protected OwDocumentFunction getDocumentFunction(int globalPluginIndex_p)
Returning the document function which has the given plugin index, can return null if plugin not found or plugin list is empty.

Parameters:
globalPluginIndex_p - int representing the unique plugin index, attention not the ID
Returns:
OwDocumentFunction or null if plugin not found.

getContextMenuFunction

protected List getContextMenuFunction()
Return a list of document function which should be displayed in the context menu of current view.

This method filters the document functions from getDocumentFunctionPluginList(), checking the value of <ContextMenu>[true|false]</ContextMenu>.
Also this method check if a document function need a parent object, if getParentObject() is null the document function is skipped.

Returns:
list of OwPluginEntry for context menu

renderContextMenu

protected void renderContextMenu(Writer w_p,
                                 Set occuredObjectTypes_p)
                          throws Exception
Default method to render the context menu. This method check if the plugin supports one of the occuredObjectTypes, and also if an parent object is need and available.

Parameters:
w_p - Writer object to write the HTML
occuredObjectTypes_p - Set of java.lang.Integer which representing OwObjectReference.OBJECT_TYPE_... constants
Throws:
Exception

isObjectTypeSupportedByPlugin

protected boolean isObjectTypeSupportedByPlugin(OwDocumentFunction plugIn_p,
                                                Set objectTypes_p)
Helper method to check if a document function plugin (plugIn_p) supports one type, which is given by the list (objectTypes_p).

Parameters:
plugIn_p - OwDocumentFunction which should be checked
objectTypes_p - Set of java.lang.Integer which represents OwObjectReference.OBJECT_TYPE_... constants
Returns:
boolean true if one of the types is supported

setDocumentFunctionPluginList

public void setDocumentFunctionPluginList(List pluginList_p)
Set a 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.

Parameters:
pluginList_p - the java.util.List of OwDocumentFunction to be used by this list. Must not be null.

getDocumentFunctionPluginList

public List getDocumentFunctionPluginList()
Return the current set document function list, which is used by the view to display in context menu and plugin column.

Returns:
List java.util.List of OwDocumentFunction

init

protected void init()
             throws Exception
init the view after the context is set.

Overrides:
init in class OwView
Throws:
Exception

copy

public void copy(OwObjectListView oldview_p)
          throws Exception
Copy the contents and state of the given view.

Parameters:
oldview_p - OwObjectListView
Throws:
Exception

hasViewMask

protected boolean hasViewMask(int iViewMask_p)
check if a certain view property is enabled

Parameters:
iViewMask_p - int as defined with VIEW_MASK_...

setViewMask

public void setViewMask(int iViewMask_p)
set the view properties

Parameters:
iViewMask_p - int combination of VIEW_MASK_... defined flags

addViewMask

public void addViewMask(int iViewMask_p)
add a view property

Parameters:
iViewMask_p - int combination of VIEW_MASK_... defined flags to add to

clearViewMask

protected void clearViewMask(int iViewMask_p)
clears a view property

Parameters:
iViewMask_p - int to clear

setConfigNode

public void setConfigNode(Node node_p)
                   throws Exception
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

Parameters:
node_p - XML node with configuration information
Throws:
Exception

isPagingEnabled

protected boolean isPagingEnabled()
check if paging is enabled

Returns:
true = enabled, display page buttons, false = disabled

getPageCount

public int getPageCount()
                 throws Exception
retrieve number of available pages

Specified by:
getPageCount in interface OwPageableView
Returns:
int number of pages for paging in multiples of getPageSize()
Throws:
Exception

getCurrentPage

public int getCurrentPage()
get current zero based page number in multiples of getPageSize()

Specified by:
getCurrentPage in interface OwPageableView
Returns:
current zero based page number in multiples of getPageSize()

setCurrentPage

public final void setCurrentPage(int iPage_p)
                          throws Exception
Public setter of current page.
The implementation relays on pageAbsolut(int)

Parameters:
iPage_p - int zero based page number
Throws:
Exception
Since:
2.5.2.0

pageAbsolut

protected void pageAbsolut(int iPage_p)
                    throws Exception
Move to the given zero based absolute page.

Parameters:
iPage_p - int zero based page number
Throws:
Exception

canPagePrev

public boolean canPagePrev()
check if there is a previous page

Specified by:
canPagePrev in interface OwPageableView
Returns:
boolean true = there is a previous page, pagePrev is possible

canPageNext

public boolean canPageNext()
                    throws Exception
check if there is a next page

Specified by:
canPageNext in interface OwPageableView
Returns:
boolean true = there is a next page, pageNext is possible
Throws:
Exception

setParentObject

protected void setParentObject(OwObject newParent_p)

setObjectList

public abstract void setObjectList(OwObjectCollection objectList_p,
                                   OwObject parentObject_p)
                            throws Exception
set the list of objects to be displayed by this list view

Parameters:
objectList_p - OwObjectCollection
parentObject_p - OwObject parent which created the object list, can be null if no parent is specified
Throws:
Exception

getObjectList

public abstract OwObjectCollection getObjectList()
get the current object list


getParentObject

public OwObject getParentObject()
get the parent object

Returns:
OwObject

getFieldManager

public abstract OwFieldManager getFieldManager()
get the internal fieldmanager


setFieldManager

public abstract void setFieldManager(OwFieldManager fielmanager_p)
set the internal fieldmanager in case you want a specific fieldmanager


setRefreshContext

public abstract void setRefreshContext(OwClientRefreshContext eventlister_p)
register an eventlistener with this view to receive notifications

Parameters:
eventlister_p - OwClientRefreshContext interface

getRefreshContext

protected abstract OwClientRefreshContext getRefreshContext()
get an eventlistener with this view to receive notifications

Returns:
OwClientRefreshContext

getCount

public abstract int getCount()
get number of items in the list

Specified by:
getCount in interface OwPageableView
Returns:
int

setColumnInfo

public abstract void setColumnInfo(Collection columnInfo_p)
set the list of column info to be used by this list view

Parameters:
columnInfo_p - List of OwFieldColumnInfo's

getColumnInfo

public abstract Collection getColumnInfo()
get the list of column info to be used by this list view

Returns:
Collection of OwFieldColumnInfo's

setSort

public abstract void setSort(OwSort sort_p)
set / override current sort to given sort

Parameters:
sort_p - new OwSort

getSort

public abstract OwSort getSort()
get the current selected sort instance

Returns:
OwSort object

getRetrievalPropertyNames

public abstract Collection getRetrievalPropertyNames()
                                              throws Exception
get a collection of property names that are needed to display the Objects in the list i.e. these properties should be requested in advance to save server roundtrips.

Returns:
Collection of String
Throws:
Exception

createPageSelector

public OwPageSelectorComponent createPageSelector()
                                           throws Exception
Create the paging component, according with the configuration setting. In case that no paging element is set, the direct input page selector component is used.

Specified by:
createPageSelector in interface OwPageableView
Returns:
an instance of OwPageSelectorComponent.
Throws:
Exception
Since:
2.5.2.0

getPageAbsolutEventURL

public String getPageAbsolutEventURL(String aditionalParameters_p)
Description copied from interface: OwPageableView
Get URL for a given page number

Specified by:
getPageAbsolutEventURL in interface OwPageableView
Parameters:
aditionalParameters_p - - query parameters in a http link
Returns:
the URL
Since:
2.5.2.0
See Also:
OwPageableView.getPageAbsolutEventURL(java.lang.String)

getPageNextEventURL

public String getPageNextEventURL()
Description copied from interface: OwPageableView
Get the next page URL.

Specified by:
getPageNextEventURL in interface OwPageableView
Returns:
the next page URL
Since:
2.5.2.0
See Also:
OwPageableView.getPageNextEventURL()

getPagePrevEventURL

public String getPagePrevEventURL()
Description copied from interface: OwPageableView
Get the previous page URL.

Specified by:
getPagePrevEventURL in interface OwPageableView
Returns:
the page previous URL
Since:
2.5.2.0
See Also:
OwPageableView.getPagePrevEventURL()

hasPaging

public boolean hasPaging()
Description copied from interface: OwPageableView
Check if the current view must show the paging component.

Specified by:
hasPaging in interface OwPageableView
Returns:
true if the current view must show the paging component.
Since:
2.5.2.0
See Also:
OwPageableView.hasPaging()

onPageAbsolut

public void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
                   throws Exception
Description copied from interface: OwPageableView
display absolute page of objects

Specified by:
onPageAbsolut in interface OwPageableView
Throws:
Exception
Since:
2.5.2.0
See Also:
OwPageableView.onPageAbsolut(javax.servlet.http.HttpServletRequest)

onPageNext

public void onPageNext(javax.servlet.http.HttpServletRequest request_p)
                throws Exception
Description copied from interface: OwPageableView
display next page of objects

Specified by:
onPageNext in interface OwPageableView
Throws:
Exception
Since:
2.5.2.0
See Also:
OwPageableView.onPageNext(javax.servlet.http.HttpServletRequest)

onPagePrev

public void onPagePrev(javax.servlet.http.HttpServletRequest request_p)
                throws Exception
Description copied from interface: OwPageableView
display previous page of objects

Specified by:
onPagePrev in interface OwPageableView
Throws:
Exception
Since:
2.5.2.0
See Also:
OwPageableView.onPagePrev(javax.servlet.http.HttpServletRequest)

isStickyFooterInUse

@Deprecated
public boolean isStickyFooterInUse()
Deprecated. since 4.1.1.0 this method is no longer used and it will be soon removed.

Check if the paging component should be displayed as a sticky footer.

Returns:
true - sticky footer is used
Since:
2.5.2.0

setStickyFooterInUse

public void setStickyFooterInUse(boolean stickyFooterInUse_p)
Set the stickyFooter flag.

Parameters:
stickyFooterInUse_p - - the new value.
Since:
2.5.2.0

isEmptyPluginColumnRendered

public boolean isEmptyPluginColumnRendered()
Flag to check if empty plugin columns should be rendered.

Returns:
boolean flag
Since:
3.0.0.0

setRenderEmptyPluginColumn

public void setRenderEmptyPluginColumn(boolean renderEmptyColumn_p)
Set flag to enable/disable empty column rendering.

Parameters:
renderEmptyColumn_p - boolean flag
Since:
3.0.0.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.