com.wewebu.ow.server.app

Class OwSubNavigationView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.ui.OwNavigationView

com.wewebu.ow.server.app.OwSubNavigationView

All Implemented Interfaces:

OwBaseView, OwUpdateTarget

Direct Known Subclasses:

OwMultiViewNavigation, OwSmallSubNavigationView

public class OwSubNavigationView
extends OwNavigationView

Sub View Navigation UI 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OwSubNavigationView.OwSubTabInfo a navigation item

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwNavigationView

OwNavigationView.OwAbstractTabInfo, OwNavigationView.OwDelimiterTabInfo, OwNavigationView.OwTabInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORM_UPDATE_NONE update enum used in activateFormUpdate: do not perform an update
static int	FORM_UPDATE_NORMAL update enum used in activateFormUpdate: do update the selected formview
static int	FORM_UPDATE_SAVE update enum used in activateFormUpdate: do update and save the selected formview
static String	KEYBOARD_DOWN
static String	KEYBOARD_UP
protected int	m_iUseFormUpdate true = form of selected view gets updated on navigate, false = no update is performed

Fields inherited from class com.wewebu.ow.server.ui.OwNavigationView

m_fValidatePanels, m_iCurrentTabIndex, m_TabList

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateFormUpdate(int iUseFormUpdate_p) set the form activate flat true = form of selected view gets updated on navigate, false = no update is performed
int	addView(OwView view_p, String strTitle_p, String strName_p, String strImage_p, Object oReason_p, String strToolTip_p) add a View with optional image to the navigation module.
protected String	getIncludeJsp() (overridable) JSP inclusion getter.
String	getTitle(int iIndex_p) get the title of the menu item
void	onFormEvent(javax.servlet.http.HttpServletRequest request_p) called before a form event is caught.
protected void	onRender(Writer w_p) render the navigation bar
void	setTitle(String strNewTitle_p, int iIndex_p) change the title of the menu item

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

addDelimiter, addMenuItem, addView, clear, enable, enableAll, getNavigateEventURL, getNavigationFormAction, getNavigationIndex, getTab, getTabList, getTitle, getViewReference, isLastTabIndex, isPreviousPanelValid, navigate, navigate, navigate, navigateFirst, onNavigate, registerView, renderCurrentView, renderNavigationLink, setValidatePanels, setVisible, size

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

activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, init, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, 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, onRequest, updateExternalFormTarget

Methods inherited from class java.lang.Object

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

Field Detail

KEYBOARD_UP

public static String KEYBOARD_UP

KEYBOARD_DOWN

public static String KEYBOARD_DOWN

FORM_UPDATE_NONE

public static final int FORM_UPDATE_NONE

update enum used in activateFormUpdate: do not perform an update

See Also:

Constant Field Values

FORM_UPDATE_NORMAL

public static final int FORM_UPDATE_NORMAL

update enum used in activateFormUpdate: do update the selected formview

See Also:

Constant Field Values

FORM_UPDATE_SAVE

public static final int FORM_UPDATE_SAVE

update enum used in activateFormUpdate: do update and save the selected formview

See Also:

Constant Field Values

m_iUseFormUpdate

protected int m_iUseFormUpdate

true = form of selected view gets updated on navigate, false = no update is performed

Constructor Detail

OwSubNavigationView

public OwSubNavigationView()

Method Detail

activateFormUpdate

protected void activateFormUpdate(int iUseFormUpdate_p)

set the form activate flat true = form of selected view gets updated on navigate, false = no update is performed

Parameters:

iUseFormUpdate_p - int flag as defined with FORM_UPDATE_...

onFormEvent

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

called before a form event is caught. Method gets called before the event handler to inform neighbor controls / views

Overrides:

onFormEvent in class OwNavigationView

Parameters:

request_p - HttpServletRequest

Throws:

Exception - if OwEventTarget.getFormTarget() update call fails

setTitle

public void setTitle(String strNewTitle_p,
            int iIndex_p)

change the title of the menu item

Parameters:

strNewTitle_p - String new title

iIndex_p - int index of the item to set the title for

getTitle

public String getTitle(int iIndex_p)

get the title of the menu item

Parameters:

iIndex_p - int index of the item

addView

public int addView(OwView view_p,
          String strTitle_p,
          String strName_p,
          String strImage_p,
          Object oReason_p,
          String strToolTip_p)
            throws Exception

add a View with optional image to the navigation module.
In addition to addMenuItem, the View gets activated and displayed when it is selected in the navigation. The View also becomes child of the navigation module.

Parameters:

view_p - View to add

strTitle_p - name of the tab to be displayed

strName_p - optional Name / ID of the view, can be null.

strImage_p - optional image

oReason_p - optional object to be submitted to the event handler / view. Can be null.

Returns:

index of the tab

Throws:

Exception

getIncludeJsp

protected String getIncludeJsp()

(overridable) JSP inclusion getter. By overriding this method subclasses can specify custom JSP renderers for a navigation object.

Returns:

the sub navigation JSP inclusion

Since:

2.5.2.0

onRender

protected void onRender(Writer w_p)
                 throws Exception

render the navigation bar

Overrides:

onRender in class OwNavigationView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception