com.jivesoftware.community.widget
Class CommunityWidgetContext

java.lang.Object
  com.jivesoftware.community.widget.BaseWidgetContext
      com.jivesoftware.community.widget.CommunityWidgetContext

public class CommunityWidgetContext
extends BaseWidgetContext

A widget context specifically for community widgets.

Constructor Summary

CommunityWidgetContext(User user, AuthToken authToken, HttpServletRequest request, HttpServletResponse response, Community community)
Creates a CommunityWidgetContext with all the necessary information for a widget author to render their widget.

CommunityWidgetContext(User user, AuthToken authToken, HttpServletRequest request, HttpServletResponse response, Community community, boolean edit)
Creates a CommunityWidgetContext of a given type with all the necessary information for a widget author to render their widget.

Method Summary

Community	getCommunity() Get the community from the widget context.
JiveContainer	getContainer() Return the community container from the widget context.

Methods inherited from class com.jivesoftware.community.widget.BaseWidgetContext

getAuthToken, getLocale, getRequest, getResponse, getUser, getWidgetType, isEdit, isRemote

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunityWidgetContext

public CommunityWidgetContext(User user,
                              AuthToken authToken,
                              HttpServletRequest request,
                              HttpServletResponse response,
                              Community community)

Creates a CommunityWidgetContext with all the necessary information for a widget author to render their widget.

Parameters:

user - the page user

authToken - the auth token of the page user

request - the http servlet request object

response - the http servlet response object

community - the community for the widget

CommunityWidgetContext

public CommunityWidgetContext(User user,
                              AuthToken authToken,
                              HttpServletRequest request,
                              HttpServletResponse response,
                              Community community,
                              boolean edit)

Creates a CommunityWidgetContext of a given type with all the necessary information for a widget author to render their widget.

Parameters:

user - the page user

authToken - the auth token of the page user

request - the http servlet request object

response - the http servlet response object

community - the community for the widget

edit - specifies wether the parent container is currently in edit mode.

Method Detail

getCommunity

public Community getCommunity()

Get the community from the widget context.

Returns:

the community from the widget context

getContainer

public JiveContainer getContainer()

Return the community container from the widget context.

Overrides:

getContainer in class BaseWidgetContext

Returns:

the community container from the widget context.