uk.ac.cam.caret.sakai.rwiki.tool.bean

Class RenderBean

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.tool.bean.RenderBean

public class RenderBean
extends Object

Bean that renders the current rwikiObject using a set objectService and toolRenderService.

Author:

andrew

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_PROBLEM

Constructor Summary

Constructors

Constructor and Description
RenderBean(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, ToolRenderService toolRenderService, uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService, boolean withBreadcrumbs) Create new RenderBean from given RWikiObject
RenderBean(String name, String defaultRealm, ToolRenderService toolRenderService, uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService, boolean withBreadcrumbs) Create new RenderBean and get the chosen RWikiObject

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getCanEdit()
boolean	getCanRead()
String	getCommentLevel()
String	getCommentPageLink()
List	getComments() returns a list of comments that are render beans
String	getEditCommentURL()
String	getEditUrl() Returns an url that generate a view string to the current rwikiObject
boolean	getExists() Returns true if the underlying page exists.
boolean	getHasContent() Returns true if the page has content and it has length
String	getListCommentsURL()
String	getListPageChatURL()
String	getListPresenceURL()
String	getListSpaceChatURL()
String	getLocalisedPageName() The localised name of the rwikiObject
Integer	getLocalisedPageNameLength() The localised name of the rwikiObject
String	getNewCommentURL()
uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService	getObjectService() Get the RWikiObjectService
String	getOpenPageChatURL()
String	getOpenSpaceChatURL()
String	getPreviewPage()
String	getPrintRenderedPage() Render the current RWikiObject with print links
String	getPublicRenderedPage() Render the current RWikiObject with public links
String	getRenderedPage() Render the current RWikiObject
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject	getRwikiObject() The current RWikiObject
ToolRenderService	getToolRenderService() Get the ToolRenderService
String	printRenderedPage() Render the current RWikiObject with print links
String	printRenderPage(String name, String defaultRealm, boolean withBreadcrumbs) Render the rwikiObject as a print page represented by the given name and realm
String	publicRenderedPage() Render the current RWikiObject with public links
String	publicRenderPage(String name, String defaultRealm, boolean withBreadcrumbs) Render the rwikiObject as a public page represented by the given name and realm
String	renderPage() Render the current RWikiObject
String	renderPage(String name, String defaultRealm) Render the rwikiObject represented by the given name and realm
void	setCanEdit(boolean canEdit)
void	setCanRead(boolean canRead)
void	setObjectService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService) Set the RWikiObjectService for this bean.
void	setPreviewContent(String previewContent)
void	setRenderService(ToolRenderService toolRenderService) Set the ToolRenderService for this bean.

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_PROBLEM

public static final String PERMISSION_PROBLEM

See Also:

Constant Field Values

Constructor Detail

RenderBean

public RenderBean(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
          ToolRenderService toolRenderService,
          uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService,
          boolean withBreadcrumbs)

Create new RenderBean from given RWikiObject

Parameters:

rwo - the current RWikiObject

user - the current user

toolRenderService - the ToolRenderService

objectService - the RWikiObjectService

RenderBean

public RenderBean(String name,
          String defaultRealm,
          ToolRenderService toolRenderService,
          uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService,
          boolean withBreadcrumbs)

Create new RenderBean and get the chosen RWikiObject

Parameters:

name - the name of the RWikiObject to render

user - the current user

defaultRealm - the defaultRealm to globalise the name with

toolRenderService - the ToolRenderService

objectService - the RWikiObjectService

Method Detail

getObjectService

public uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService getObjectService()

Get the RWikiObjectService

Returns:

objectService

setObjectService

public void setObjectService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService)

Set the RWikiObjectService for this bean.

Parameters:

objectService - The RWikiObjectService to use.

getToolRenderService

public ToolRenderService getToolRenderService()

Get the ToolRenderService

Returns:

toolRenderService

setRenderService

public void setRenderService(ToolRenderService toolRenderService)

Set the ToolRenderService for this bean.

Parameters:

toolRenderService - the ToolRenderService to use.

getPreviewPage

public String getPreviewPage()

getRenderedPage

public String getRenderedPage()

Render the current RWikiObject

Returns:

XHTML as a String representing the content of the current RWikiObject

getPublicRenderedPage

public String getPublicRenderedPage()

Render the current RWikiObject with public links

Returns:

XMTML as a String representing the content of the current RWikiObject

getPrintRenderedPage

public String getPrintRenderedPage()

Render the current RWikiObject with print links

Returns:

XMTML as a String representing the content of the current RWikiObject

renderPage

public String renderPage()

Render the current RWikiObject

Returns:

XHTML as a String representing the content of the current RWikiObject

publicRenderedPage

public String publicRenderedPage()

Render the current RWikiObject with public links

Returns:

XMTML as a String representing the content of the current RWikiObject

printRenderedPage

public String printRenderedPage()

Render the current RWikiObject with print links

Returns:

XMTML as a String representing the content of the current RWikiObject

renderPage

public String renderPage(String name,
                String defaultRealm)

Render the rwikiObject represented by the given name and realm

Parameters:

name - a possible non-globalised name

defaultRealm - the default realm of that should be globalised against

Returns:

XHTML as a String representing the content of the RWikiObject

publicRenderPage

public String publicRenderPage(String name,
                      String defaultRealm,
                      boolean withBreadcrumbs)

Render the rwikiObject as a public page represented by the given name and realm

Parameters:

name - a possible non-globalised name

defaultRealm - the default space of that should be globalised against

Returns:

XHTML as a String representing the content of the RWikiObject

printRenderPage

public String printRenderPage(String name,
                     String defaultRealm,
                     boolean withBreadcrumbs)

Render the rwikiObject as a print page represented by the given name and realm

Parameters:

name - a possible non-globalised name

defaultRealm - the default space of that should be globalised against

Returns:

XHTML as a String representing the content of the RWikiObject

getRwikiObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject getRwikiObject()

The current RWikiObject

Returns:

rwikiObject

getLocalisedPageName

public String getLocalisedPageName()

The localised name of the rwikiObject

Returns:

localised page name

getLocalisedPageNameLength

public Integer getLocalisedPageNameLength()

The localised name of the rwikiObject

Returns:

length of the localised page name

getEditUrl

public String getEditUrl()

Returns an url that generate a view string to the current rwikiObject

Returns:

url as String

getExists

public boolean getExists()

Returns true if the underlying page exists.

Returns:

getHasContent

public boolean getHasContent()

Returns true if the page has content and it has length

Returns:

getComments

public List getComments()

returns a list of comments that are render beans

Returns:

getCommentPageLink

public String getCommentPageLink()

getCanEdit

public boolean getCanEdit()

Returns:

Returns the canEdit.

setCanEdit

public void setCanEdit(boolean canEdit)

Parameters:

canEdit - The canEdit to set.

getCanRead

public boolean getCanRead()

Returns:

Returns the canRead.

setCanRead

public void setCanRead(boolean canRead)

Parameters:

canRead - The canRead to set.

getListCommentsURL

public String getListCommentsURL()

getNewCommentURL

public String getNewCommentURL()

getEditCommentURL

public String getEditCommentURL()

getCommentLevel

public String getCommentLevel()

getListPresenceURL

public String getListPresenceURL()

getOpenPageChatURL

public String getOpenPageChatURL()

getOpenSpaceChatURL

public String getOpenSpaceChatURL()

getListPageChatURL

public String getListPageChatURL()

getListSpaceChatURL

public String getListSpaceChatURL()

setPreviewContent

public void setPreviewContent(String previewContent)

Parameters:

previewContent - the previewContent to set