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

java.lang.Object
  com.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

All Implemented Interfaces:

OwPageableView, OwFieldProvider, OwBaseView, OwUpdateTarget

Direct Known Subclasses:

OwObjectEditVersionsView, OwObjectListViewCombined.OwObjectListViewRowCombined, OwObjectListViewFilterRow

public class OwObjectListViewRow
extends OwObjectListViewPluginCache
implements OwFieldProvider

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.dmsdialogs.views.OwObjectListView

addAjaxPersistenceService, addViewMask, clearViewMask, copy, createFilter, createFilter, createFilter, createPageSelector, getContextMenuFunction, getDocumentFunction, getDocumentFunctionPluginList, getEventListner, getFilter, getFilterOperators, getFilterSearch, getListViewID, getPageAbsolutEventURL, getPageNextEventURL, getPagePrevEventURL, getParentObject, getPluginEntries, hasPaging, hasViewMask, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isStickyFooterInUse, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, setConfigNode, setCurrentPage, setDocumentFunctionPluginList, setEventListner, setFilter, setParentObject, setRenderEmptyPluginColumn, setStickyFooterInUse, setViewMask

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

m_MainContext

protected OwMainAppContext m_MainContext

reference to the cast AppContext

m_iCurrentPage

protected int m_iCurrentPage

current zero based page number in multiples of getPageSize() for paging the results

m_Sort

protected OwSort m_Sort

the list with the sort criteria

m_useContextMenu

protected boolean m_useContextMenu

flag indicating if context menu should be shown

m_ColumnInfoList

protected Collection m_ColumnInfoList

a list of column info, which describe the columns of the object list

m_theFieldManager

protected OwFieldManager m_theFieldManager

instance of the property field class

m_RefreshContext

protected OwClientRefreshContext m_RefreshContext

event listener for the function plugin refresh events

m_occuredObjectTypes

protected Set m_occuredObjectTypes

object types found during rendering

Constructor Detail

OwObjectListViewRow

public OwObjectListViewRow(int iViewMask_p)

Construct a object list view. By default, try to use sticky footer.

Parameters:

iViewMask_p - int combination of VIEW_MASK_... defined flags

OwObjectListViewRow

public OwObjectListViewRow()

Construct a object list view.By default, try to use sticky footer.

Method Detail

createMimeManager

protected OwMimeManager createMimeManager()

overridable factory method to create the MimeManager

setMimeTypeContext

public void setMimeTypeContext(String context_p)

Set the context to be used for MIME type resolution

Parameters:

context_p - the context to be used for MIME type resolution, can be null

Since:

2.5.3.0

getHtmlAlignment

protected String getHtmlAlignment(int iAlignment_p)

method to retrieve HTML alignment attributes out of OwFieldColumnInfo alignment

Parameters:

iAlignment_p - int alignment as defined in OwFieldColumnInfo

Returns:

String corresponding HTML alignment attribute

setObjectList

public void setObjectList(OwObjectCollection objectList_p,
                          OwObject parentObject_p)
                   throws Exception

set the list of objects to be displayed by this list view

Specified by:

setObjectList in class OwObjectListView

Parameters:

objectList_p - OwObjectCollection

parentObject_p - OwObject parent which created the object list, can be null if no parent is specified

Throws:

Exception

usesFormWithAttributes

protected String usesFormWithAttributes()

to get additional form attributes used for the form override if your view needs a form. Base class will then render a form automatically

Overrides:

usesFormWithAttributes in class OwView

Returns:

String with form attributes, or null if view does not render a form

getObjectList

public OwObjectCollection getObjectList()

get the current object list

Specified by:

getObjectList in class OwObjectListView

isPagingEnabled

protected boolean isPagingEnabled()

check if paging is enabled

Overrides:

isPagingEnabled in class OwObjectListView

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

Overrides:

getPageCount in class OwObjectListView

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

Overrides:

getCurrentPage in class OwObjectListView

Returns:

current zero based page number in multiples of getPageSize()

onPageAbsolut

public void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
                   throws Exception

display absolute page of objects

Specified by:

onPageAbsolut in interface OwPageableView

Overrides:

onPageAbsolut in class OwObjectListView

Throws:

Exception

See Also:

OwPageableView.onPageAbsolut(javax.servlet.http.HttpServletRequest)

pageAbsolut

protected void pageAbsolut(int iPage_p)
                    throws Exception

move to the given zero based absolute page

Overrides:

pageAbsolut in class OwObjectListView

Parameters:

iPage_p - int zero based page number in multiples of getPageSize()

Throws:

Exception

onPageNext

public void onPageNext(javax.servlet.http.HttpServletRequest request_p)
                throws Exception

display next page of objects

Specified by:

onPageNext in interface OwPageableView

Overrides:

