com.wewebu.ow.server.plug.owsearch

Class OwSearchView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.app.OwMasterView

com.wewebu.ow.server.plug.owsearch.OwSearchView

All Implemented Interfaces:

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

public class OwSearchView
extends com.wewebu.ow.server.app.OwMasterView

Search View Module.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERSIST_SEARCHTEMPLATE_ATTRIBUTE_NAME attribute name of last used search template

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

Method Summary

Methods

Modifier and Type	Method and Description
protected OwResultListView	createResultListView() overridable factory method
protected OwSearchTemplateView	createSearchTemplateView() overridable factory method
protected com.wewebu.ow.server.app.OwSubLayout	createSubLayout() overridable factory method
protected com.wewebu.ow.server.app.OwSubNavigationView	createSubNavigationView() overridable factory method
String	getBreadcrumbPart()
com.wewebu.ow.server.dmsdialogs.views.OwObjectListView	getObjectListView() get the reference to the result list view to display the search results
protected void	init() init the target after the context is set.
void	navigate(String searchTemplateName_p) Navigate to the given search template, parameter should reflect the name (non-localized) of wanted template.
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	updateSearchCriteria(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p) Update search Criteria View
void	updateSearchTemplateView(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p) Update search TemplareView

Methods inherited from class com.wewebu.ow.server.app.OwMasterView

getConfigNode, getConfiguration, getDialogManager, getIcon, getPlugin, getPluginID, getTitle, onActivate

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

activate, addView, detach, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onRender, render, renderHTMLFormular, renderNamedRegion, renderRegion, 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, updateExternalFormTarget

Methods inherited from class java.lang.Object

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

Field Detail

PERSIST_SEARCHTEMPLATE_ATTRIBUTE_NAME

public static final String PERSIST_SEARCHTEMPLATE_ATTRIBUTE_NAME

attribute name of last used search template

See Also:

Constant Field Values

Constructor Detail

OwSearchView

public OwSearchView()

Method Detail

navigate

public void navigate(String searchTemplateName_p)
              throws com.wewebu.ow.server.exceptions.OwObjectNotFoundException

Navigate to the given search template, parameter should reflect the name (non-localized) of wanted template.

Parameters:

searchTemplateName_p - String name of template to select

Throws:

com.wewebu.ow.server.exceptions.OwObjectNotFoundException - if search template not found

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class com.wewebu.ow.server.app.OwMasterView

Throws:

Exception

getObjectListView

public com.wewebu.ow.server.dmsdialogs.views.OwObjectListView getObjectListView()

get the reference to the result list view to display the search results

Returns:

OwObjectListView

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

createSubNavigationView

protected com.wewebu.ow.server.app.OwSubNavigationView createSubNavigationView()

overridable factory method

Returns:

OwSubNavigationView instance

createSubLayout

protected com.wewebu.ow.server.app.OwSubLayout createSubLayout()

overridable factory method

Returns:

OwSubLayout instance

createSearchTemplateView

protected OwSearchTemplateView createSearchTemplateView()

overridable factory method

Returns:

OwSearchTemplateView instance

createResultListView

protected OwResultListView createResultListView()

overridable factory method

Returns:

OwResultListView instance

updateSearchCriteria

public void updateSearchCriteria(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p)
                          throws Exception

Update search Criteria View

Parameters:

templateObject_p -

Throws:

Exception

Since:

3.1.0.0

updateSearchTemplateView

public void updateSearchTemplateView(com.wewebu.ow.server.field.OwSearchTemplate templateObject_p)
                              throws Exception

Update search TemplareView

Parameters:

templateObject_p -

Throws:

Exception

getBreadcrumbPart

public String getBreadcrumbPart()

Specified by:

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

Overrides:

getBreadcrumbPart in class com.wewebu.ow.server.app.OwMasterView