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
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
|
Constructor and Description |
---|
OwSearchTemplateView() |
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.
|
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
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
public static final int MAX_SIZE_REGION
public static final int BUTTON_REGION
public static final int TEMPLATE_REGION
public static final int MIN_MAX_CONTROL_VIEW
public static final int DEBUG_SEARCH_DUMP_REGION
public static final int SAVED_SEARCHES_SELECT_REGION
public static final int SAVED_SEARCH_DELETE_BUTTON_REGION
public static final int DEFAULT_RESULT_SIZE
public static final int ERRORS_REGION
protected static final String MAX_RESULT_LIST_KEY
protected static final String SEARCH_LABEL_ID
protected static final String RESET_LABEL_ID
protected int m_iMaxSizeMax
protected int m_iMaxSize
protected com.wewebu.ow.server.app.OwSubMenuView m_MenuView
protected com.wewebu.ow.server.app.OwMaxMinButtonControlView m_MaxMinButtonControlView
protected com.wewebu.ow.server.app.OwSearchCriteriaView m_SearchCriteriaView
protected int m_iSubmitBtnIndex
protected int m_iResetBtnIndex
protected void init() throws Exception
init
in class com.wewebu.ow.server.ui.OwView
Exception
public String getTitle()
getTitle
in interface com.wewebu.ow.server.ui.OwBaseView
getTitle
in class com.wewebu.ow.server.ui.OwView
protected void onActivate(int iIndex_p, Object oReason_p) throws Exception
onActivate
in class com.wewebu.ow.server.ui.OwView
iIndex_p
- int
index of NavigationoReason_p
- User Object which was submitted when view was attached to the navigation moduleException
protected void updateSearchCriteriaView(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p) throws Exception
templateObject_p
- Exception
protected void updateSearchTemplate(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p) throws Exception
templateObject_p
- Exception
protected String usesFormWithAttributes()
usesFormWithAttributes
in class com.wewebu.ow.server.ui.OwView
protected void onRender(Writer w_p) throws Exception
onRender
in class com.wewebu.ow.server.ui.OwView
w_p
- Writer object to write HTML toException
public void renderRegion(Writer w_p, int iRegion_p) throws Exception
renderRegion
in interface com.wewebu.ow.server.ui.OwBaseView
renderRegion
in class com.wewebu.ow.server.ui.OwLayout
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
public boolean isRegion(int region_p)
isRegion
in interface com.wewebu.ow.server.ui.OwBaseView
isRegion
in class com.wewebu.ow.server.ui.OwLayout
public void onDeleteSearch(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- an HttpServletRequest
Exception
public void onSelectSavedSearch(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- an HttpServletRequest
Exception
public void onDoReset(javax.servlet.http.HttpServletRequest request_p) throws Exception
Exception
public void onDoReset(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) throws Exception
request_p
- an HttpServletRequest
oReason_p
- Reason object submitted in the menu item creationException
public void onDoSearch(javax.servlet.http.HttpServletRequest request_p) throws Exception
Exception
public void onDoSearch(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) throws Exception
request_p
- an HttpServletRequest
oReason_p
- Reason object submitted in the menu item creationException
public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p, boolean fSave_p) throws Exception
updateExternalFormTarget
in class com.wewebu.ow.server.ui.OwEventTarget
request_p
- HttpServletRequestfSave_p
- boolean true = save the changes of the form data, false = just update the form data, but do not saveException
protected com.wewebu.ow.server.app.OwSearchCriteriaView createSearchCriteriaView()
protected boolean isEnabledStoredSearch()
protected boolean isPageable()
protected int getQueryMaxSize()
protected void setQueryMaxSize(int newMax_p) throws com.wewebu.ow.server.exceptions.OwInvalidOperationException
Provided value will be checked against limits values.
if the configured maximum is reached or negative definition
is provided an exception will be thrown.
newMax_p
- int new maximumcom.wewebu.ow.server.exceptions.OwInvalidOperationException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.