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

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
                  extended by com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewEXTJSGrid
                      extended by com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewFilterEXTJSGrid
All Implemented Interfaces:
OwPageableView, OwFieldProvider, OwBaseView, OwUpdateTarget

public class OwObjectListViewFilterEXTJSGrid
extends OwObjectListViewEXTJSGrid

ExtJS Object list view. Displays the results of searches with Ajax technologies. 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.OwObjectListViewEXTJSGrid
OwObjectListViewEXTJSGrid.OwAjaxColumnEntry, OwObjectListViewEXTJSGrid.OwColumnInfoBagValue
 
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
static String FILTER_OPERATOR_SELECT_ID
           
protected  OwObjectListView.OwFilterEntry m_currentfilter
          currently editable filter
 
Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewEXTJSGrid
AJAX_PARAM_COLUMN, AJAX_PARAM_ROW, COLUMNS_ID_ATTR_BAG, DATATYPE_BOOLEAN, DATATYPE_DATE, DATATYPE_DOUBLE, DATATYPE_ENUM, DATATYPE_INTEGER, DATATYPE_NOTE, DATATYPE_STRING, DATATYPE_UNKNOWN, DEFAULT_COLUMN_WIDTH, END_ACTION_ID, FIRST_PAGE_ACTION_ID, ICON_WIDTH, LAST_PAGE_ACTION_ID, m_AjaxColnameToPropertyMap, m_FieldManager, m_isNoteEditable, m_ObjectList, m_useTransparentIcon, MAX_COLUMN_WIDTH, MIN_COLUMN_WIDTH, OBJECT_INDEX_KEY, occuringObjectTypes, PLUG_INDEX_KEY, pluginCacheCreated, POS1_ACTION_ID, READ_ONLY_COLUMNS_NODE_NAME, SPECIAL_CHARS, TOOLTIP_BLOCK_TOKEN_PROPERTY_END, TOOLTIP_BLOCK_TOKEN_PROPERTY_END_CHAR, TOOLTIP_BLOCK_TOKEN_PROPERTY_START, VIEWER_SERVLET_REPLACE_TOKEN_BASEURL, VIEWER_SERVLET_REPLACE_TOKEN_DMSID, VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_ENCODE_CHAR, VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_END, VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_JSENCODE_CHAR, VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_NOENCODE_CHAR, VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_START, VIEWER_SERVLET_REPLACE_TOKEN_SERVERURL
 
Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView
m_HtmlAlignments, m_isStickyFooterInUse, m_pageSelectorComponent, m_pagingNode, MULTISELECT_COMOBO_MENU_NAME, 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
OwObjectListViewFilterEXTJSGrid()
          construct a object list view
OwObjectListViewFilterEXTJSGrid(int iViewMask_p)
          construct a object list view
 
Method Summary
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)
          (overridable) render the JSP page
 void setFilter(OwObjectListView.OwFilter filter_p)
          set the filter to be used
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.OwObjectListViewEXTJSGrid
computeEndIndex, convertDateFormat, createMimeManager, detach, encodeJsonString, getAjaxColumns, getColumnDataType, getColumnInfo, getCount, getCurrentPage, getDateInTransportFormat, getDocumentInstanceFunctionPluginLinks, getEncodedPropertyValue, getField, getFieldManager, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getLoadingMessage, getMimeManager, getObjectInstancePluginList, getObjectList, getPageCount, getReadOnlyColumns, getRefreshContext, getRetrievalPropertyNames, getRowClassName, getSafeFieldValue, getShowPaging, getSort, getStartRow, getToolTipPattern, getTooltipUrl, hasToolTipPattern, init, isConfiguredAsReadOnly, isNoteEditable, isNoteProperty, isPhpSpecialChar, isPropertyEditable, onAjaxgetColumnInfo, onAjaxgetContextmenu, onAjaxgetEnumInfo, onAjaxPersistSelection, onAjaxReadList, onAjaxsetCellData, onAjaxsetColumnInfo, onPluginEvent, onRender, pageAbsolut, processOccurred, setColumnInfo, setConfigNode, setField, setFieldManager, setNoteEditable, setObjectList, setRefreshContext, setSort, showsContextMenuPlugin
 
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, canPageNext, canPagePrev, clearViewMask, copy, createFilter, createFilter, createFilter, createPageSelector, getContextMenuFunction, getDocumentFunction, getDocumentFunctionPluginList, getEventListner, getFilter, getFilterOperators, getFilterSearch, getListViewID, getPageAbsolutEventURL, getPageNextEventURL, getPagePrevEventURL, getParentObject, getPluginEntries, hasPaging, hasViewMask, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isPagingEnabled, isStickyFooterInUse, onPageAbsolut, onPageNext, onPagePrev, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, 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, 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, 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, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion
 

Field Detail

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

OwObjectListViewFilterEXTJSGrid

public OwObjectListViewFilterEXTJSGrid(int iViewMask_p)
construct a object list view

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

OwObjectListViewFilterEXTJSGrid

public OwObjectListViewFilterEXTJSGrid()
construct a object list view

Method Detail

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
(overridable) render the JSP page

Overrides:
renderMainRegion in class OwObjectListViewEXTJSGrid
Parameters:
w_p - Writer to write 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 OwObjectListViewEXTJSGrid
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 OwObjectListViewEXTJSGrid
Returns:
String icon URL, or null if not defined
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


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.