com.wewebu.ow.server.dmsdialogs.views

Class OwObjectListViewFilterRow

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

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

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

com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewFilterRow

All Implemented Interfaces:

OwClientRefreshContext, OwPageableView, OwFieldProvider, OwBaseView, OwUpdateTarget, EventListener

public class OwObjectListViewFilterRow
extends OwObjectListViewRow

Object list view. Displays the results of searches. In addition displays filter boxes to created filter search nodes.

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

Fields

Modifier and Type	Field and Description
static String	FILTER_OPERATOR_SELECT_ID
protected static String	FILTER_PROPERTY_KEY query key for the filter property
protected OwObjectListView.OwFilterEntry	m_currentfilter currently editable filter

Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewRow

m_ColumnInfoList, m_iCurrentPage, m_MainContext, m_occuredObjectTypes, m_RefreshContext, m_Sort, m_theFieldManager, m_useContextMenu

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, 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

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

Constructors

Constructor and Description
OwObjectListViewFilterRow() construct a object list view
OwObjectListViewFilterRow(int iViewMask_p) construct a object list view

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateNextFilter() activate (show) the next active filter
String	getChangeFilterOperatorURL()
OwObjectListView.OwFilterEntry	getCurrentFilter()
String	getEnableFilterURL()
String	getIcon() get the icon URL for this view to be displayed
String	getSetFilterValueURL()
String	getTitle() overridable title of the view
void	onChangeFilterOperator(javax.servlet.http.HttpServletRequest request_p) called when user changes a filter operator
void	onEditFilter(javax.servlet.http.HttpServletRequest request_p) called when user clicks on a filter icon
void	onEnableFilter(javax.servlet.http.HttpServletRequest request_p) called when user clicks on a filter enable button
void	onSetFilterValue(javax.servlet.http.HttpServletRequest request_p) called when user clicks on a filter value button
protected void	renderMainRegion(Writer w_p) render the view JSP
protected void	renderPropertyColumnHeader(Writer w_p, OwFieldColumnInfo colInfo_p) (overridable) render the property sort column
void	setFilter(OwObjectListView.OwFilter filter_p) set the filter to be used

Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewRow

computeEndIndex, computeStartIndex, createMimeManager, detach, getField, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getHtmlAlignment, getIsList, getIsListEmpty, getIsListValid, getIsPaging, getMimeManager, getPageAbsolutURL, getPageNextURL, getPagePrevURL, getRetrievalPropertyNames, getRowClassName, getSafeFieldValue, getSelectedRowClassName, getSortOrderImage, getSortOrderType, init, insertDocumentFunctionPluginHeader, insertDocumentFunctionPluginRows, isPagingEnabled, onAjaxPersistSelection, onColumnClickEvent, onContextMenuEvent, onMultiSelectEvent, onPluginEvent, onRender, onSelect, onSort, renderCheckedOut, renderExtraColumnHeader, renderExtraColumnRows, renderIndex, renderIndexHeader, renderLockedColumn, renderMimeType, renderMimeTypeHeader, renderPageSelector, renderProperties, renderPropertiesHeader, renderRows, renderSortHeader, renderTableCaption, renderVersion, renderVersionHeader, setField, setMimeTypeContext, setObjectIterable, setObjectList, setRefreshContext, updateExternalFormTarget, usesFormWithAttributes

Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewPluginCache

createPluginStatusCacheUtility, createPluginStatusCacheUtility, createPluginStatusCacheUtility, createPluginStatusCacheUtility, getPluginCache, setPluginCache

Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwPageableListView

canPageNext, canPagePrev, getColumnInfo, getCurrentPage, getDisplayedPage, getFieldManager, getObjectIterable, getObjectList, getPageAbsolutEventURL, getPageCount, getPageNextEventURL, getPagePrevEventURL, getPageSize, getRefreshContext, getSort, isCollectionComplete, onClientRefreshContextUpdate, onPageAbsolut, onPageNext, onPagePrev, pageAbsolut, setColumnInfo, setFieldManager, setSort

Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView

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, setConfigNode, setCurrentPage, setDocumentFunctionPluginList, setEventListner, 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, 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

FILTER_PROPERTY_KEY

protected static final String FILTER_PROPERTY_KEY

query key for the filter property

See Also:

Constant Field Values

FILTER_OPERATOR_SELECT_ID

public static final String FILTER_OPERATOR_SELECT_ID

See Also:

Constant Field Values

m_currentfilter

protected OwObjectListView.OwFilterEntry m_currentfilter

currently editable filter

Constructor Detail

OwObjectListViewFilterRow

public OwObjectListViewFilterRow(int iViewMask_p)

construct a object list view

Parameters:

iViewMask_p - int combination of VIEW_MASK_... defined flags

OwObjectListViewFilterRow

public OwObjectListViewFilterRow()

construct a object list view

Method Detail

renderPropertyColumnHeader

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

(overridable) render the property sort column

Overrides:

renderPropertyColumnHeader in class OwObjectListViewRow

Parameters:

w_p - java.io.Writer

colInfo_p - OwFieldColumnInfo

Throws:

Exception

setFilter

public void setFilter(OwObjectListView.OwFilter filter_p)

set the filter to be used

Overrides:

setFilter in class OwObjectListView

Parameters:

filter_p - an OwObjectListView.OwFilter

onEditFilter

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

called when user clicks on a filter icon

Throws:

Exception

onSetFilterValue

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

called when user clicks on a filter value button

Throws:

Exception

onChangeFilterOperator

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

called when user changes a filter operator

Throws:

Exception

onEnableFilter

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

called when user clicks on a filter enable button

Throws:

Exception

activateNextFilter

protected void activateNextFilter()

activate (show) the next active filter

renderMainRegion

protected void renderMainRegion(Writer w_p)
                         throws Exception

render the view JSP

Overrides:

renderMainRegion in class OwObjectListViewRow

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

getCurrentFilter

public OwObjectListView.OwFilterEntry getCurrentFilter()

getEnableFilterURL

public String getEnableFilterURL()

getSetFilterValueURL

public String getSetFilterValueURL()

getChangeFilterOperatorURL

public String getChangeFilterOperatorURL()

getTitle

public String getTitle()

overridable title of the view

Specified by:

getTitle in interface OwBaseView

Overrides:

getTitle in class OwObjectListViewRow

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 OwObjectListViewRow

Returns:

String icon URL, or null if not defined

Throws:

Exception