com.wewebu.ow.server.plug.owsearch
Class OwResultListView

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.ui.OwLayout
              extended by com.wewebu.ow.server.plug.owsearch.OwResultListView
All Implemented Interfaces:
com.wewebu.ow.server.app.OwClientRefreshContext, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

public class OwResultListView
extends com.wewebu.ow.server.ui.OwLayout
implements com.wewebu.ow.server.app.OwClientRefreshContext

Result list view, which contains a OwObjectListView to display the search results.

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
 
Field Summary
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_NewSearchMenuView
          the buttons for the search form
static int MIN_MAX_CONTROL_VIEW
          name of the min max control region
static int NEW_SAVED_SEARCH_REGION
          name of the new search field
static int NEW_SEARCH_BUTTON_REGION
          new search button
static int OBJECT_LIST_CONTROL_REGION
          name of the max object list control region
static int OBJECT_LIST_REGION
          name of the max size 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
OwResultListView()
           
 
Method Summary
protected  com.wewebu.ow.server.ui.button.OwUnifyImageButtonView createButtonView()
          (overridable) Factory method for button component/view.
protected  com.wewebu.ow.server.app.OwMaxMinButtonControlView createMaxMinButtonControlView(com.wewebu.ow.server.ui.OwView view)
          (overridable) Factory method for maximize/minimize control view.
protected  com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewControl createObjectListViewControl()
          (overridable) Factory method for list view control.
 String getBackToSearchTemplateURL()
          get a URL for the back to template button
protected  com.wewebu.ow.server.ui.button.OwUnifyImageButtonView getButtonView()
           
 boolean getCanGoBackToSearchTemplate()
          check if a go back button should be displayed
 int getCount()
          get the result list count
 boolean getIsComplete()
          check if result list could be retrieved completely
 com.wewebu.ow.server.dmsdialogs.views.OwObjectListView getObjectListView()
          get the reference to the object list view contained in the result list
 Object getSafeListAttribute(String attributeName_p, Object default_p)
          get a result list attribute
 String getTemplateDisplayName()
          Returns the display name of the calling search template in localized form.
If display name can't retrieved, the method will return an empty string.
 String getTitle()
          overridable title of the view
protected  void informUserOnSave()
          Post a message for informing user about a successfully save operation.
protected  void init()
          initialize the target after the context is set.
 boolean isEnabledStoredSearch()
          Enable/Disable stored searches feature
 boolean isNamedRegion(String strRegion_p)
          determine if region exists
 boolean isRegion(int region_p)
           
 void onBackToTemplate(javax.servlet.http.HttpServletRequest request_p)
          called when user clicks the back to template button the focus will return to the calling search template
 void onClientRefreshContextUpdate(int reason_p, Object param_p)
           
protected  void onRender(Writer w_p)
          render the view
 void onSaveNewSearch(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)
          event called when user clicked SaveNewSearch
 void renderNamedRegion(Writer w_p, String strRegion_p)
          render only a region in the view, used by derived classes render the attribute from the result list
 void renderRegion(Writer w_p, int iRegion_p)
          render the views of the region
protected  String usesFormWithAttributes()
           
 
Methods inherited from class com.wewebu.ow.server.ui.OwLayout
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal
 
Methods inherited from class com.wewebu.ow.server.ui.OwView
activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isShowMaximized, isShowMinimized, isShowNormal, onActivate, 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, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OBJECT_LIST_REGION

public static final int OBJECT_LIST_REGION
name of the max size 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

OBJECT_LIST_CONTROL_REGION

public static final int OBJECT_LIST_CONTROL_REGION
name of the max object list control region

See Also:
Constant Field Values

NEW_SAVED_SEARCH_REGION

public static final int NEW_SAVED_SEARCH_REGION
name of the new search field

See Also:
Constant Field Values

NEW_SEARCH_BUTTON_REGION

public static final int NEW_SEARCH_BUTTON_REGION
new search button

See Also:
Constant Field Values

m_NewSearchMenuView

protected com.wewebu.ow.server.app.OwSubMenuView m_NewSearchMenuView
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

Constructor Detail

OwResultListView

public OwResultListView()
Method Detail

init

protected void init()
             throws Exception
initialize the target after the context is set.

