Resource Renderer Settings

Use

A resource renderer is responsible for displaying a resource (file, folder, or link) on the screen.

In the configuration of a resource renderer, you can use a multitude of parameters to define the depiction of individual resources. For example, you can specify the font, symbols, command groups, and other parameters that are evaluated when a resource is rendered. The various definitions are defined in the configuration in the form of Resource Renderer Settings.

Integration

You reference resource renderer settings in a layout set .

Features

Each resource renderer setting is based on a Java class that implements a resource renderer . This reference is established in the configuration using the Resource Renderer(rndResourceRenderer)parameter.

Many parameters have selection options that are generally valid:

Selection	Effect
standard	The settings are adopted from the next level down (for example, the default layout profile). For more information, see Priority of Settings .
Not set	Initial value of a parameter. If Not set is selected and a resource renderer is specified in Base Settings (rndBaseSettings), the settings of that resource renderer are used.

Selection

Effect

standard

The settings are adopted from the next level down (for example, the default layout profile). For more information, see Priority of Settings .

Not set

Initial value of a parameter.

If Not set is selected and a resource renderer is specified in Base Settings (rndBaseSettings), the settings of that resource renderer are used.

Note

The Parameter column in the table below contains the name of the parameters as displayed on the interface followed by the technical name where appropriate. You need these technical names for specifications in the object type handler (OTH).

The configuration of a resource renderer settings includes the following parameters. Only the parameter Name is mandatory.

Parameters of a Resource Renderer Setting

