Class DefaultPluginFormResourceDescriptor
java.lang.Object
de.xima.fc.plugin.models.retval.form.DefaultPluginFormResourceDescriptor
- All Implemented Interfaces:
IPluginFormResourceDescriptor
public final class DefaultPluginFormResourceDescriptor
extends Object
implements IPluginFormResourceDescriptor
POJO implementation of
IPluginFormResourceDescriptor with a builder.- Since:
- 8.3.0
- Author:
- XIMA MEDIA GmbH
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA builder for aDefaultPluginFormResourceDescriptor. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Creates a builder for aDefaultPluginFormResourceDescriptor.Gets the name of the file, including the file extension (if any), e.g.Gets the mime type of the resource, e.g.Gets the accessor for the resources binary content.booleanWhether to include the resource automatically in all forms.boolean
-
Method Details
-
getFileName
Description copied from interface:IPluginFormResourceDescriptorGets the name of the file, including the file extension (if any), e.g. "style.css". File names are case-sensitive. The file name may also contain slashes, e.g. "images/logo.png". These indicate (virtual) sub folders. The HTTP endpoint, for example, uses these sub folders in the URL, which affects the resolution of relative paths.The file name must be unique among all resources provided by the plugin. Different plugins may provide resources with the same file name.
- Specified by:
getFileNamein interfaceIPluginFormResourceDescriptor- Returns:
- The name of the file, including the file extension.
-
getMimeType
Description copied from interface:IPluginFormResourceDescriptorGets the mime type of the resource, e.g. "text/css" for CSS files.- Specified by:
getMimeTypein interfaceIPluginFormResourceDescriptor- Returns:
- The mime type of the resource.
-
getResource
Description copied from interface:IPluginFormResourceDescriptorGets the accessor for the resources binary content.- Specified by:
getResourcein interfaceIPluginFormResourceDescriptor- Returns:
- The accessor for the resources binary content.
-
isIncludeInForm
public boolean isIncludeInForm()Description copied from interface:IPluginFormResourceDescriptorWhether to include the resource automatically in all forms. If false, the resource is still available via the HTTP endpoint, but must be included manually. If true, the resource will be included in all rendered web forms.Note: Currently, this feature is supported only for CSS and JavaScript files, i.e. resource whose
IPluginFormResourceDescriptor.getMimeType()is "text/css" or "text/javascript".- Specified by:
isIncludeInFormin interfaceIPluginFormResourceDescriptor- Returns:
- Whether to include the resource automatically in all forms.
-
isIncludeInTemplate
public boolean isIncludeInTemplate()Description copied from interface:IPluginFormResourceDescriptorWhether to include the resource automatically in allHTMLtemplates. If false, the resource is still available via the HTTP endpoint, but must be referenced manually. If true, the resource will be included in all rendered HTML templates.Note: Currently, this feature is supported only for CSS and JavaScript files, i.e. resource whose
IPluginFormResourceDescriptor.getMimeType()is "text/css" or "text/javascript".- Specified by:
isIncludeInTemplatein interfaceIPluginFormResourceDescriptor- Returns:
- Whether to include the resource automatically in all forms.
-
builder
Creates a builder for aDefaultPluginFormResourceDescriptor.- Returns:
- A new builder.
-