com.jivesoftware.community.widget
Class HomepageWidgetContext

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

All Implemented Interfaces:

com.jivesoftware.community.widget.WidgetContext

public class HomepageWidgetContext
extends BaseWidgetContext

A widget context specifically for widgets on the homepage (not the personalized homepage).

Constructor Summary

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

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

Method Summary

JiveContainer

getContainer() Subclasses should override this method to provide their container.

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

HomepageWidgetContext

public HomepageWidgetContext(User user,
                             AuthToken authToken,
                             HttpServletRequest request,
                             HttpServletResponse response)

Creates a HomepageWidgetContext 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

HomepageWidgetContext

public HomepageWidgetContext(User user,
                             AuthToken authToken,
                             HttpServletRequest request,
                             HttpServletResponse response,
                             boolean edit)

Creates a HomepageWidgetContext 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

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

Method Detail

getContainer

public JiveContainer getContainer()

Description copied from class: BaseWidgetContext

Subclasses should override this method to provide their container.

Specified by:

getContainer in interface com.jivesoftware.community.widget.WidgetContext

Overrides:

getContainer in class BaseWidgetContext

Returns:

the container associated with this widget context.