com.communote.server.web.fe.widgets.navigation

Class MainPageHorizontalNavigationWidget

java.lang.Object

com.communote.server.widgets.AbstractWidget

com.communote.server.web.fe.widgets.navigation.MainPageHorizontalNavigationWidget

All Implemented Interfaces:

Widget

public class MainPageHorizontalNavigationWidget
extends AbstractWidget

Widget that shows a horizontal navigation that allows activating different views for a context.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from class com.communote.server.widgets.AbstractWidget

METADATA_KEY_NO_CONTENT

Fields inherited from interface com.communote.server.widgets.Widget

PARAM_WIDGET_ID

Constructor Summary

Constructors

Constructor and Description
MainPageHorizontalNavigationWidget()

Method Summary

Modifier and Type	Method and Description
String	getContextId()
String	getLabel(String viewId) Return the text that should be rendered as label for a given viewId.
String	getTile(String outputType) Get the tile to be used for rendering
Object	handleRequest() Handle the request and return a result
protected void	initParameters() abstract method hook that initializes the widget's parameters

Methods inherited from class com.communote.server.widgets.AbstractWidget

determineOutputType, getAttribute, getBooleanParameter, getGroupName, getIntParameter, getIntParameter, getLongArrayParameter, getLongParameter, getLongParameter, getParameter, getParameter, getParameterEscaped, getParameterEscaped, getParameters, getRequest, getResponse, getResponseMetadata, getStringArrayParameter, getViewIdentifier, getWidgetId, isSuccess, setAttribute, setGroupName, setParameter, setRequest, setResponse, setResponseMetadata, setSuccess

Methods inherited from class java.lang.Object

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

Constructor Detail

MainPageHorizontalNavigationWidget

public MainPageHorizontalNavigationWidget()

Method Detail

getContextId

public String getContextId()

Returns:

the ID of the current context

getLabel

public String getLabel(String viewId)

Return the text that should be rendered as label for a given viewId. The label will be taken from the customLabels request parameter if provided or loaded from the i18n language packs using a key like mainpage.horizontal.navigation.[contextId].[viewId]

Parameters:

viewId - the ID of the view that should be labeled

Returns:

the label

getTile

public String getTile(String outputType)

Description copied from interface: Widget

Get the tile to be used for rendering

Parameters:

outputType - the output type (rss, dhtml ...) without any '.'

Returns:

The tile to show

handleRequest

public Object handleRequest()

Description copied from interface: Widget

Handle the request and return a result

Returns:

the result

initParameters

protected void initParameters()

Description copied from class: AbstractWidget

abstract method hook that initializes the widget's parameters

Specified by:

initParameters in class AbstractWidget