Package de.xima.fc.plugin.models.retval.form

Class DefaultPluginFormElementTemplateIcon

java.lang.Object

de.xima.fc.plugin.models.retval.form.DefaultPluginFormElementTemplateIcon

All Implemented Interfaces:

IPluginFormElementTemplateIcon, Serializable

public final class DefaultPluginFormElementTemplateIcon
extends Object
implements IPluginFormElementTemplateIcon

Default POJO implementation of IPluginFormElementTemplateIcon.

Since:

8.0.1

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultPluginFormElementTemplateIcon(String mediaType, URI uri)	Creates a new icon with a media type and URI.

Method Summary

Modifier and Type	Method	Description
String	getMediaType()	Gets the media type for the icon, such as image/png or image/svg+xml.
URI	getUri()	The URI with the icon's data, which is then passed to loadIcon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPluginFormElementTemplateIcon

public DefaultPluginFormElementTemplateIcon(String mediaType,
                                            URI uri)

Creates a new icon with a media type and URI.

Parameters:

mediaType - Media type of the icon, e.g. image/png.

uri - URI of the icon, see IPluginFormElementTemplateDescriptor.getIcon(Locale).

Method Detail

getMediaType

public String getMediaType()

Description copied from interface: IPluginFormElementTemplateIcon

Gets the media type for the icon, such as image/png or image/svg+xml.

Specified by:

getMediaType in interface IPluginFormElementTemplateIcon

Returns:

The media type of the icon.

getUri

public URI getUri()

Description copied from interface: IPluginFormElementTemplateIcon

The URI with the icon's data, which is then passed to loadIcon.

Note: The resource might be cached with the returned URI as the cache key. Plugins should append e.g. a version parameter (such as the plugin version) to the URI if needed.

Specified by:

getUri in interface IPluginFormElementTemplateIcon

Returns:

URI for the icon's data.