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

Class FormThemeFileReference

java.lang.Object

de.xima.fc.form.common.models.FormThemeFileReference

All Implemented Interfaces:

Serializable

public final class FormThemeFileReference
extends Object
implements Serializable

A reference to particular file from a IFormTheme. Uniquely identifies a file from a form theme. Such a reference can be used later to retrieve the content of the file.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static FormThemeFileReference	forThemeFile(FormThemeReference theme, String context, String filePath)	Creates a reference to a file in a form theme.
String	getContext()	The context of the resource, see EFormThemeResourceContext for well-known contexts.
String	getFilePath()	The path of the file in the form theme, see IFormTheme#getFilePaths.
FormThemeReference	getTheme()	The reference to the form theme that contains the file.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getContext

public String getContext()

The context of the resource, see EFormThemeResourceContext for well-known contexts.

Returns:

The context of the resource.

getFilePath

public String getFilePath()

The path of the file in the form theme, see IFormTheme#getFilePaths.

Returns:

The file name of the file in the form theme.

getTheme

public FormThemeReference getTheme()

The reference to the form theme that contains the file.

Returns:

The reference to the form theme that contains the file.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

forThemeFile

public static FormThemeFileReference forThemeFile(FormThemeReference theme,
                                                  String context,
                                                  String filePath)

Creates a reference to a file in a form theme.

Parameters:

theme - The reference to the form theme that contains the file.

context - The context of the resource, see EFormThemeResourceContext for well-known contexts.

filePath - The path of the file in the form theme, see IFormTheme#getFilePaths.

Returns:

A reference to a file in a form theme.