uk.ac.cam.caret.sakai.rwiki.service.api

Interface PageLinkRenderer

public interface PageLinkRenderer

A page link render renders links for the render engine

Author:

andrew

Method Summary

Modifier and Type	Method and Description
void	appendCreateLink(StringBuffer buffer, String name, String view) append a create link to the buffer
void	appendLink(StringBuffer buffer, String name, String view) create a view link by appending it to the buffer
void	appendLink(StringBuffer buffer, String name, String view, String anchor) Create a view link with an anchor by appending it to the buffer
void	appendLink(StringBuffer buffer, String name, String view, String anchor, boolean autoGenerated) append an auto generated link to the buffer.
boolean	canUseCache() Before rendering, can we use a chached version
boolean	isCachable() After rendering is the result cachable
void	setCachable(boolean cachable)
void	setUseCache(boolean b) If true the rendered may use the cache, if false it should not

Method Detail

appendLink

void appendLink(StringBuffer buffer,
                String name,
                String view)

create a view link by appending it to the buffer

Parameters:

buffer -

name -

view -

appendLink

void appendLink(StringBuffer buffer,
                String name,
                String view,
                String anchor)

Create a view link with an anchor by appending it to the buffer

Parameters:

buffer -

name -

view -

anchor -

appendCreateLink

void appendCreateLink(StringBuffer buffer,
                      String name,
                      String view)

append a create link to the buffer

Parameters:

buffer -

name -

view -

setCachable

void setCachable(boolean cachable)

Parameters:

cachable -

isCachable

boolean isCachable()

After rendering is the result cachable

Returns:

canUseCache

boolean canUseCache()

Before rendering, can we use a chached version

Returns:

setUseCache

void setUseCache(boolean b)

If true the rendered may use the cache, if false it should not

Parameters:

b -

appendLink

void appendLink(StringBuffer buffer,
                String name,
                String view,
                String anchor,
                boolean autoGenerated)

append an auto generated link to the buffer.

Parameters:

buffer -

name -

view -

anchor -

autoGenerated - TODO