Overrides:
init in class com.wewebu.ow.server.ui.OwView
Throws:
Exception

usesFormWithAttributes

protected String usesFormWithAttributes()
Overrides:
usesFormWithAttributes in class com.wewebu.ow.server.ui.OwView

onSaveNewSearch

public void onSaveNewSearch(javax.servlet.http.HttpServletRequest request_p,
                            Object oReason_p)
                     throws Exception
event called when user clicked SaveNewSearch

Parameters:
request_p - a HttpServletRequest
oReason_p - Reason object submitted in the menu item creation
Throws:
Exception

getObjectListView

public com.wewebu.ow.server.dmsdialogs.views.OwObjectListView getObjectListView()
get the reference to the object list view contained in the result list

Returns:
OwObjectListView

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

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

renderNamedRegion

public void renderNamedRegion(Writer w_p,
                              String strRegion_p)
                       throws Exception
render only a region in the view, used by derived classes render the attribute from the result list

Specified by:
renderNamedRegion in interface com.wewebu.ow.server.ui.OwBaseView
Overrides:
renderNamedRegion in class com.wewebu.ow.server.ui.OwLayout
Parameters:
w_p - Writer object to write HTML to
strRegion_p - named region to render
Throws:
Exception

getSafeListAttribute

public Object getSafeListAttribute(String attributeName_p,
                                   Object default_p)
get a result list attribute

Parameters:
attributeName_p - String name of attribute as defined with OwObjectCollection.ATTRIBUTE_...
default_p - Object default value if not found
Returns:
Object value of attribute, return default_p if no object list available for the view (not initialized yet, not called yet...)

isNamedRegion

public boolean isNamedRegion(String strRegion_p)
                      throws Exception
determine if region exists

Specified by:
isNamedRegion in interface com.wewebu.ow.server.ui.OwBaseView
Overrides:
isNamedRegion in class com.wewebu.ow.server.ui.OwView
Parameters:
strRegion_p - name of the region to render
Returns:
true if region contains anything and should be rendered
Throws:
Exception

getBackToSearchTemplateURL

public String getBackToSearchTemplateURL()
get a URL for the back to template button


getCanGoBackToSearchTemplate

public boolean getCanGoBackToSearchTemplate()
check if a go back button should be displayed


getCount

public int getCount()
get the result list count


getIsComplete

public boolean getIsComplete()
check if result list could be retrieved completely

Returns:
boolean true = all items are retrieved, false = there are more items on the server, only some are shown

onBackToTemplate

public void onBackToTemplate(javax.servlet.http.HttpServletRequest request_p)
                      throws Exception
called when user clicks the back to template button the focus will return to the calling search template

Throws:
Exception

getTemplateDisplayName

public String getTemplateDisplayName()
Returns the display name of the calling search template in localized form.
If display name can't retrieved, the method will return an empty string.

Returns:
the display name of the calling search template

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

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

onClientRefreshContextUpdate

public void onClientRefreshContextUpdate(int reason_p,
                                         Object param_p)
                                  throws Exception
Specified by:
onClientRefreshContextUpdate in interface com.wewebu.ow.server.app.OwClientRefreshContext
Throws:
Exception

informUserOnSave

protected void informUserOnSave()
Post a message for informing user about a successfully save operation.


isEnabledStoredSearch

public boolean isEnabledStoredSearch()
Enable/Disable stored searches feature

Returns:
true
Since:
3.1.0.0

createObjectListViewControl

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewControl createObjectListViewControl()
(overridable) Factory method for list view control.

Returns:
OwObjectListViewControl
Since:
4.1.0.0

createMaxMinButtonControlView

protected com.wewebu.ow.server.app.OwMaxMinButtonControlView createMaxMinButtonControlView(com.wewebu.ow.server.ui.OwView view)
(overridable) Factory method for maximize/minimize control view.

Returns:
OwMaxMinButtonControlView
Since:
4.1.0.0

createButtonView

protected com.wewebu.ow.server.ui.button.OwUnifyImageButtonView createButtonView()
(overridable) Factory method for button component/view.

Returns:
OwUnifyImageButtonView
Since:
4.1.0.0

getButtonView

protected com.wewebu.ow.server.ui.button.OwUnifyImageButtonView getButtonView()


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.