com.communote.server.widgets

Interface Widget

All Known Subinterfaces:

PagedWidget<I>

All Known Implementing Classes:

AboutBlogWidget, AboutUserProfileWidget, AbstractMultipleResultWidget, AbstractPagedListWidget, AbstractWidget, AnnotatedMultiResultWidget, AnnotatedSingleResultWidget, AuthorFilterWidget, BlogChooserSimpleWidget, BlogChooserWidget, BlogListWidget, BlogMemberManagementWidget, BlogPostFilterPeriodWidget, BlogPostFilterUserListWidget, BlogTagCloudWidget, CertificateListWidget, ChronologicalPostListWidget, ClientPermissionsWidget, ContentTypeWidget, CreateNoteWidget, DeleteTopicWidget, EditTopicStructureWidget, EmptyWidget, FilteredByWidget, FormWidget, GlobalIdShowBannerImageWidget, GlobalIdUploadImageWidget, GroupSettingsWidget, InviteUserToBlogWidget, InviteUserViaEmailWidget, IpRangeListWidget, IpRangeWidget, ListExternalObjectsWidget, LocalizeMessageWidget, LoggingWidget, MainPageHorizontalNavigationWidget, MainPageVerticalNavigationWidget, MessagesWidget, MultiViewTabWidget, SearchBoxWidget, SetAnonymousAccessWidget, SpringFormWidget, TagCloudWidget, TagManagementWidget, TopBlogsWidget, TopicListWidget, UserGroupAddMemberWidget, UserGroupDialogWidget, UserGroupListWidget, UserGroupMembersListWidget, UserGroupSearchBoxWidget, UserListWidget, UserManagementListWidget, UserManagementSearchBoxWidget, UserManagementSystemUserProfileWidget, UserManagementUserDialogWidget, UserManagementUserOverviewWidget, UserProfileChangeEmailWidget, UserProfileChangePasswordWidget, UserProfileDeleteWidget, UserProfileDetailsWidget, UserProfileImageUploadWidget, UserProfileNotificationsWidget, UserProfileUserInterfaceWidget, UserProfileWidget, UserSearchBoxWidget, UserTagCloudWidget

public interface Widget

A widget

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_WIDGET_ID Parameter of the widget id

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String key) return widget attribute
String	getGroupName() Get the group name to build the url based on it.
String	getParameter(String key) return widget parameter
Map<String,String>	getParameters() Get the parameter list
String	getResponseMetadata() Return a JSON object containing arbitrary metadata the server-side widget component wants to transmit to the client-side component as part of the current response.
String	getTile(String outputType) Deprecated. user #getViewIdentifier(String) instead
String	getViewIdentifier() Get the view identifier which defines the view for rendering the widgets content
String	getWidgetId() Get the id of the current widget
Object	handleRequest() Handle the request and return a result
boolean	isSuccess()
void	setGroupName(String path) Set the group name to build the url based on it.
void	setParameter(String key, String value) set widget parameter
void	setRequest(javax.servlet.http.HttpServletRequest request) set the http servlet request for this widget
void	setResponse(javax.servlet.http.HttpServletResponse response) set the http servlet response for this widget

Field Detail

PARAM_WIDGET_ID

static final String PARAM_WIDGET_ID

Parameter of the widget id

See Also:

Constant Field Values

Method Detail

getAttribute

Object getAttribute(String key)

return widget attribute

Parameters:

key - the parameter key

Returns:

the attribute value

getGroupName

String getGroupName()

Get the group name to build the url based on it.

Returns:

relative path in which package this controller can be found

getParameter

String getParameter(String key)

return widget parameter

Parameters:

key - the parameter key

Returns:

the parameter value

getParameters

Map<String,String> getParameters()

Get the parameter list

Returns:

Parameter map

getResponseMetadata

String getResponseMetadata()

Return a JSON object containing arbitrary metadata the server-side widget component wants to transmit to the client-side component as part of the current response.

Returns:

a string serialized JSON object or null if no metadata needs to be transmitted

getTile

@Deprecated
String getTile(String outputType)

Deprecated. user #getViewIdentifier(String) instead

Get the tile to be used for rendering

Parameters:

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

Returns:

The tile to show

getViewIdentifier

String getViewIdentifier()

Get the view identifier which defines the view for rendering the widgets content

Returns:

The tile to show

getWidgetId

String getWidgetId()

Get the id of the current widget

Returns:

the widget id

handleRequest

Object handleRequest()

Handle the request and return a result

Returns:

the result

isSuccess

boolean isSuccess()

Returns:

if the widget request was successful

setGroupName

void setGroupName(String path)

Set the group name to build the url based on it.

Parameters:

path - relative path in which package this controller can be found

setParameter

void setParameter(String key,
                  String value)

set widget parameter

Parameters:

key - the parameter key

value - the parameter value

setRequest

void setRequest(javax.servlet.http.HttpServletRequest request)

set the http servlet request for this widget

Parameters:

request - the request

setResponse

void setResponse(javax.servlet.http.HttpServletResponse response)

set the http servlet response for this widget

Parameters:

response - the response