de.espirit.firstspirit.webedit.plugin.report

Interface ReportPluginRenderer<T>

Type Parameters:

T - The type of handled objects.

public interface ReportPluginRenderer<T>

Renders object-specific data for use in individual snippets of report result lists.

Since:

5.0.103

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription(T object) Returns an evaluated description for the given object or null if a description is not available.
String	getThumbnail(T object) Provides the evaluated thumbnail URL for the given object or null if an image representation is not available.
String	getTitle(T object) Provides an evaluated title for the given object.
String	getTransferData(T object) Returns evaluated transfer data for the given object or null if not available.

Method Detail

getThumbnail

@Nullable
String getThumbnail(T object)

Provides the evaluated thumbnail URL for the given object or null if an image representation is not available.

The thumbnail URL may be absolute. If the URL is not absolute, it will be considered relative to the project-specific WebClient web application's directory.

Parameters:

object - The object that is to be rendered in the report list.

Returns:

Thumbnail URL or null if not thumbnail is to be shown.

Since:

5.0.103

getTitle

String getTitle(T object)

Provides an evaluated title for the given object.

Parameters:

object - The object that is to be rendered in the report list.

Returns:

Title text.

Since:

5.0.103

getDescription

@Nullable
String getDescription(T object)

Returns an evaluated description for the given object or null if a description is not available.

Parameters:

object - The object that is to be rendered in the report list.

Returns:

Description text or null.

Since:

5.0.103

getTransferData

@Nullable
String getTransferData(T object)

Returns evaluated transfer data for the given object or null if not available.

The transfer data can be dragged by the user (client-side) and dropped onto an FS_BUTTON instance that supports plain-text content as a DROPTYPE.

Parameters:

object - The object that is to be rendered in the report list.

Returns:

Transfer data string or null if not available.

Since:

5.0.103