onPageNext in class OwObjectListView

Throws:

Exception

See Also:

OwPageableView.onPageNext(javax.servlet.http.HttpServletRequest)

onPagePrev

public void onPagePrev(javax.servlet.http.HttpServletRequest request_p)
                throws Exception

display previous page of objects

Specified by:

onPagePrev in interface OwPageableView

Overrides:

onPagePrev in class OwObjectListView

Throws:

Exception

See Also:

OwPageableView.onPagePrev(javax.servlet.http.HttpServletRequest)

canPagePrev

public boolean canPagePrev()

check if there is a previous page

Specified by:

canPagePrev in interface OwPageableView

Overrides:

canPagePrev in class OwObjectListView

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

Overrides:

canPageNext in class OwObjectListView

Returns:

boolean true = there is a next page, pageNext is possible

Throws:

Exception

getPagePrevURL

public String getPagePrevURL()

getPageNextURL

public String getPageNextURL()

getPageAbsolutURL

public String getPageAbsolutURL(int iPage_p)

getFieldManager

public OwFieldManager getFieldManager()

get the internal fieldmanager

Specified by:

getFieldManager in class OwObjectListView

setFieldManager

public void setFieldManager(OwFieldManager fielmanager_p)

set the internal fieldmanager in case you want a specific fieldmanager

Specified by:

setFieldManager in class OwObjectListView

setRefreshContext

public void setRefreshContext(OwClientRefreshContext eventlister_p)

register an eventlistener with this view to receive notifications

Specified by:

setRefreshContext in class OwObjectListView

Parameters:

eventlister_p - OwClientRefreshContext interface

getRefreshContext

protected OwClientRefreshContext getRefreshContext()

get an eventlistener with this view to receive notifications

Specified by:

getRefreshContext in class OwObjectListView

Returns:

OwClientRefreshContext

getCount

public int getCount()

get number of items in the list

Specified by:

getCount in interface OwPageableView

Specified by:

getCount in class OwObjectListView

Returns:

int

setColumnInfo

public void setColumnInfo(Collection columnInfo_p)

set the list of column info to be used by this list view

Specified by:

setColumnInfo in class OwObjectListView

Parameters:

columnInfo_p - List of OwFieldColumnInfo's

getColumnInfo

public Collection getColumnInfo()

get the list of column info to be used by this list view

Specified by:

getColumnInfo in class OwObjectListView

Returns:

Collection of OwFieldColumnInfo's

init

protected void init()
             throws Exception

init the view after the context is set.

Overrides:

init in class OwObjectListView

Throws:

Exception

setSort

public void setSort(OwSort sort_p)

set / override current sort to given sort

Specified by:

setSort in class OwObjectListView

Parameters:

sort_p - new OwSort

getSort

public OwSort getSort()

get the current selected sort instance

Specified by:

getSort in class OwObjectListView

Returns:

OwSort object

detach

public void detach()

remove view and all subviews from context

Overrides:

detach in class OwView

getSortOrderType

protected String getSortOrderType(String strProperty_p)
                           throws Exception

Parameters:

strProperty_p -

Returns:

String sort order type Ascending | Descending

Throws:

Exception

getSortOrderImage

protected String getSortOrderImage(String strProperty_p)
                            throws Exception

gets the path to the sort order image, which designates the current sort order of the specified column

Parameters:

strProperty_p - column

Returns:

image path

Throws:

Exception

renderExtraColumnHeader

protected void renderExtraColumnHeader(Writer w_p)
                                throws Exception

overridable to render additional columns

Throws:

Exception

renderExtraColumnRows

protected void renderExtraColumnRows(Writer w_p,
                                     OwObject obj_p,
                                     int iIndex_p)
                              throws Exception

overridable to render additional columns

Throws:

Exception

renderLockedColumn

protected void renderLockedColumn(Writer w_p,
                                  OwObject obj_p)
                           throws Exception,
                                  IOException

Render lock column. Check if the given Object is lock-status and render it depending on the status.

Parameters:

w_p - Writer to be used for rendering

obj_p - OwObject which should be checked

Throws:

Exception - If OwObject.getLock(int) fail

IOException - if can not use writer

Since:

2.5.2.0

renderTableCaption

public void renderTableCaption(Writer w_p)
                        throws Exception

Throws:

Exception

renderSortHeader

public void renderSortHeader(Writer w_p,
                             Collection instancePluginsList_p)
                      throws Exception

render the header portion of the object list

Parameters:

w_p - Writer object to write HTML to

instancePluginsList_p - Collection of plugins that are displayed for each instance

Throws:

Exception

renderPropertiesHeader

protected void renderPropertiesHeader(Writer w_p)
                               throws IOException,
                                      Exception

Parameters:

w_p -

Throws:

