com.wewebu.ow.server.dmsdialogs.views

Class OwObjectListViewControl

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.ui.button.OwImageButtonView

com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewControl

All Implemented Interfaces:

OwBaseView, OwUpdateTarget

public class OwObjectListViewControl
extends OwImageButtonView

Control that selects different object list views.

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

Modifier and Type	Class and Description
static class	OwObjectListViewControl.OwListViewEntry A list view item reference entry.
static interface	OwObjectListViewControl.OwObjectListViewControlEventListener Event listener interface.

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	activateListView() activate the persistent index or the first one if no persistance is used
void	activateListView(int iNewIndex_p) activate the selected list view index
List<OwImageButton>	getButtonList() Get a list of buttons which should be rendered.
int	getCurrentIndex() getter method for referencing in JSP files
List<OwObjectListViewControl.OwListViewEntry>	getObjectLists() getter method for referencing in JSP files
OwObjectListView	getObjectListView()
String	getObjectListViewControlEventURL(int iViewIndex_p) getter method for referencing in JSP files
OwBaseView	getViewReference() get the reference to the active list view
void	init() init the target after the context is set.
boolean	isShowMaximized() checks if the view is shown maximized
void	onRender(Writer w_p) render a button for each list view
void	onSelect(javax.servlet.http.HttpServletRequest request_p) event called when user selects a list view
void	renderButtons(Writer w_p)
void	setConfigNode(Node subNode_p) set the config node to use
void	setDocumentFunctionPluginList(List pluginList_p) Set a java.util.List of OwDocumentFunction to be used by this list.
void	setEventListener(OwObjectListViewControl.OwObjectListViewControlEventListener eventlistner_p) set event listener for callbacks

Methods inherited from class com.wewebu.ow.server.ui.button.OwImageButtonView

getDesignClasses, getHtmlId, setHtmlId

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

activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMinimized, isShowNormal, onActivate, onUpdate, 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

Constructor Detail

OwObjectListViewControl

public OwObjectListViewControl()

Method Detail

setEventListener

public void setEventListener(OwObjectListViewControl.OwObjectListViewControlEventListener eventlistner_p)

set event listener for callbacks

init

public void init()
          throws Exception

Description copied from class: OwView

init the target after the context is set.

Overrides:

init in class OwImageButtonView

Throws:

Exception

isShowMaximized

public boolean isShowMaximized()

checks if the view is shown maximized

Overrides:

isShowMaximized in class OwView

Returns:

true, if view is maximized, false otherwise

getViewReference

public OwBaseView getViewReference()

get the reference to the active list view

getObjectListView

public OwObjectListView getObjectListView()

setDocumentFunctionPluginList

public void setDocumentFunctionPluginList(List pluginList_p)

Set a java.util.List of OwDocumentFunction to be used by this list. This list overrides the default set of document functions that are retrieved from the context during init.

Parameters:

pluginList_p - the java.util.List of OwDocumentFunction to be used by this list. Must not be null.

getObjectLists

public List<OwObjectListViewControl.OwListViewEntry> getObjectLists()

getter method for referencing in JSP files

getCurrentIndex

public int getCurrentIndex()

getter method for referencing in JSP files

getObjectListViewControlEventURL

public String getObjectListViewControlEventURL(int iViewIndex_p)

getter method for referencing in JSP files

Parameters:

iViewIndex_p - index of the current view

onRender

public void onRender(Writer w_p)
              throws Exception

render a button for each list view

Overrides:

onRender in class OwImageButtonView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

renderButtons

public void renderButtons(Writer w_p)
                   throws Exception

Throws:

Exception

onSelect

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

event called when user selects a list view

Parameters:

request_p -

Throws:

Exception

activateListView

public void activateListView()
                      throws Exception

activate the persistent index or the first one if no persistance is used

Throws:

Exception

activateListView

public void activateListView(int iNewIndex_p)
                      throws Exception

activate the selected list view index

Parameters:

iNewIndex_p -

Throws:

Exception

setConfigNode

public void setConfigNode(Node subNode_p)
                   throws Exception

set the config node to use

Parameters:

subNode_p - a Node

Throws:

Exception

getButtonList

public List<OwImageButton> getButtonList()

Description copied from class: OwImageButtonView

Get a list of buttons which should be rendered.

Overrides:

getButtonList in class OwImageButtonView

Returns:

List