com.communote.server.web.fe.widgets.extension.note

Class CPLNoteActionsProvider

java.lang.Object

com.communote.server.web.fe.widgets.extension.note.CPLNoteActionsProvider

All Implemented Interfaces:

Orderable, WidgetExtension<CPLNoteActionsProvider,CPLNoteActionsProviderManagement>

public abstract class CPLNoteActionsProvider
extends Object
implements WidgetExtension<CPLNoteActionsProvider,CPLNoteActionsProviderManagement>

Extension for the ChronologicalPostListWidget which allows adding or replacing actions of a note. This extensions just provides the names of the actions. Additionally message keys for the actions which adhere to the following naming conventions must be provided and exposed to JavaScript:

• widget.chronologicalPostList.note.action.NameOfTheAction.label - the display name of the action
• widget.chronologicalPostList.note.action.NameOfTheAction.title - to provide a value for the title attribute (optional)

More over a JavaScript action handler has to be registered to the NoteActionHandler of the widget.

Author:

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

Field Summary

Fields inherited from interface com.communote.server.web.fe.widgets.extension.WidgetExtension

DEFAULT_ORDER_VALUE

Constructor Summary

Constructors

Constructor and Description
CPLNoteActionsProvider()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addNoteActions(Map<String,String> requestParameters, NoteData data, List<String> actions) Add the names of the actions which should be available for the given note.
Class<CPLNoteActionsProviderManagement>	getManagementType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.common.util.Orderable

getOrder

Constructor Detail

CPLNoteActionsProvider

public CPLNoteActionsProvider()

Method Detail

addNoteActions

public abstract boolean addNoteActions(Map<String,String> requestParameters,
                                       NoteData data,
                                       List<String> actions)

Add the names of the actions which should be available for the given note. The implementation might also clear the actions list if only it's actions should be available in the frontend. In cases where no other provider should or can add actions for the note this method can return false.

Parameters:

requestParameters - the parameters of the current request (e.g. full or partial widget refresh)

data - object holding details of the note

actions - the list to add the actions to. The names of the actions must only contain ASCII alphanumeric characters.

Returns:

if true subsequent providers should be called, if false no subsequent providers are called.

getManagementType

public Class<CPLNoteActionsProviderManagement> getManagementType()

Specified by:

getManagementType in interface WidgetExtension<CPLNoteActionsProvider,CPLNoteActionsProviderManagement>

Returns:

the type of the management that handles this extension