com.wewebu.ow.server.plug.owsettings

Class OwSettingsSetView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.ui.OwLayout

com.wewebu.ow.server.plug.owsettings.OwSettingsSetView

All Implemented Interfaces:

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

public class OwSettingsSetView
extends com.wewebu.ow.server.ui.OwLayout

Settings Set View.

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, com.wewebu.ow.server.ui.OwLayout.OwLayoutViewRefrence

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_REGION name of the button / menu region
static int	ERRORS_REGION Errors region
protected static String	HELP_PATH
protected boolean	m_fAdmin has user admin rights ?
protected com.wewebu.ow.server.app.OwSubMenuView	m_MenuView the buttons for the search form
protected com.wewebu.ow.server.app.OwSettings	m_Settings reference to the settings
protected com.wewebu.ow.server.app.OwSettingsSet	m_settingsSet settingset node of the selected plugin
protected List	m_UserItemList list with user items
static int	MAIN_REGION name of the button / menu 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

Constructors

Constructor and Description
OwSettingsSetView()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	init() called when the view should create its HTML content to be displayed
protected void	onActivate(int iIndex_p, Object oReason_p) activate the target from a navigation module.
void	onApply(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked apply
void	onOpenHelp(javax.servlet.http.HttpServletRequest request_p) called when user clicked a help icon
protected void	onRender(Writer w_p) render the view
void	onReset(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked Reset
protected void	renderErrorsRegion(Writer w_p) Render errors regions, if there are any errors.
protected void	renderMainRegion(Writer w_p) called when the view should create its HTML content to be displayed
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region
protected void	renderSettingsSet(Writer w_p, boolean fUser_p) render the view
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 String	usesFormWithAttributes() to get additional form attributes used for the form override if your view needs a form.

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

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion

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

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

Methods inherited from class java.lang.Object

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

Field Detail

HELP_PATH

protected static final String HELP_PATH

See Also:

Constant Field Values

m_UserItemList

protected List m_UserItemList

list with user items

BUTTON_REGION

public static final int BUTTON_REGION

name of the button / menu region

See Also:

Constant Field Values

MAIN_REGION

public static final int MAIN_REGION

name of the button / menu region

See Also:

Constant Field Values

ERRORS_REGION

public static final int ERRORS_REGION

Errors region

See Also:

Constant Field Values

m_settingsSet

protected com.wewebu.ow.server.app.OwSettingsSet m_settingsSet

settingset node of the selected plugin

m_MenuView

protected com.wewebu.ow.server.app.OwSubMenuView m_MenuView

the buttons for the search form

m_Settings

protected com.wewebu.ow.server.app.OwSettings m_Settings

reference to the settings

m_fAdmin

protected boolean m_fAdmin

has user admin rights ?

Constructor Detail

OwSettingsSetView

public OwSettingsSetView()

Method Detail

init

protected void init()
             throws Exception

called when the view should create its HTML content to be displayed

Overrides:

init in class com.wewebu.ow.server.ui.OwView

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

usesFormWithAttributes

protected String usesFormWithAttributes()

to get additional form attributes used for the form override if your view needs a form. Base class will then render a form automatically

Overrides:

usesFormWithAttributes in class com.wewebu.ow.server.ui.OwView

Returns:

String with form attributes, or null if view does not render a form

renderMainRegion

protected void renderMainRegion(Writer w_p)
                         throws Exception

called when the view should create its HTML content to be displayed

Throws:

Exception

renderSettingsSet

protected void renderSettingsSet(Writer w_p,
                     boolean fUser_p)
                          throws Exception

render the view

Parameters:

w_p - Writer object to write HTML to

fUser_p - boolean

Throws:

Exception

onOpenHelp

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

called when user clicked a help icon

Parameters:

request_p -

Throws:

Exception

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

renderErrorsRegion

protected void renderErrorsRegion(Writer w_p)
                           throws IOException

Render errors regions, if there are any errors.

Parameters:

w_p - - the Writer object.

Throws:

IOException

Since:

3.0.0.0

updateExternalFormTarget

public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
                               boolean fSave_p)
                                 throws Exception

update the target after a form event, so it can set its form fields

Overrides:

updateExternalFormTarget in class com.wewebu.ow.server.ui.OwEventTarget

Parameters:

request_p - HttpServletRequest

fSave_p - boolean true = save the changes of the form data, false = just update the form data, but do not save

Returns:

true = field data was valid, false = field data was invalid

Throws:

Exception

onActivate

protected void onActivate(int iIndex_p,
              Object oReason_p)
                   throws Exception

activate the target from a navigation module. Called when menu item was pressed for this target.

Overrides:

onActivate in class com.wewebu.ow.server.ui.OwView

Parameters:

iIndex_p - int tab index of Navigation

oReason_p - User Object which was submitted when target was attached to the navigation module

Throws:

Exception

onApply

public void onApply(javax.servlet.http.HttpServletRequest request_p,
           Object oReason_p)
             throws Exception

event called when user clicked apply

Parameters:

request_p - a HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onReset

public void onReset(javax.servlet.http.HttpServletRequest request_p,
           Object oReason_p)
             throws Exception

event called when user clicked Reset

Parameters:

request_p - a HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception