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
Modifier and Type | Field and Description |
---|---|
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
|
Constructor and Description |
---|
OwResultListView() |
Modifier and Type | Method and Description |
---|---|
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() |
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal
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
public static final int OBJECT_LIST_REGION
public static final int MIN_MAX_CONTROL_VIEW
public static final int OBJECT_LIST_CONTROL_REGION
public static final int NEW_SAVED_SEARCH_REGION
public static final int NEW_SEARCH_BUTTON_REGION
protected com.wewebu.ow.server.app.OwSubMenuView m_NewSearchMenuView
protected com.wewebu.ow.server.app.OwMaxMinButtonControlView m_MaxMinButtonControlView
protected void init() throws Exception
init
in class com.wewebu.ow.server.ui.OwView
Exception
protected String usesFormWithAttributes()
usesFormWithAttributes
in class com.wewebu.ow.server.ui.OwView
public void onSaveNewSearch(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) throws Exception
request_p
- a HttpServletRequest
oReason_p
- Reason object submitted in the menu item creationException
public com.wewebu.ow.server.dmsdialogs.views.OwObjectListView getObjectListView()
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 String getTitle()
getTitle
in interface com.wewebu.ow.server.ui.OwBaseView
getTitle
in class com.wewebu.ow.server.ui.OwView
public void renderNamedRegion(Writer w_p, String strRegion_p) throws Exception
renderNamedRegion
in interface com.wewebu.ow.server.ui.OwBaseView
renderNamedRegion
in class com.wewebu.ow.server.ui.OwLayout
w_p
- Writer object to write HTML tostrRegion_p
- named region to renderException
public Object getSafeListAttribute(String attributeName_p, Object default_p)
attributeName_p
- String name of attribute as defined with OwObjectCollection.ATTRIBUTE_...default_p
- Object default value if not foundpublic boolean isNamedRegion(String strRegion_p) throws Exception
isNamedRegion
in interface com.wewebu.ow.server.ui.OwBaseView
isNamedRegion
in class com.wewebu.ow.server.ui.OwView
strRegion_p
- name of the region to renderException
public String getBackToSearchTemplateURL()
public boolean getCanGoBackToSearchTemplate()
public int getCount()
public boolean getIsComplete()
public void onBackToTemplate(javax.servlet.http.HttpServletRequest request_p) throws Exception
Exception
public String getTemplateDisplayName()
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
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 onClientRefreshContextUpdate(int reason_p, Object param_p) throws Exception
onClientRefreshContextUpdate
in interface com.wewebu.ow.server.app.OwClientRefreshContext
Exception
protected void informUserOnSave()
public boolean isEnabledStoredSearch()
protected com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewControl createObjectListViewControl()
protected com.wewebu.ow.server.app.OwMaxMinButtonControlView createMaxMinButtonControlView(com.wewebu.ow.server.ui.OwView view)
protected com.wewebu.ow.server.ui.button.OwUnifyImageButtonView createButtonView()
protected com.wewebu.ow.server.ui.button.OwUnifyImageButtonView getButtonView()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.