de.espirit.firstspirit.client.plugin.report

Interface DataRenderer<T>

Type Parameters:

T - The type of handled objects.

public interface DataRenderer<T>

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

Since:

5.1.19

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	getDetails(T object) Returns an evaluated detail html snippet for the given object or null if a detail is not available.
Image<?>	getIcon(T object) Provides the evaluated image resource for the given object or null if an type image is not available.
Image<?>	getThumbnail(T object) Provides the evaluated image resource 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.

Method Detail

getIcon

@Nullable
Image<?> getIcon(T object)

Provides the evaluated image resource for the given object or null if an type image is not available.

Parameters:

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

Returns:

Image or null if no image is to be shown.

Since:

5.1.19

See Also:

Image.Factory

getThumbnail

@Nullable
Image<?> getThumbnail(T object)

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

Parameters:

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

Returns:

Image or null if no thumbnail is to be shown.

Since:

5.1.19

See Also:

Image.Factory

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.1.19

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.1.19

getDetails

@Nullable
String getDetails(T object)

Returns an evaluated detail html snippet for the given object or null if a detail is not available.

Parameters:

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

Returns:

Detail html snippet or null.

Since:

5.1.19