IOException

Exception

Since:

4.0.0.0

renderVersionHeader

protected void renderVersionHeader(Writer w_p)
                            throws IOException

Parameters:

w_p -

Throws:

IOException

Since:

4.0.0.0

renderMimeTypeHeader

protected void renderMimeTypeHeader(Writer w_p)
                             throws IOException

Parameters:

w_p -

Throws:

IOException

Since:

4.0.0.0

insertDocumentFunctionPluginHeader

protected void insertDocumentFunctionPluginHeader(Writer w_p,
                                                  Collection instancePluginsList_p)
                                           throws IOException,
                                                  Exception

Parameters:

w_p -

instancePluginsList_p -

Throws:

IOException

Exception

Since:

4.0.0.0

renderIndexHeader

protected void renderIndexHeader(Writer w_p)
                          throws IOException,
                                 Exception

Parameters:

w_p -

Throws:

IOException

Exception

Since:

4.0.0.0

renderPropertyColumnHeader

protected void renderPropertyColumnHeader(Writer w_p,
                                          OwFieldColumnInfo colInfo_p)
                                   throws Exception

(overridable) render the property sort column

Parameters:

w_p - java.io.Writer

colInfo_p - OwFieldColumnInfo

Throws:

Exception

getRowClassName

protected String getRowClassName(int iIndex_p,
                                 OwObject obj_p)

overridable get the style class name for the row

Parameters:

iIndex_p - int row index

obj_p - current OwObject

Returns:

String with style class name

getSelectedRowClassName

protected String getSelectedRowClassName(int iIndex_p,
                                         OwObject obj_p)

overridable get the style class name for the row

Parameters:

iIndex_p - int row index

obj_p - current OwObject

Returns:

String with style class name

computeStartIndex

protected int computeStartIndex()

Compute the start index, the index for the first object displayed in the list, when paging is used.

Returns:

the start index.

Since:

3.0.0.0

computeEndIndex

protected int computeEndIndex()

Compute the end index, the index for the last displayed object, when paging is used.

Returns:

- the end index

Since:

3.0.0.0

renderRows

public void renderRows(Writer w_p,
                       Collection instancePluginsList_p)
                throws Exception

render the header portion of the object list

Parameters:

w_p - Writer object to write HTML to

instancePluginsList_p - Collection of plugins that are displayed for each instance

Throws:

Exception

renderProperties

protected void renderProperties(StringWriter rowBuffer,
                                OwObject obj)
                         throws Exception

Parameters:

rowBuffer -

obj -

Throws:

Exception

Since:

4.0.0.0

renderMimeType

protected void renderMimeType(StringWriter rowBuffer,
                              OwObject obj)
                       throws Exception

Parameters:

rowBuffer -

obj -

Throws:

Exception

Since:

4.0.0.0

renderVersion

protected void renderVersion(StringWriter rowBuffer,
                             OwObject obj)
                      throws Exception

Parameters:

rowBuffer - output buffer

obj -

Throws:

Exception

Since:

4.0.0.0

renderCheckedOut

protected void renderCheckedOut(StringWriter rowBuffer,
                                OwObject obj)
                         throws Exception

Parameters:

rowBuffer -

obj -

Throws:

Exception

Since:

4.0.0.0

renderIndex

protected void renderIndex(StringWriter rowBuffer,
                           int i)

Parameters:

rowBuffer - output buffer

i - row index

Since:

4.0.0.0

getIsList

public boolean getIsList()

same as getIsListValid() && ( ! getIsListEmpty() )

Returns:

boolean true = valid list with at least one item to display

getIsListValid

public boolean getIsListValid()

check if list is configured well and can be displayed

Returns:

boolean true = list is valid, false = no valid list, don't render anything yet

getIsListEmpty

public boolean getIsListEmpty()

check if list contains any items

Returns:

boolean true = list contains at least one item

getIsPaging

public boolean getIsPaging()

check if page buttons should be rendered

Returns:

true = render page buttons, false = no page buttons to render

onRender

protected void onRender(Writer w_p)
                 throws Exception

render the view

Overrides:

onRender in class OwView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

onAjaxPersistSelection

public void onAjaxPersistSelection(javax.servlet.http.HttpServletRequest request_p,
                                   javax.servlet.http.HttpServletResponse response_p)
                            throws Exception

Called upon AJAX request "PersistSelection"

Parameters:

request_p -

response_p -

Throws:

Exception

renderMainRegion

protected void renderMainRegion(Writer w_p)
                         throws Exception

render the view JSP

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

getPageSize

public int getPageSize()

number of items in a page for lists which support paging

Returns:

int

insertDocumentFunctionPluginRows

protected void insertDocumentFunctionPluginRows(Writer w_p,
                                                OwObject obj_p,
                                                int iIndex_p,
                                                Collection instancePluginsList_p)
                                         throws Exception

