Package de.xima.fc.gui.designer.form.model

Class FormThemeItem

java.lang.Object

de.xima.fc.gui.designer.form.model.FormThemeItem

public final class FormThemeItem
extends Object

A FormThemeReference with a display name.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormThemeItem(String name, String groupName, FormThemeReference value, FormThemeReference parent, List<String> cssClasses, List<FormThemeItemCssUrl> cssUrls)	Creates a new form them item with the given data.

Method Summary

Modifier and Type	Method	Description
List<String>	getCssClasses()	Gets a list of CSS classes that are added to the container element when this theme is selected.
List<FormThemeItemCssUrl>	getCssUrls()	A list of URLs with the CSS files that need to be included when this theme is selected.
String	getGroupName()	Gets the localized name of the group the form theme belongs to.
String	getName()	Gets the localized display name of the form theme.
FormThemeReference	getParent()	Gets the parent form theme of the form theme, if it has any.
FormThemeReference	getValue()	Gets the unique identifier of the form theme.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormThemeItem

public FormThemeItem(String name,
                     String groupName,
                     FormThemeReference value,
                     FormThemeReference parent,
                     List<String> cssClasses,
                     List<FormThemeItemCssUrl> cssUrls)

Creates a new form them item with the given data.

Parameters:

name - The localized display name of the form theme.

groupName - The localized name of the group the form theme belongs to.

value - The unique identifier of the form theme.

parent - The parent theme, may be null.

cssClasses - A list of CSS classes that are added to the container element when this theme is selected.

cssUrls - A list of CSS URLs with the files that need to be included when this theme is selected.

Method Detail

getCssClasses

public List<String> getCssClasses()

Gets a list of CSS classes that are added to the container element when this theme is selected.

Returns:

A list of CSS classes.

getCssUrls

public List<FormThemeItemCssUrl> getCssUrls()

A list of URLs with the CSS files that need to be included when this theme is selected.

Returns:

A list of CSS files.

getGroupName

public String getGroupName()

Gets the localized name of the group the form theme belongs to. The group is used e.g. to group themes in a dropdown on the UI.

Returns:

The name of the theme's group.

getName

public String getName()

Gets the localized display name of the form theme.

Returns:

The name of the form theme.

getParent

public FormThemeReference getParent()

Gets the parent form theme of the form theme, if it has any.

Returns:

The parent form theme, null if the form theme has no parent.

getValue

public FormThemeReference getValue()

Gets the unique identifier of the form theme.

Returns:

The unique identifier.