org.molgenis.ui.style

Interface StyleService

All Known Implementing Classes:

StyleServiceImpl

public interface StyleService

Method Summary

Modifier and Type	Method and Description
Style	addStyle(String styleId, String bootstrap3FileName, InputStream bootstrap3StyleData, String bootstrap4FileName, InputStream bootstrap4StyleData) Add a bootstrap theme
StyleSheet	findThemeByName(String themeName) Find the styleSheet for a given theme name
Set<Style>	getAvailableStyles() Fetches the available styleSheet from the data store and stores them in a list
Style	getSelectedStyle() Get the style that is currently selected
Style	getStyle(String styleName) Returns a style that matches the name of the given input
org.springframework.core.io.FileSystemResource	getThemeData(String styleName, BootstrapVersion bootstrapVersion) Get the styleSheet data for a given theme and bootstrap version ( 3 or 4 )
void	setSelectedStyle(String styleName) Set the runtime property that controls the css style with a selected style

Method Detail

getAvailableStyles

Set<Style> getAvailableStyles()

Fetches the available styleSheet from the data store and stores them in a list

Returns:

A Set of available Styles found on the file system

addStyle

Style addStyle(String styleId,
               String bootstrap3FileName,
               InputStream bootstrap3StyleData,
               String bootstrap4FileName,
               InputStream bootstrap4StyleData)
        throws MolgenisStyleException

Add a bootstrap theme

Parameters:

styleId - the them identifier used in the request

bootstrap3FileName - the name to use as fileName for the bootstrap 3 file

bootstrap3StyleData - the bootstrap 3 style data

bootstrap4FileName - the name to use as fileName for the bootstrap 4 file, this is optional

bootstrap4StyleData - the bootstrap 4 style data, this is optional

Throws:

MolgenisStyleException

setSelectedStyle

void setSelectedStyle(String styleName)

Set the runtime property that controls the css style with a selected style

getSelectedStyle

Style getSelectedStyle()

Get the style that is currently selected

Returns:

Which style is currently selected

getStyle

Style getStyle(String styleName)

Returns a style that matches the name of the given input

Returns:

The Style that matches the name

getThemeData

org.springframework.core.io.FileSystemResource getThemeData(String styleName,
                                                            BootstrapVersion bootstrapVersion)
                                                     throws MolgenisStyleException

Get the styleSheet data for a given theme and bootstrap version ( 3 or 4 )

Parameters:

styleName - the theme identifier

bootstrapVersion - the bootstrap version ( 3 or 4)

Returns:

The theme data, as setting the bootstrap 4 theme is optional the fallback bootstrap 4 theme data is returned in case there is not theme data for the bootstrap 4 version.

Throws:

MolgenisStyleException

findThemeByName

StyleSheet findThemeByName(String themeName)

Find the styleSheet for a given theme name

Parameters:

themeName - the name of the theme

Returns:

The styleSheet entity or null in case no theme matching the given name is found