com.communote.server.web.fe.widgets

Interface PagedWidget<I>

Type Parameters:

I - type of the resulting class

All Superinterfaces:

Widget

All Known Implementing Classes:

AbstractPagedListWidget, AuthorFilterWidget, BlogListWidget, BlogMemberManagementWidget, BlogTagCloudWidget, ChronologicalPostListWidget, IpRangeListWidget, TagCloudWidget, TopicListWidget, UserGroupListWidget, UserGroupMembersListWidget, UserListWidget, UserManagementListWidget, UserTagCloudWidget

public interface PagedWidget<I>
extends Widget

Interface for a paged widget

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGING_MASSAGE_KEY_PREFIX Prefix for the paging tooltip message key (widget.paging.tooltip.).
static String	PARAM_PAGING_MESSAGE_KEY_SUFFIX request parameter identifying a message key suffix (appended to 'widget.paging.tooltip.') which used to generate a tooltip message for the paging navigation.

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

PARAM_WIDGET_ID

Method Summary

Modifier and Type	Method and Description
String	getDefaultPagingMessageKeySuffix() Returns the default message key suffix for creating a tooltip to the paging navigation.
PageInformation	getPageInformation() Get the page information of the widget
Map<String,String>	getParameterDescriptions() Get the parameter descriptions: This is a map of the parameter names to a human understanable value, e.g.

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

getAttribute, getGroupName, getParameter, getParameters, getResponseMetadata, getTile, getViewIdentifier, getWidgetId, handleRequest, isSuccess, setGroupName, setParameter, setRequest, setResponse

Field Detail

PARAM_PAGING_MESSAGE_KEY_SUFFIX

static final String PARAM_PAGING_MESSAGE_KEY_SUFFIX

request parameter identifying a message key suffix (appended to 'widget.paging.tooltip.') which used to generate a tooltip message for the paging navigation. In case the parameter is not found in the request the message key is created by evaluating the return value of getDefaultPagingMessageKeySuffix().

See Also:

Constant Field Values

PAGING_MASSAGE_KEY_PREFIX

static final String PAGING_MASSAGE_KEY_PREFIX

Prefix for the paging tooltip message key (widget.paging.tooltip.).

See Also:

Constant Field Values

Method Detail

getDefaultPagingMessageKeySuffix

String getDefaultPagingMessageKeySuffix()

Returns the default message key suffix for creating a tooltip to the paging navigation. This value is evaluated if the PARAM_PAGING_MESSAGE_KEY_SUFFIX is not in the request.

Returns:

the message key suffix

getPageInformation

PageInformation getPageInformation()

Get the page information of the widget

Returns:

the page information

getParameterDescriptions

Map<String,String> getParameterDescriptions()

Get the parameter descriptions: This is a map of the parameter names to a human understanable value, e.g. the full name of the user or the name of a user group. Only the parameter names are set which have been used in the filter. The name can be determined by #getSuppliedParameters()

Returns:

the parameter descriptions