Parameter	Description
Name	Name of the resource renderer setting.
Child Folder Delimiter (rndChildFolderDelimiter)	Character used to separate subfolders when displayed horizontally (Child Folders Style = horizontal). If you do not specify a character, the implementation decides the character to be used by default.
Description	Description of the resource renderer setting.
File Image Path (rndFileImage)	Image to be displayed in place of the default image for all files. The image can be stored in the local directory /etc/public/mimes/images or in a subdirectory thereof. Only specify the file name and subdirectory (if needed) in the input field.
Folder Image Path (rndFolderImage)	Image to be displayed in place of the default image for all folders. For more information on storing this file and the specification in the input field, see the File Image Path (rndFileImage) parameter.
Link Image Path (rndLinkImage)	Image to be displayed in place of the default image for all links. For more information on storing this file and the specification in the input field, see the File Image Path (rndFileImage) parameter.
Child Folders' Style (rndChildFolderStyle)	Specifies how the subfolders of a folder/category are displayed. horizontal vertical off: No subfolders are displayed.
Command Display (rndItemActionStyle)	Specifies how the commands for a resource are displayed. For more information, see Menus .
Highlighted Text Style (rndHighlightedTextStyle)	Specifies the style of highlighted text. Highlighted text is defined in the resource renderer. This can be the display name of the resource. The available specifications are HTMLB styles that can be maintained using the style editor.
Icon Setting (rndIconStyle)	Specifies how the icon for a resource is displayed. iconreplace: The default icon is replaced by another icon. namereplace: The name of the resource and the default icon are replaced by another icon. You can specify another symbol for the document in its Detals dialog box under Settings → Properties → Rendering. off: No icon is displayed.
Image Setting (rndImageStyle)	Specifies how the image is displayed on a business card. replace: The business card image is replaced with another image. You can specify another image in the Details dialog box for a document under Settings → Properties → Rendering. off: No image is displayed.
Mode for Child Count (rndShowChildCountStyle)	Specifies whether the number of contained resources is displayed when a folder is displayed. only folders: Specifies the number of contained folders. only folders: Specifies the number of contained files. folders/files: Specifies the number of folders and the number of files, separated by a forward slash. sum: Specifies the total of contained folders and files. off: The number of resources in the folder is not displayed.
Primary Text Style (rndPrimaryTextStyle)	Specifies the style of primary text. The text to be treated as primary text is defined in the resource renderer. This can be the display name of the resource. The available specifications are HTMLB styles that can be maintained using the style editor.
Secondary Text Style (rndSecondaryTextStyle)	Specifies the style of secondary text. The text that is treated as secondary text is defined in the resource renderer. This can be the size of a resource. The available specifications are HTMLB styles that can be maintained using the style editor.
Show Resource Properties (rndShowResourcePropStyle)	Specifies whether the properties of a resource that are specified in Visible Properties (rndVisibleProperties) are displayed in the list of resources. all: All properties are displayed. off: No properties are displayed.
Target Window Type (rndOpenTargetType)	Specifies the window that a resource is to be displayed in, if the user opens the resource, or specifies the style that the resource is displayed in. self: The resource is opened in the same window. blank: The resource is opened in a new window. fixed: The resource is opened in a predefined window. See Target Window Name. linklist: The resource is opened in the link list. favorites: The resources are displayed in the same style that is used to display entries in the favorites list. off: The resource is not displayed in the window.
Target Window Name (rndOpenTargetName)	Specifies a target window that is opened when a resource is opened. Only required if Target Window Type = fixed.
Tooltip Setting (rndTooltipStyle)	Specifies whether tooltips are displayed. path: Displays the resource path as a tooltip. The implementation of the resource renderer dictates whether a relative, absolute, or other path is displayed. technicalName: Displays the technical name of the resource. off: No tooltips are displayed.
Icon Height (rndIconHeight)	Specifies the height of a symbol in pixels. 0 means that the renderer determines the height according to the definition in the implementation.
Icon Width (rndIconWidth)	Specifies the width of a symbol in pixels. 0 means that the renderer determines the width according to the definition in the implementation.
Image Height (rndImageHeight)	Specifies the height of the image on a business card in pixels. 0 means that the renderer determines the height according to the definition in the implementation.
Image Width (rndImageWidth)	Specifies the width of the image on a business card in pixels. 0 means that the renderer determines the width according to the definition in the implementation.
Entry Height (rndItemHeight)	Specifies the height of an entry in a resource list in pixels. 0 means that the renderer determines the height according to the definition in the implementation.
Entry Width (rndItemWidth)	Specifies the width of an entry in a resource list in pixels. 0 means that the renderer determines the width according to the definition in the implementation.
Max Number of Child Folders (rndMaxChildFolders)	Determines the maximum number of subfolders that are displayed when a folder is rendered.
Visible Properties (rndVisibleProperties)	Specifies the document properties to be displayed by the resource renderer. These are predefined properties that you created with the property metadata service . For more information, see Displaying Properties .
Base Settings (rndBaseSettings)	Specifies a preconfigured resource renderer whose settings are to be used as the basis for this resource renderer. The settings of the referenced resource renderer are overwritten by the current settings.
Flavor	Specifies a flavor . The possible flavors are defined in the layout controller that you specify in the definition of a layout set .
Folder Command Group (rndFolderCommandGroup)	Specifies a command group used for folders.
Link Command Group (rndLinkCommandGroup)	Specifies a command group used for links.
Resource Command Group (rndResourceCommandGroup)	Specifies a command group used for documents.
Resource Renderer (rndResourceRenderer)	Specifies a resource renderer . This is an alias for a Java class that implements a resource renderer.

You can use a special type of resource renderer settings to depict documents that were created using the XML forms builder. For more information, see Creating Lists with Alternative Layouts . The XML forms renderer settings differs only in one parameter from the resource renderer settings already described.

Parameters of an XML Forms Renderer Setting

Parameter	Description
XML Forms Transformation	Name of an XSL transformation that is valid for the XML forms renderer setting. The name of the XSL transformation corresponds to the name of the form on which the documents to be displayed are based.

Parameter

Description

XML Forms Transformation

Name of an XSL transformation that is valid for the XML forms renderer setting.

The name of the XSL transformation corresponds to the name of the form on which the documents to be displayed are based.

Activities

To create resource renderer settings, choose Content Management → User Interface → Settings → Resource Renderer Settings → Resource Renderer Settings.

To create XML forms renderer settings, choose Content Management → User Interface → Settings → Resource Renderer Settings → XML Forms Renderer Settings.