Interface ReportPlugin<T>
- Type Parameters:
T
- The type of handled objects.
- All Superinterfaces:
ItemsPlugin<ReportItem<T>>
,Plugin
,Public
Interface for report plug-ins integrated in both clients ContentCreator and SiteArchitect.
- Since:
- 5.1.19
-
Method Summary
Modifier and TypeMethodDescription@NotNull DataProvider<T>
Factory method to create an object provider instance for use with this report plug-in.@NotNull DataRenderer<T>
Factory method to create a renderer instance for use with this report plug-in.@Nullable TransferHandler<T>
Factory method to create a transfer handler instance for use with this report plug-in.@Nullable ReportItem<T>
Returns the default item of this report plugin, ornull
if not supported.@Nullable Image<?>
getIcon
(boolean selected) Returns a URL for the report's icon graphic that will be shown in the client.Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.getTitle()
Returns a human-readable title representing this report plug-in.boolean
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
-
Method Details
-
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:
-
getTitle
String getTitle()Returns a human-readable title representing this report plug-in.- Returns:
- The report title.
- Since:
- 5.1.19
-
getIcon
Returns a URL for the report's icon graphic that will be shown in the client.
The client 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:
-
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:
-
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
Factory method to create a renderer instance for use with this report plug-in.- Returns:
- The renderer instance.
- Since:
- 5.1.19
-
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
Returns the default item of this report plugin, ornull
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
-