com.sapportals.wcm.rendering.resource
Class ResourceNavigationRenderer

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.resource_api.jar]

com.sapportals.wcm.rendering.resource.ResourceNavigationRenderer

public final class ResourceNavigationRenderer

This class can be used to take care of the complete rendering of a resource. The class uses the LayoutObject, set in the constructor to retrieve all parametrization from the calling class. It then returns a Component that is ready-to-use.

Field Summary

static java.lang.String	BLANK
static java.lang.String	NBSP
static java.lang.String	START_URI

Constructor Summary

ResourceNavigationRenderer(LayoutObject layoutObject, IProxy proxy)
Sets the two member variables of the renderer with the values of the given parameters.

Method Summary

protected boolean	isPreviewEnabled(IResource resource) checks, if the current ui implements functionality to preview a resource.
com.sapportals.htmlb.Component	renderContentLink(IResource resource) creates a link to show the content of the given resource.
com.sapportals.htmlb.Component	renderContentLink(IResource resource, com.sapportals.htmlb.Component comp) creates a link to show the content of the given resource.

Field Detail

NBSP

public static final java.lang.String NBSP

BLANK

public static final java.lang.String BLANK

START_URI

public static final java.lang.String START_URI

Constructor Detail

ResourceNavigationRenderer

public ResourceNavigationRenderer(LayoutObject layoutObject,
                                  IProxy proxy)

Sets the two member variables of the renderer with the values of the given parameters.

Parameters:

layoutObject - a layoutObject that holds all the parametrization to create the correct rendering. Must not be null.

proxy - the proxy that is used as the target control, when the commands that are included in the returned Component trigger Events.

Method Detail

renderContentLink

public com.sapportals.htmlb.Component renderContentLink(IResource resource,
                                                        com.sapportals.htmlb.Component comp)
                                                 throws WcmException

creates a link to show the content of the given resource. If the resource is an ICollection, the link will navigate into the contents of this collection. If a preview control is available, the link will trigger an eent to display the contents in this control. Otherwise, the resource will be displayed in a new browser window. If a WcmException is thrown while execution, the given Component will be returned without a link.

Parameters:

resource - Description of the param

comp - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderContentLink

public com.sapportals.htmlb.Component renderContentLink(IResource resource)
                                                 throws WcmException

creates a link to show the content of the given resource. If the resource is an ICollection, the link will navigate into the contents of this collection. If a preview control is available, the link will trigger an eent to display the contents in this control. Otherwise, the resource will be displayed in a new browser window. If a WcmException is thrown while execution, the given Component will be returned without a link.

Parameters:

resource - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

isPreviewEnabled

protected boolean isPreviewEnabled(IResource resource)

checks, if the current ui implements functionality to preview a resource. This depends on the mimetype of the current resource and the current ILayoutController

Parameters:

resource - Description of the param

Returns:

The previewEnabled value