insert the document function plugins for the requested row index and object

Parameters:

w_p - writer object for HTML output

obj_p - OwObject to create Function plugin for

iIndex_p - the row / object index

instancePluginsList_p - Collection of plugins that are visible (have there own column) together with the global index

Throws:

Exception

onSort

public void onSort(javax.servlet.http.HttpServletRequest request_p)
            throws Exception

event called when user clicked a sort header

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onContextMenuEvent

public void onContextMenuEvent(javax.servlet.http.HttpServletRequest request_p)
                        throws Exception

event called when user clicked on a plugin link on the context menu

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onColumnClickEvent

public void onColumnClickEvent(javax.servlet.http.HttpServletRequest request_p)
                        throws Exception

event called when user clicked on a plugin column

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onMultiSelectEvent

public void onMultiSelectEvent(javax.servlet.http.HttpServletRequest request_p)
                        throws Exception

event called when user submitted the mulitiselect form

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onPluginEvent

public void onPluginEvent(javax.servlet.http.HttpServletRequest request_p)
                   throws Exception

event called when user clicked on a plugin link of an object entry in the list

Parameters:

request_p - HttpServletRequest

Throws:

Exception

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request_p)
              throws Exception

event called when user selected an item

Parameters:

request_p - HttpServletRequest

Throws:

Exception

updateExternalFormTarget

public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
                                        boolean fSave_p)
                                 throws Exception

update the target after a form event, so it can set its form fields

Overrides:

updateExternalFormTarget in class OwEventTarget

Parameters:

request_p - HttpServletRequest

fSave_p - boolean true = save the changes of the form data, false = just update the form data, but do not save

Returns:

true = field data was valid, false = field data was invalid

Throws:

Exception

getRetrievalPropertyNames

public 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.

Specified by:

getRetrievalPropertyNames in class OwObjectListView

Returns:

Collection of String

Throws:

Exception

getField

public OwField getField(String strFieldClassName_p)
                 throws Exception,
                        OwObjectNotFoundException

Description copied from interface: OwFieldProvider

get a field with the given field definition class name

Specified by:

getField in interface OwFieldProvider

Parameters:

strFieldClassName_p - String class name of requested fields

Returns:

OwField or throws OwObjectNotFoundException

Throws:

Exception

OwObjectNotFoundException

getFieldProviderType

public int getFieldProviderType()

Description copied from interface: OwFieldProvider

get the type of field provider can be one or more of TYPE_...

Specified by:

getFieldProviderType in interface OwFieldProvider

getFieldProviderSource

public Object getFieldProviderSource()

Description copied from interface: OwFieldProvider

get the source object that originally provided the fields. e.g. the fieldprovider might be a template pattern implementation like a view, where the original provider would still be an OwObject

Specified by:

getFieldProviderSource in interface OwFieldProvider

Returns:

Object the original source object where the fields have been taken, can be a this pointer or null

getFieldProviderName

public String getFieldProviderName()

Description copied from interface: OwFieldProvider

get a name that identifies the field provider, e.g. the name of the underlying JSP page

Specified by:

getFieldProviderName in interface OwFieldProvider

Returns:

String unique ID / Name of fieldprovider, or null

setField

public void setField(String sName_p,
                     Object value_p)
              throws Exception,
                     OwObjectNotFoundException

modify a Field value, but does not save the value right away

Specified by:

setField in interface OwFieldProvider

Parameters:

sName_p -

value_p -

Throws:

Exception

OwObjectNotFoundException

getSafeFieldValue

public Object getSafeFieldValue(String sName_p,
                                Object defaultvalue_p)

retrieve the value of a Field

Specified by:

getSafeFieldValue in interface OwFieldProvider

Parameters:

sName_p -

defaultvalue_p -

Returns:

Object the value of the Field of defaultvalue_p

getFields

public Collection getFields()
                     throws Exception

get all the properties in the form

Specified by:

getFields in interface OwFieldProvider

Returns:

Collection of OwField

Throws:

Exception

getTitle

public String getTitle()

overridable title of the view

Specified by:

getTitle in interface OwBaseView

Overrides:

getTitle in class OwView

Returns:

String localized display name for the view

getIcon

public String getIcon()
               throws Exception

get the icon URL for this view to be displayed

Overrides:

getIcon in class OwView

Returns:

String icon url, or null if not defined

Throws:

Exception

getMimeManager

public OwMimeManager getMimeManager()

Get current OwMimeManager instance

Returns:

the associated OwMimeManager

renderPageSelector

public void renderPageSelector(Writer w_p)
                        throws Exception

Render the page selector

Parameters:

w_p -

Throws:

Exception

Since:

2.5.2.0