com.wewebu.ow.server.plug.owrecord

Class OwRecordSearchTemplateView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.ui.OwLayout

com.wewebu.ow.server.plug.owrecord.OwRecordSearchTemplateView

All Implemented Interfaces:

com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget

public class OwRecordSearchTemplateView
extends com.wewebu.ow.server.ui.OwLayout

View for the search template, to refine the child list of a open folder.

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.ui.OwLayout

com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion, com.wewebu.ow.server.ui.OwLayout.OwLayoutViewRefrence

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG_SEARCH_DUMP_REGION region for the search tree dump for debugging only
protected int	m_iMaxSizeMax the maximum size that is possible for the maximum size parameter
protected int	m_iSubmitBtnIndex index of the submit button
protected com.wewebu.ow.server.app.OwSubMenuView	m_MenuView the buttons for the search form
protected com.wewebu.ow.server.app.OwSearchCriteriaView	m_SearchCriteriaView view to display and edit the criteria
protected int	m_searchListSize new search max list size
protected com.wewebu.ow.server.field.OwSearchTemplate	m_searchtemplate currently set search template
static String	MAX_RESULT_LIST_KEY query string key for the result list size
static int	MAX_SIZE_REGION region of max size input box
static int	MENU_REGION region of the submit button
static int	SEARCH_CRITERIA_REGION region of the search criteria

Fields inherited from class com.wewebu.ow.server.ui.OwLayout

m_Regions

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

Constructors

Constructor and Description
OwRecordSearchTemplateView()

Method Summary

Methods

Modifier and Type	Method and Description
com.wewebu.ow.server.app.OwSearchCriteriaView	getCriteriaView() get the internal criteria view
int	getiMaxSizeMax()
protected void	init() init the target after the context is set.
boolean	isMaxResultEnabled()
void	onDoReset(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked DoReset
void	onDoSearch(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked the search submit button
protected void	onRender(Writer w_p) called when the view should create its HTML content to be displayed
void	onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p, int iCode_p, Object param_p) called by the framework to update the view when OwDocument.Update was called NOTE: We can not use the onRender method to update, because we do not know the call order of onRender.
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region
void	setiMaxSizeMax(int m_iMaxSizeMax)
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

Methods inherited from class com.wewebu.ow.server.ui.OwLayout

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion

Methods inherited from class com.wewebu.ow.server.ui.OwView

activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, render, renderHTMLFormular, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_CRITERIA_REGION

public static final int SEARCH_CRITERIA_REGION

region of the search criteria

See Also:

Constant Field Values

MENU_REGION

public static final int MENU_REGION

region of the submit button

See Also:

Constant Field Values

MAX_SIZE_REGION

public static final int MAX_SIZE_REGION

region of max size input box

See Also:

Constant Field Values

DEBUG_SEARCH_DUMP_REGION

public static final int DEBUG_SEARCH_DUMP_REGION

region for the search tree dump for debugging only

See Also:

Constant Field Values

MAX_RESULT_LIST_KEY

public static final String MAX_RESULT_LIST_KEY

query string key for the result list size

See Also:

Constant Field Values

m_iMaxSizeMax

protected int m_iMaxSizeMax

the maximum size that is possible for the maximum size parameter

m_SearchCriteriaView

protected com.wewebu.ow.server.app.OwSearchCriteriaView m_SearchCriteriaView

view to display and edit the criteria

m_searchtemplate

protected com.wewebu.ow.server.field.OwSearchTemplate m_searchtemplate

currently set search template

m_MenuView

protected com.wewebu.ow.server.app.OwSubMenuView m_MenuView

the buttons for the search form

m_iSubmitBtnIndex

protected int m_iSubmitBtnIndex

index of the submit button

m_searchListSize

protected int m_searchListSize

new search max list size

Constructor Detail

OwRecordSearchTemplateView

public OwRecordSearchTemplateView()

Method Detail

getCriteriaView

public com.wewebu.ow.server.app.OwSearchCriteriaView getCriteriaView()

get the internal criteria view

Returns:

OwSearchCriteriaView

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class com.wewebu.ow.server.ui.OwView

Throws:

Exception

onUpdate

public void onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p,
            int iCode_p,
            Object param_p)
              throws Exception

called by the framework to update the view when OwDocument.Update was called NOTE: We can not use the onRender method to update, because we do not know the call order of onRender. onUpdate is always called before all onRender methods.

Specified by:

onUpdate in interface com.wewebu.ow.server.ui.OwUpdateTarget

Overrides:

onUpdate in class com.wewebu.ow.server.ui.OwView

Parameters:

caller_p - OwEventTarget target that called update

iCode_p - int optional reason code

param_p - Object optional parameter representing the refresh, depends on the value of iCode_p, can be null

Throws:

Exception

onDoReset

public void onDoReset(javax.servlet.http.HttpServletRequest request_p,
             Object oReason_p)
               throws Exception

event called when user clicked DoReset

Parameters:

request_p - HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onDoSearch

public void onDoSearch(javax.servlet.http.HttpServletRequest request_p,
              Object oReason_p)
                throws Exception

event called when user clicked the search submit button

Parameters:

request_p - a HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onRender

protected void onRender(Writer w_p)
                 throws Exception

called when the view should create its HTML content to be displayed

Overrides:

onRender in class com.wewebu.ow.server.ui.OwView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

renderRegion

public void renderRegion(Writer w_p,
                int iRegion_p)
                  throws Exception

render the views of the region

Specified by:

renderRegion in interface com.wewebu.ow.server.ui.OwBaseView

Overrides:

renderRegion in class com.wewebu.ow.server.ui.OwLayout

Parameters:

w_p - Writer object to write HTML to

iRegion_p - ID of the region to render

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 com.wewebu.ow.server.ui.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

isMaxResultEnabled

public boolean isMaxResultEnabled()

getiMaxSizeMax

public int getiMaxSizeMax()

setiMaxSizeMax

public void setiMaxSizeMax(int m_iMaxSizeMax)