io.jmix.ui

Class UiThemeProperties

java.lang.Object

io.jmix.ui.UiThemeProperties

@ConfigurationProperties(prefix="jmix.ui.theme")
 @ConstructorBinding
public class UiThemeProperties
extends java.lang.Object

Theme configuration properties class.

Constructor Summary

Constructors

Constructor and Description
UiThemeProperties(java.lang.String name, java.util.List<java.lang.String> modes, java.lang.String defaultMode, java.lang.String defaultModeToUse, java.util.List<java.lang.String> sizes, java.lang.String defaultSize, java.lang.String defaultSizeToUse)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultMode() Returns the name of color preset that has no additional style class name.
java.lang.String	getDefaultModeToUse() Returns the name of color preset to be used if no other settings are available.
java.lang.String	getDefaultSize() Returns the name of size preset that has no additional style class name.
java.lang.String	getDefaultSizeToUse() Returns the name of size preset to be used if no other settings are available.
java.util.List<java.lang.String>	getModes()
java.lang.String	getName()
java.util.List<java.lang.String>	getSizes()

Methods inherited from class java.lang.Object

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

Constructor Detail

UiThemeProperties

public UiThemeProperties(@DefaultValue(value="helium")
                         java.lang.String name,
                         @DefaultValue(value={"light","dark"})
                         java.util.List<java.lang.String> modes,
                         @DefaultValue(value="light")
                         java.lang.String defaultMode,
                         @Nullable
                         java.lang.String defaultModeToUse,
                         @DefaultValue(value={"small","medium","large"})
                         java.util.List<java.lang.String> sizes,
                         @DefaultValue(value="medium")
                         java.lang.String defaultSize,
                         @Nullable
                         java.lang.String defaultSizeToUse)

Method Detail

getName

public java.lang.String getName()

Returns:

the name of the currently used UI theme

getModes

public java.util.List<java.lang.String> getModes()

Returns:

the list of available theme modes, i.e. color presets

getDefaultMode

public java.lang.String getDefaultMode()

Returns the name of color preset that has no additional style class name.

Note: can’t be changed without corresponding changes in styles.

Returns:

the name of color preset that has no additional style class name

getDefaultModeToUse

@Nullable
public java.lang.String getDefaultModeToUse()

Returns the name of color preset to be used if no other settings are available.

Either cookie or user settings obtained from UserSettingService have precedence over this value.

Returns:

the name of color preset to be used if no other settings are available

getSizes

public java.util.List<java.lang.String> getSizes()

Returns:

the list of available theme size presets

getDefaultSize

public java.lang.String getDefaultSize()

Returns the name of size preset that has no additional style class name.

Note: can’t be changed without corresponding changes in styles.

Returns:

the name of size preset that has no additional style class name

getDefaultSizeToUse

@Nullable
public java.lang.String getDefaultSizeToUse()

Returns the name of size preset to be used if no other settings are available.

Either cookie or user settings obtained from UserSettingService have precedence over this value.

Returns:

the name of size preset to be used if no other settings are available