com.sapportals.wcm.rendering.resource

Class ResourceNavigationRenderer

java.lang.Object
  com.sapportals.wcm.rendering.resource.ResourceNavigationRenderer

All Implemented Interfaces:

ICollectionRendererParameterNameConst

public final class ResourceNavigationRenderer

extends Object

implements ICollectionRendererParameterNameConst

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 String	BLANK
static String	NBSP
static String	START_URI

Fields inherited from interface com.sapportals.wcm.repository.service.layout.customizing.ICollectionRendererParameterNameConst

BACKGROUNDIMAGEPATH, BACKGROUNDIMAGESTYLE, BACKGROUNDIMAGESTYLE_MULTIPLE, BACKGROUNDIMAGESTYLE_SINGLE, BREADCRUMBSTYLE, BREADCRUMBSTYLE_BACK, BREADCRUMBSTYLE_DRPODOWN, BREADCRUMBSTYLE_HORIZONTAL, BREADCRUMBSTYLE_OFF, BREADCRUMBSTYLE_VERTICAL, BREADCRUMBVISIBILITYSTYLE, BREADCRUMBVISIBILITYSTYLE_DISABLEROOT, BREADCRUMBVISIBILITYSTYLE_INVISIBLE, BREADCRUMBVISIBILITYSTYLE_INVISIBLEROOT, BREADCRUMBVISIBILITYSTYLE_NOICON, BREADCRUMBVISIBILITYSTYLE_STANDARD, COLLECTION_ACTIONSTYLE, COLLECTION_ACTIONSTYLE_BUTTON, COLLECTION_ACTIONSTYLE_HOVER, COLLECTION_ACTIONSTYLE_LINK, COLLECTION_ACTIONSTYLE_MENU, COLLECTION_ACTIONSTYLE_OFF, COLLECTION_ACTIONSTYLE_SMALLBUTTON, COLLECTION_ACTIONSTYLE_TOOLBAR_BUTTON, COLUMNS, COLUMNSPACING, COLUMNSPACINGSTYLE, COLUMNSPACINGSTYLE_FIXED, COLUMNSPACINGSTYLE_MINIMUM, COMPONENTS, EMPTY_COLLECTION_FILE, EMPTY_COLLECTION_KEY, EMPTY_COLLECTION_STYLE, EMPTY_COLLECTION_STYLE_MESSAGE, EMPTY_COLLECTION_STYLE_OFF, EMPTY_COLLECTION_STYLE_TEXT, FILESELECTIONMODE_MULTIPLE, FILESELECTIONMODE_SINGLE, FILTEREXTENSION, FILTERMIMETYPE, FILTERRESOURCETYPE, FOLDERSELECTIONMODE_MULTIPLE, FOLDERSELECTIONMODE_SINGLE, GRIDORDERSTYLE, GRIDORDERSTYLE_COLUMN_MAJOR, GRIDORDERSTYLE_ROW_MAJOR, GROUP_STYLE, GROUP_STYLE_OFF, GROUP_STYLE_PRIMARYCOLOR, GROUP_STYLE_SAPCOLOR, GROUP_STYLE_SECONDARYBOX, GROUP_STYLE_SECONDARYBOXCOLOR, GROUP_STYLE_SECONDARYCOLOR, HEADER_TEXT_STYLE, HTML_FILENAME, IMAGEMAP, ITEMSELECTIONMODE, ITEMSELECTIONMODE_MULTIPLE, ITEMSELECTIONMODE_OFF, ITEMSELECTIONMODE_SINGLE, LINKSSTYLE, LINKSSTYLE_ALL, LINKSSTYLE_EXTERNAL, LINKSSTYLE_INTERNAL, LINKSSTYLE_OFF, LINKSSTYLE_VISIBLE, MASSACTIONSTYLE, MASSACTIONSTYLE_BUTTON, MASSACTIONSTYLE_HOVER, MASSACTIONSTYLE_ICON, MASSACTIONSTYLE_LINK, MASSACTIONSTYLE_MENU, MASSACTIONSTYLE_OFF, MASSACTIONSTYLE_SMALLBUTTON, MASSACTIONSTYLE_TOOLBAR_BUTTON, MASSACTIONSTYLE_VERTICAL_LINK, MAX_NUM_OF_TABS, NO_OF_CHILD_FOR_NODE, NO_TAB_CONTENT, OPEN_NODES_STYLE, OPEN_NODES_STYLE_All, OPEN_NODES_STYLE_LAST_SELECTED, OPENTARGETTYPE, OPENTARGETTYPE_FIXED, OPENTARGETTYPE_NEW, OPENTARGETTYPE_OFF, OPENTARGETTYPE_SELF, PAGER_LINK_COUNT, PROPERTY_COLUMN_HEADER_STYLE, PROPERTY_COLUMN_HEADER_STYLE_LIST, PROPERTY_COLUMN_HEADER_STYLE_MENUE, PROPERTY_COLUMN_HEADER_STYLE_OFF, PROPERTY_COLUMN_HEADER_STYLE_TABLE, PROPERTY_COLUMN_HEADER_STYLE_TRANSPARENT, PROPERTYCOLUMNS, RESIZEHEIGHTSTYLE, RESIZEHEIGHTSTYLE_COMPACT, RESIZEHEIGHTSTYLE_OFF, RESIZEHEIGHTSTYLE_STRETCH, RESIZEWIDHTSTYLE, RESIZEWIDHTSTYLE_COMPACT, RESIZEWIDHTSTYLE_OFF, RESIZEWIDHTSTYLE_STRETCH, RESOURCE_LIST_FILTER, RESOURCE_LIST_FILTER_DEFAULT, ROWBACKGROUNDSTYLE, ROWS, ROWSPACING, ROWSPACINGSTYLE, ROWSPACINGSTYLE_ALTERNATING, ROWSPACINGSTYLE_BACKGROUND, ROWSPACINGSTYLE_COLUMNALTERNATING, ROWSPACINGSTYLE_COLUMNSEPARATED, ROWSPACINGSTYLE_FIXED, ROWSPACINGSTYLE_LINESEPARATED, ROWSPACINGSTYLE_MINIMUM, ROWSPACINGSTYLE_ROWALTERNATING, ROWSPACINGSTYLE_TRANSPARENT, SHOW_HIDDEN, SHOW_TREE_ROOT_NODE, SHOWFILESSTYLE, SHOWFILESSTYLE_ALL, SHOWFILESSTYLE_NOLINK, SHOWFILESSTYLE_OFF, SHOWFILESTYLE_ONLYLINK, SHOWFOLDERSSTYLE, SHOWFOLDERSSTYLE_ALL, SHOWFOLDERSSTYLE_NOLINK, SHOWFOLDERSSTYLE_OFF, SHOWFOLDERSSTYLE_ONLYLINK, SHOWFOLDERTITLE, SHOWUSERID, SHOWUSERNAME, SORT_ENABLED, SORT_ORDER, SORT_ORDER_ASCENDING, SORT_ORDER_DESCENDING, SORT_PROPERTY, TAB_BODY_FLAVOR, TAB_STYLE_SAFE, UI_COLL_RENDERER, UI_GROUP_COLLECTION, UI_GROUP_MASS, USE_SCROLL_CONTAINER, VERTICAL_ALIGNMENT, VERTICAL_ALIGNMENT_BASELINE, VERTICAL_ALIGNMENT_BOTTOM, VERTICAL_ALIGNMENT_MIDDLE, VERTICAL_ALIGNMENT_TOP

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.
Component	renderContentLink(IResource resource) creates a link to show the content of the given resource.
Component	renderContentLink(IResource resource, Component comp) creates a link to show the content of the given resource.

Methods inherited from class java.lang.Object

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

Field Detail

NBSP

public static final String NBSP

See Also:

Constant Field Values

BLANK

public static final String BLANK

See Also:

Constant Field Values

START_URI

public static final String START_URI

See Also:

Constant Field Values

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 Component renderContentLink(IResource resource,
                                   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

WcmException

renderContentLink

public 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

WcmException

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