Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.widget
Class ProjectWidgetContext

java.lang.Object
  extended by com.jivesoftware.community.widget.BaseWidgetContext
      extended by com.jivesoftware.community.widget.ProjectWidgetContext
All Implemented Interfaces:
com.jivesoftware.community.widget.WidgetContext

public class ProjectWidgetContext
extends BaseWidgetContext

A widget context specifically for projects.


Constructor Summary
ProjectWidgetContext(User user, AuthToken authToken, HttpServletRequest request, HttpServletResponse response, Project project)
          Creates a ProjectWidgetContext with all the necessary information for a widget author to render their widget.
ProjectWidgetContext(User user, AuthToken authToken, HttpServletRequest request, HttpServletResponse response, Project project, boolean edit)
          Creates a BlogWidgetContext of a given type with all the necessary information for a widget author to render their widget.
 
Method Summary
 Project getProject()
          Get the blog from the widget context.
 
Methods inherited from class com.jivesoftware.community.widget.BaseWidgetContext
getAuthToken, getRequest, getResponse, getUser, getWidgetType, isEdit
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProjectWidgetContext

public ProjectWidgetContext(User user,
                            AuthToken authToken,
                            HttpServletRequest request,
                            HttpServletResponse response,
                            Project project)
Creates a ProjectWidgetContext 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
project - the project for the widget

ProjectWidgetContext

public ProjectWidgetContext(User user,
                            AuthToken authToken,
                            HttpServletRequest request,
                            HttpServletResponse response,
                            Project project,
                            boolean edit)
Creates a BlogWidgetContext 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
project - the project for the widget
edit - specifies wether the parent container is currently in edit mode.
Method Detail

getProject

public Project getProject()
Get the blog from the widget context.

Returns:
the blog from the widget context

Clearspace Project Page

Copyright © 1999-2007 Jive Software.