com.wewebu.ow.server.app

Class OwMasterView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.app.OwMasterView

All Implemented Interfaces:

OwBaseView, OwUpdateTarget

public abstract class OwMasterView
extends OwView

View Module base class for the Main Area Plugins.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getBreadcrumbPart() This method is used to create a "Breadcrumb" navigation view.
OwXMLUtil	getConfigNode() get the plugin description node
OwConfiguration	getConfiguration() get the configuration object
OwDialogManager	getDialogManager() get the dialog manager of this plugin
String	getIcon() get the icon URL for this view to be displayed
OwConfiguration.OwMasterPluginInstance	getPlugin() set the plugin description node
String	getPluginID() get the plugin ID
String	getTitle() overridable title of the view
protected void	init() init the view after the context is set.
protected void	onActivate(int iIndex_p, Object oReason_p) activate the target from a navigation module.

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

activate, addView, detach, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMaximized, isShowMinimized, isShowNormal, onRender, 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

OwMasterView

public OwMasterView()

Method Detail

getPlugin

public OwConfiguration.OwMasterPluginInstance getPlugin()

set the plugin description node

getPluginID

public String getPluginID()

get the plugin ID

getTitle

public String getTitle()

overridable title of the view

Specified by:

getTitle in interface OwBaseView

Overrides:

getTitle in class OwView

Returns:

String localized display name for the view

getBreadcrumbPart

public String getBreadcrumbPart()

Description copied from interface: OwBaseView

This method is used to create a "Breadcrumb" navigation view. The view is just attaching it's known title/name to the part which is returned from it child.

Example: We have a View A which contains a View B which has a many views contained.

      A.getBreadcrumbPart()
      {
          return this.getTitle() + " - " + B.getBreadcrumbPart();
      }
      B.getBreadcrumbPart()
      {
          return this.getName() + " - " + getMainView().getBreadcrumbPart();
      }
 

So every view is just returning the part of the navigation which is known in it's context. This method should not return null at least the OwBaseView.EMPTY_STRING should be returned.

Specified by:

getBreadcrumbPart in interface OwBaseView

Overrides:

getBreadcrumbPart in class OwView

Returns:

String representing the current bread crumb part

getIcon

public String getIcon()
               throws Exception

get the icon URL for this view to be displayed

Overrides:

getIcon in class OwView

Returns:

String icon URL, or null if not defined

Throws:

Exception

getConfigNode

public OwXMLUtil getConfigNode()

get the plugin description node

Returns:

WcmXMLUtil DOM Node containing the plugin description

getConfiguration

public OwConfiguration getConfiguration()

get the configuration object

Returns:

OwConfiguration

init

protected void init()
             throws Exception

init the view after the context is set.

Overrides:

init in class OwView

Throws:

Exception

getDialogManager

public OwDialogManager getDialogManager()

get the dialog manager of this plugin

Returns:

OwDialogManager

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 OwView

Parameters:

iIndex_p - int index for the tab of Navigation

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

Throws:

Exception