senselogic.sitevision.api.render

Interface BuddyIconRenderer

@Requireable(value="BuddyIconRenderer")
public interface BuddyIconRenderer

BuddyIconRenderer is a stateful utility interface for rendering of buddy icons for user identities and collaboration groups.

An instance of the SiteVision class implementing this interface can be obtained via Utils.getBuddyIconRenderer(). See Utils for how to obtain an instance of the Utils interface.

BuddyIconRenderer has few attributes:

• buddyIconNode - The node that should be rendered as a buddy icon. Default is null.
• buddyIconSize - The size of the buddy icon that is rendered. Default is BuddyIconSize.SMALL. Note that image size settings are followed with best effort. Images will never be upscaled.
• linkBuddyIcon - Whether or not rendered buddy icons should be linked. Default is true.

Using the BuddyIconRenderer is pretty straightforward, if you remember that it is stateful and that the previously loaded buddy icon node will be cleared whenever you try to load a new one. Conceptually you would typically use it like this:

1. Get the BuddyIconRenderer
2. Possibly init the renderer with rendering settings (buddyIconSize, linkBuddyIcon)
3. Set a buddy icon node
4. Do render

When you have rendered once, you can re-use the BuddyIconRenderer until you are done. Something like:

1. Update the buddy icon node
2. Do render.

Example of how this strategy could be implemented in Velocity:
(You want to do a simple listing of buddy icons for some collaboration groups, collaboration group pages, user identities or users)

   ## Get BuddyIconRenderer
   #set ($buddyIconRenderer = $sitevisionUtils.buddyIconRenderer)

   ## Iterate through the list of nodes and render a buddy icon for all supported nodes
   <ul class="sv-no-list-style">
   #foreach ($item in $items)
     ## Check if this node can be rendered as a buddy icon
     #if ($buddyIconRenderer.isRenderable($item))
       ## Update the renderer and render
       $buddyIconRenderer.update($item)
       <li>
          $buddyIconRenderer.render()
       </li>
     #end
   #end
   </ul>
 

Since:

SiteVision 3.5.3

Author:

Magnus Lövgren

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BuddyIconRenderer.BuddyIconSize The size of the icons rendered by the BuddyIconRenderer.

Method Summary

Modifier and Type	Method and Description
void	clearUseLinkBuddyIcon() Utility method for executing setLinkBuddyIcon(false)
void	forceUseLargeBuddyIconSize() Utility method for executing setBuddyIconSize(BuddyIconSize.LARGE)
void	forceUseLinkBuddyIcon() Utility method for executing setLinkBuddyIcon(true)
void	forceUseSmallBuddyIconSize() Utility method for executing setBuddyIconSize(BuddyIconSize.SMALL)
boolean	isLoaded() Whether or not this renderer contains a node that can be rendered.
boolean	isRenderable(Node aNode) Helper method to check if a certain node can be rendered as a buddy icon.
String	render() Builds a html string based on current state.
void	setBuddyIconSize(BuddyIconRenderer.BuddyIconSize aBuddyIconSize) Sets the size for rendered buddy icons.
void	setLinkBuddyIcon(boolean aLinkBuddyIcon) Whether or not rendered buddy icons should be linked.
void	update(Node aBuddyIconNode) Updates the renderer with a new buddy icon supported node.

Method Detail

setBuddyIconSize

void setBuddyIconSize(BuddyIconRenderer.BuddyIconSize aBuddyIconSize)

Sets the size for rendered buddy icons.

Default is BuddyIconSize.SMALL

Parameters:

aBuddyIconSize - the icon size

forceUseSmallBuddyIconSize

void forceUseSmallBuddyIconSize()

Utility method for executing setBuddyIconSize(BuddyIconSize.SMALL)

See Also:

setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize), BuddyIconRenderer.BuddyIconSize.SMALL

forceUseLargeBuddyIconSize

void forceUseLargeBuddyIconSize()

Utility method for executing setBuddyIconSize(BuddyIconSize.LARGE)

See Also:

setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize), BuddyIconRenderer.BuddyIconSize.LARGE

setLinkBuddyIcon

void setLinkBuddyIcon(boolean aLinkBuddyIcon)

Whether or not rendered buddy icons should be linked.

Default is true

Parameters:

aLinkBuddyIcon - Whether or not buddy icons should be linked.

clearUseLinkBuddyIcon

void clearUseLinkBuddyIcon()

Utility method for executing setLinkBuddyIcon(false)

See Also:

setLinkBuddyIcon(boolean)

forceUseLinkBuddyIcon

void forceUseLinkBuddyIcon()

Utility method for executing setLinkBuddyIcon(true)

See Also:

setLinkBuddyIcon(boolean)

update

void update(Node aBuddyIconNode)

Updates the renderer with a new buddy icon supported node.

If aBuddyIconNode is not a type that can be represented by a buddy icon, the argument will be considered as null, i.e. the renderer will not have any renderable node in subsequent render execution.

Parameters:

aBuddyIconNode - a node that can be rendered as a buddy icon.

isLoaded

boolean isLoaded()

Whether or not this renderer contains a node that can be rendered.

Returns:

true if a renderable node is loaded, false if not.

isRenderable

boolean isRenderable(Node aNode)

Helper method to check if a certain node can be rendered as a buddy icon.

Nodes with the following primary node types are potentially renderable:

• sv:userIdentity
• sv:user (non-anonymous) » will be renderable if a sv:userIdentity can be extracted
• sv:simpleUser » will be renderable if a sv:userIdentity can be extracted
• sv:systemUser » will be renderable if a sv:userIdentity can be extracted
• sv:collaborationGroup
• sv:collaborationGroupPage » will be renderable if a sv:collaborationGroup can be extracted

Parameters:

aNode - the node to check

Returns:

true if aNode is supported by this renderer, false if not

render

String render()

Builds a html string based on current state. Size note! Profile images will never be upscaled. If a buddy icon size is larger than the actual size of the profile image, the image will be rendered with the largest possible buddy icon size.

Returns:

a html string, ready to print out on a page. Might be empty but never null.