Package de.xima.fc.form.common.models

Class FormThemeReference.FormThemePlugin

java.lang.Object

de.xima.fc.form.common.models.FormThemeReference

de.xima.fc.form.common.models.FormThemeReference.FormThemePlugin

All Implemented Interfaces:

Serializable

Enclosing class:

FormThemeReference

public static final class FormThemeReference.FormThemePlugin
extends FormThemeReference

A form theme reference to a form theme provided by a plugin, i.e. de.xima.fc.plugin.form.IPluginFormTheme.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.form.common.models.FormThemeReference

FormThemeReference.ClientFormTheme, FormThemeReference.DefaultMatcher<R,E extends Throwable>, FormThemeReference.FormThemePlugin, FormThemeReference.FormThemeReferenceDeserializer, FormThemeReference.Matcher<R,E extends Throwable>, FormThemeReference.System

Method Summary

Modifier and Type	Method	Description
int	canonicalPayloadPartsLength()	Gets the length of the parts representing the payload of this reference, i.e. the length of the array returned by FormThemeReference.toCanonicalPayloadParts().
FormThemeReference	copy()	Creates a copy of this form theme reference.
boolean	equals(Object o)
protected void	fillCanonicalPayloadParts(String[] parts, int offset)
String	getPluginKey()	Gets the key of the referenced plugin.
String	getPluginName()	Gets the name of the referenced plugin class.
String	getThemeId()	Gets the ID of the plugin.
int	hashCode()
EFormThemeReferenceKind	kind()	Gets the enum constant that represents the kind of this form theme reference.
String	toCanonicalPayloadString()	Converts this form theme reference to its canonical string representation.
String	toSimpleName()	Gets a simple name describing this reference.
String	toString()

Methods inherited from class de.xima.fc.form.common.models.FormThemeReference

canonicalPartsLength, clientFormTheme, clone, formThemePlugin, matchFormThemeReference, ofAttributeMap, ofCanonicalParts, ofCanonicalPartsOrNull, ofCanonicalPayloadParts, ofCanonicalPayloadPartsOrNull, ofCanonicalPayloadString, ofCanonicalPayloadStringOrNull, ofCanonicalString, ofCanonicalStringOrNull, system, systemClassic, systemModern, systemUnstyled, toAttributeMap, toCanonicalParts, toCanonicalPayloadParts, toCanonicalString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

canonicalPayloadPartsLength

public int canonicalPayloadPartsLength()

Description copied from class: FormThemeReference

Gets the length of the parts representing the payload of this reference, i.e. the length of the array returned by FormThemeReference.toCanonicalPayloadParts(). The payload is the data of this reference, without the FormThemeReference.kind().

Specified by:

canonicalPayloadPartsLength in class FormThemeReference

Returns:

The length of the parts representing this reference.

copy

public FormThemeReference copy()

Description copied from class: FormThemeReference

Creates a copy of this form theme reference.

Specified by:

copy in class FormThemeReference

Returns:

A copy of this form theme reference.

equals

public boolean equals(Object o)

Specified by:

equals in class FormThemeReference

getPluginKey

public String getPluginKey()

Gets the key of the referenced plugin. Each plugin JAR file must contain a MANIFEST.MF with an attribute Plugin-Key that specifies the unique key of the plugin.

Returns:

The key of the plugin.

getPluginName

public String getPluginName()

Gets the name of the referenced plugin class. This corresponds to the String de.xima.fc.plugin.interfaces.IFCPlugin#getName() of the plugin. The plugin name is only required to be unique amongst the plugins in the same plugin JAR file.

Returns:

The name of the plugin.

getThemeId

public String getThemeId()

Gets the ID of the plugin. Each form theme plugin may provide multiple form themes, each with a unique ID. The theme ID is only required to be unique amongst the themes provided by the same plugin class.

Returns:

The ID of the theme.

hashCode

public int hashCode()

Specified by:

hashCode in class FormThemeReference

kind

public EFormThemeReferenceKind kind()

Description copied from class: FormThemeReference

Gets the enum constant that represents the kind of this form theme reference.

Specified by:

kind in class FormThemeReference

Returns:

The kind of the form theme reference.

toCanonicalPayloadString

public String toCanonicalPayloadString()

Description copied from class: FormThemeReference

Converts this form theme reference to its canonical string representation. Only includes the data of this particular FormThemeReference.kind() of reference, does not include data regarding which kind of reference this is.

Specified by:

toCanonicalPayloadString in class FormThemeReference

Returns:

The canonical string representation of the form theme reference.

See Also:

FormThemeReference.toCanonicalParts()

toSimpleName

public String toSimpleName()

Description copied from class: FormThemeReference

Gets a simple name describing this reference. Should not be used for any purposes other than to pretty-print the reference.

Specified by:

toSimpleName in class FormThemeReference

Returns:

A simple name describing this reference.

toString

public String toString()

Overrides:

toString in class Object

fillCanonicalPayloadParts

protected void fillCanonicalPayloadParts(String[] parts,
                                         int offset)

Specified by:

fillCanonicalPayloadParts in class FormThemeReference