public interface SnippetAgent
Modifier and Type | Interface and Description |
---|---|
static interface |
SnippetAgent.Fallback
Fallback configuration object definition.
|
Modifier and Type | Field and Description |
---|---|
static SpecialistType<SnippetAgent> |
TYPE
Agent providing image containers.
|
Modifier and Type | Method and Description |
---|---|
SnippetAgent.Fallback |
fallback()
Creates a new fallback configuration object with its default strategies in place.
|
SnippetProvider |
getSnippetProvider(FormData formData,
Snippet snippet)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
getSnippetProvider(FormData formData,
Snippet snippet,
SnippetContext context)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
getSnippetProvider(IDProvider element)
Hands out a snippet provider for the given element or
null , if no snippet provider is available. |
SnippetProvider |
getSnippetProvider(IDProvider element,
SnippetAgent.Fallback fallback)
Hands out a snippet provider for the given element applying the given fallback strategy.
|
Image<?> |
getTypeIcon(IDProvider element)
Provides a type image resource for the given element.
|
static final SpecialistType<SnippetAgent> TYPE
@Nullable Image<?> getTypeIcon(@NotNull IDProvider element)
null
, if no type image is available.element
- The element that is to be rendered in report lists.null
if no image is to be shown.@NotNull SnippetProvider getSnippetProvider(@NotNull IDProvider element)
null
, if no snippet provider is available.
This is a convenience method for getSnippetProvider(IDProvider, Fallback)
with default fallback
configuration.element
- The element to provide for.null
.@NotNull SnippetProvider getSnippetProvider(@NotNull IDProvider element, @NotNull SnippetAgent.Fallback fallback)
element
- The element to provide for.fallback
- The fallback configuration.@NotNull SnippetProvider getSnippetProvider(@NotNull FormData formData, @NotNull Snippet snippet)
getSnippetProvider(FormData, Snippet, SnippetContext)
employing the snippet context
with its defined default values.formData
- The form data to base snippets on.snippet
- The snippet definition.@NotNull SnippetProvider getSnippetProvider(@NotNull FormData formData, @NotNull Snippet snippet, @NotNull SnippetContext context)
formData
- The form data to base snippets on.snippet
- The snippet definition.context
- A snippet context provider@NotNull SnippetAgent.Fallback fallback()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210