de.espirit.firstspirit.client.plugin

Interface ReportPlugin<T>

Type Parameters:

T - The type of handled objects.

All Superinterfaces:

ItemsPlugin<ReportItem<T>>, Plugin, Public

public interface ReportPlugin<T>
extends ItemsPlugin<ReportItem<T>>

Interface for WebClient report plug-ins.

Since:

5.1.19

Method Summary

Methods

Modifier and Type	Method and Description
DataProvider<T>	createDataProvider() Factory method to create an object provider instance for use with this report plug-in.
DataRenderer<T>	createDataRenderer() Factory method to create a renderer instance for use with this report plug-in.
TransferHandler<T>	createTransferHandler() Factory method to create a transfer handler instance for use with this report plug-in.
ReportItem<T>	getDefaultItem() Returns the default item of this report plugin, or null if not supported.
Image<?>	getIcon(boolean selected) Returns a URL for the report's icon graphic that will be shown in the WebClient.
List<Parameter<?>>	getParameter() Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.
String	getTitle() Returns a human-readable title representing this report plug-in.
boolean	isVisible() Returns whether or not this report plugin should be visible in the current environment.

Methods inherited from interface de.espirit.firstspirit.client.plugin.ItemsPlugin

getItems

Methods inherited from interface de.espirit.firstspirit.client.plugin.Plugin

setUp, tearDown

Method Detail

isVisible

boolean isVisible()

Returns whether or not this report plugin should be visible in the current environment.

Returns:

The report visibility

Since:

5.1.19

See Also:

BaseContext.is(BaseContext.Env)

getTitle

String getTitle()

Returns a human-readable title representing this report plug-in.

Returns:

The report title.

Since:

5.1.19

getIcon

@Nullable
Image<?> getIcon(boolean selected)

Returns a URL for the report's icon graphic that will be shown in the WebClient. The URL may be relative to the WebClient web application's root directory or absolute.

WebClient will request either a "normal" or a "selected" icon state, depending on the context, in which the icon should be displayed:

• The "normal" icon graphic should include the report's regular icon.
• The "selected" icon graphic should imply an active state.

Parameters:

selected - The selected-state of the icon.

Returns:

Icon or null if a generic icon should be used.

Since:

5.1.19

See Also:

Image.Factory

getParameter

@NotNull
List<Parameter<?>> getParameter()

Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.

Returns:

A Parameter list.

Since:

5.1.19

See Also:

Parameter.Factory

createDataProvider

@NotNull
DataProvider<T> createDataProvider()

Factory method to create an object provider instance for use with this report plug-in.

Returns:

The object provider instance.

Since:

5.1.19

createDataRenderer

@NotNull
DataRenderer<T> createDataRenderer()

Factory method to create a renderer instance for use with this report plug-in.

Returns:

The renderer instance.

Since:

5.1.19

createTransferHandler

@Nullable
TransferHandler<T> createTransferHandler()

Factory method to create a transfer handler instance for use with this report plug-in.

Returns:

The transfer handler instance

Since:

5.1.19

getDefaultItem

@Nullable
ReportItem<T> getDefaultItem()

Returns the default item of this report plugin, or null if not supported. The operation, provided by the returned item, will be executed on an user-generated click-event.

Returns:

default item, or null

Since:

5.1.27