com.wewebu.ow.server.plug.owsearch

Class OwSearchTemplateView

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.owsearch.OwSearchTemplateView

All Implemented Interfaces:

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

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

Search Template View. Displays the search criteria.

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	BUTTON_REGION name of the button / menu region
static int	DEBUG_SEARCH_DUMP_REGION region for the search tree dump for debugging only
static int	DEFAULT_RESULT_SIZE Default result size if nothing is defined
static int	ERRORS_REGION errors region
protected int	m_iMaxSize max number of result items in a search
protected int	m_iMaxSizeMax the maximum size that is possible for the maximum size parameter
protected int	m_iResetBtnIndex
protected int	m_iSubmitBtnIndex index of the buttons
protected com.wewebu.ow.server.app.OwMaxMinButtonControlView	m_MaxMinButtonControlView View Module to display a maximize minimize button and maximize minimize the attached view
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 static String	MAX_RESULT_LIST_KEY query string key for the result list size
static int	MAX_SIZE_REGION name of the max size region
static int	MIN_MAX_CONTROL_VIEW name of the min max control region
protected static String	RESET_LABEL_ID
static int	SAVED_SEARCH_DELETE_BUTTON_REGION delete search button
static int	SAVED_SEARCHES_SELECT_REGION name of the searches selection
protected static String	SEARCH_LABEL_ID
static int	TEMPLATE_REGION name of the template region

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
OwSearchTemplateView()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.wewebu.ow.server.app.OwSearchCriteriaView	createSearchCriteriaView() overridable factory method
protected int	getQueryMaxSize() Get query max size for search process.
String	getTitle() overridable title of the view
protected void	init() init the view after the context is set.
protected boolean	isEnabledStoredSearch() Enable/Disable stored searches feature
protected boolean	isPageable() True to enable Paging capability, by default false
boolean	isRegion(int region_p)
protected void	onActivate(int iIndex_p, Object oReason_p) activate the view from a navigation module.
void	onDeleteSearch(javax.servlet.http.HttpServletRequest request_p) event called when user clicked delete search
void	onDoReset(javax.servlet.http.HttpServletRequest request_p)
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)
void	onDoSearch(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked DoSearch
protected void	onRender(Writer w_p) render the view
void	onSelectSavedSearch(javax.servlet.http.HttpServletRequest request_p) event called when user changes the selection of saved searches
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region
protected void	setQueryMaxSize(int newMax_p) Set maximum query size for search process.
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 void	updateSearchCriteriaView(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p) update Search Criteria View, do not clear search criteria parameters
protected void	updateSearchTemplate(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p) set and init a search template
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.ui.OwLayout

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, 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, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onUpdate, render, renderHTMLFormular, 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

Field Detail

MAX_SIZE_REGION

public static final int MAX_SIZE_REGION

name of the max size region

See Also:

Constant Field Values

BUTTON_REGION

public static final int BUTTON_REGION

name of the button / menu region

See Also:

Constant Field Values

TEMPLATE_REGION

public static final int TEMPLATE_REGION

name of the template region

See Also:

Constant Field Values

MIN_MAX_CONTROL_VIEW

public static final int MIN_MAX_CONTROL_VIEW

name of the min max control region

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

SAVED_SEARCHES_SELECT_REGION

public static final int SAVED_SEARCHES_SELECT_REGION

name of the searches selection

See Also:

Constant Field Values

SAVED_SEARCH_DELETE_BUTTON_REGION

public static final int SAVED_SEARCH_DELETE_BUTTON_REGION

delete search button

See Also:

Constant Field Values

DEFAULT_RESULT_SIZE

public static final int DEFAULT_RESULT_SIZE

Default result size if nothing is defined

Since:

4.0.0.1

See Also:

Constant Field Values

ERRORS_REGION

public static final int ERRORS_REGION

errors region

See Also:

Constant Field Values

MAX_RESULT_LIST_KEY

protected static final String MAX_RESULT_LIST_KEY

query string key for the result list size

See Also:

Constant Field Values

SEARCH_LABEL_ID

protected static final String SEARCH_LABEL_ID

See Also:

Constant Field Values

RESET_LABEL_ID

protected static final String RESET_LABEL_ID

See Also:

Constant Field Values

m_iMaxSizeMax

protected int m_iMaxSizeMax

the maximum size that is possible for the maximum size parameter

m_iMaxSize

protected int m_iMaxSize

max number of result items in a search

m_MenuView

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

the buttons for the search form

m_MaxMinButtonControlView

protected com.wewebu.ow.server.app.OwMaxMinButtonControlView m_MaxMinButtonControlView

View Module to display a maximize minimize button and maximize minimize the attached view

m_SearchCriteriaView

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

view to display and edit the criteria

m_iSubmitBtnIndex

protected int m_iSubmitBtnIndex

index of the buttons

m_iResetBtnIndex

protected int m_iResetBtnIndex

Constructor Detail

OwSearchTemplateView

public OwSearchTemplateView()

Method Detail

init

protected void init()
             throws Exception

init the view after the context is set.

Overrides:

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

Throws:

Exception

getTitle

public String getTitle()

overridable title of the view

Specified by:

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

Overrides:

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

Returns:

String localized display name for the view

onActivate

protected void onActivate(int iIndex_p,
              Object oReason_p)
                   throws Exception

activate the view from a navigation module. Called when view gets displayed

Overrides:

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

Parameters:

iIndex_p - int index of Navigation

oReason_p - User Object which was submitted when view was attached to the navigation module

Throws:

Exception

updateSearchCriteriaView

protected void updateSearchCriteriaView(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p)
                                 throws Exception

update Search Criteria View, do not clear search criteria parameters

Parameters:

templateObject_p -

Throws:

Exception

Since:

3.1.0.0

updateSearchTemplate

protected void updateSearchTemplate(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p)
                             throws Exception

set and init a search template

Parameters:

templateObject_p -

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

Returns:

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

onRender

protected void onRender(Writer w_p)
                 throws Exception

render the view

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

isRegion

public boolean isRegion(int region_p)

Specified by:

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

Overrides:

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

onDeleteSearch

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

event called when user clicked delete search

Parameters:

request_p - an HttpServletRequest

Throws:

Exception

onSelectSavedSearch

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

event called when user changes the selection of saved searches

Parameters:

request_p - an HttpServletRequest

Throws:

Exception

onDoReset

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

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 - an HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onDoSearch

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

Throws:

Exception

onDoSearch

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

event called when user clicked DoSearch

Parameters:

request_p - an HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

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

createSearchCriteriaView

protected com.wewebu.ow.server.app.OwSearchCriteriaView createSearchCriteriaView()

overridable factory method

Returns:

OwSearchCriteriaView instance

isEnabledStoredSearch

protected boolean isEnabledStoredSearch()

Enable/Disable stored searches feature

Returns:

true

Since:

3.1.0.0

isPageable

protected boolean isPageable()

True to enable Paging capability, by default false

Returns:

true

Since:

4.2.0.0

getQueryMaxSize

protected int getQueryMaxSize()

Get query max size for search process.

Returns:

integer defining max allowed results

Since:

4.0.0.1

setQueryMaxSize

protected void setQueryMaxSize(int newMax_p)
                        throws com.wewebu.ow.server.exceptions.OwInvalidOperationException

Set maximum query size for search process.

Provided value will be checked against limits values.
if the configured maximum is reached or negative definition is provided an exception will be thrown.

Parameters:

newMax_p - int new maximum

Throws:

com.wewebu.ow.server.exceptions.OwInvalidOperationException

Since:

4.0.0.1