to.etc.domui.themes

Class FragmentedThemeFactory

java.lang.Object

to.etc.domui.themes.FragmentedThemeFactory

@DefaultNonNull
public class FragmentedThemeFactory
extends Object

This theme factory uses fragments to create a "theme". A DomUI theme consists of the following:

• A style sheet containing all css for all components.
• A set of icons that are used by that stylesheet
• A color definition consisting of icons and .js files that contain stylesheet resources of a given color.
• A variant that allows addressing a separate stylesheet for the theme.

All of these together form a "theme instance" (an ITheme).

A theme is identified by 4 strings, one for each components: a style name, a iconset name, a color name and a variant name. The full theme is then described as a string: style/iconset/color/variant. An example theme instance is: "domui/domui/orange/default". This four-part string is the theme name. This factory is used to instantiate a theme instance for a specific "theme name".

.

The first three parts of the theme name come from an application-level global setting: the string set as DomApplication.setCurrentTheme(String). This defines the "global" theme for the application. The last part, the variant, is provided by the page itself: it allows a page to specify a different version for the master stylesheet. The use case for this is migration to different style sheets if an older one has problems; by creating pages that refer to a new sheet we can change the stylesheet without regression risk for existing pages.

The different parts of the theme are constructed as follows:

• A 'style name' (s) which identifies a directory with the name 'themes/css-{s}' containing *.frag.css files and some .js files. The files in here form the master stylesheet by concatenating themselves in alphabetic order.
• The variant name is added to the style name except if the variant is "default". So for a variant 'clean' the complete style name would be domui-clean, and the directory for it's css files would be css-domui-clean.

This class collects all ".frag.css" files in the specified "directory", while allowing them to be "overridden" in other parts of the structure. The resulting set of .frag.css files is then run through the template compiler (one by one) to create the final result. This result should be the "actual" css file to use.

Style inheritance

A style can 'inherit' another style. This is done in each style's ".jsprops" file where the file must start with an "inherit('xxxx')" statement.

Author:

Frits Jalvingh Created on Jan 5, 2011

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FragmentedThemeFactory(DomApplication da, String themeName) Constructor for a factory instance that will generate the ITheme.

Method Summary

Modifier and Type	Method and Description
List<String>	collectFragments(List<String> directoryStack, String suffix)
protected ITheme	createTheme() Instance creation.
protected RhinoExecutor	executor() Get the shared executor and scope.
protected IResourceRef	findRef(IResourceDependencyList rdl, String rurl)
protected DomApplication	getApplication()
protected ResourceDependencyList	getCurrentDependencies()
static IThemeFactory	getInstance()
protected List<String>	getSearchList()
protected String	getStylesheet()
protected String	getThemeName()
void	internalInheritColor(String colorName) Load color properties.
void	internalInheritIcon(String iconName) Load the icon set specified.
void	internalInheritStyle(String styleName)
protected void	loadClear() Initialize for loading a new set.
protected void	loadColors(String colorName) Load everything related to colors.
protected void	loadIcons(String iconName, String variant) Load all icon related info.
protected void	loadStyle(String styleName, String variant) Load all theme style (css) related info.
protected void	loadStyleInfo()

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentedThemeFactory

protected FragmentedThemeFactory(DomApplication da,
                                 String themeName)

Constructor for a factory instance that will generate the ITheme.

Parameters:

da -

themeName -

Method Detail

getInstance

public static IThemeFactory getInstance()

executor

@Nonnull
protected RhinoExecutor executor()
                                   throws Exception

Get the shared executor and scope. If it does not yet exist it is created.

Returns:

Throws:

Exception

createTheme

protected ITheme createTheme()
                      throws Exception

Instance creation.

Returns:

Throws:

Exception

loadStyleInfo

protected void loadStyleInfo()
                      throws Exception

Throws:

Exception

loadStyle

protected void loadStyle(String styleName,
                         String variant)
                  throws Exception

Load all theme style (css) related info. The styleName is a folder name inside themes/; that folder must contain a "style.props.js" property file and contains multiple xxxx.frag.css files.

Parameters:

styleName -

variant -

Throws:

Exception

internalInheritStyle

public void internalInheritStyle(String styleName)
                          throws Exception

Throws:

Exception

loadIcons

protected void loadIcons(String iconName,
                         String variant)
                  throws Exception

Load all icon related info. Each icon set is in a separate folder inside the "themes" structure; each folder is required to hold icon.props.js and optional icon resources. Each icon set that is "inherited" becomes part of the search path, meaning that theme resources will first be located in a specific icon path before being found in the theme itself.

Icon sets consist of a set of property file fragments too.

Parameters:

variant -

iconName -

Throws:

Exception

internalInheritIcon

public void internalInheritIcon(String iconName)
                         throws Exception

Load the icon set specified. The iconName is a simple name; this code will convert it to a directory name.

Parameters:

iconName -

Throws:

Exception

loadColors

protected void loadColors(String colorName)
                   throws Exception

Load everything related to colors. Results in the current IScriptScope being filled with all color properties.

Parameters:

colorName -

Throws:

Exception

internalInheritColor

public void internalInheritColor(String colorName)
                          throws Exception

Load color properties. For a color [x] this loads $themes/[x].color.js. A color set can inherit from another color set, by

Parameters:

colorName -

Throws:

Exception

getCurrentDependencies

protected ResourceDependencyList getCurrentDependencies()

loadClear

protected void loadClear()

Initialize for loading a new set. Clears all information of the previously loaded set.

findRef

@Nullable
protected IResourceRef findRef(@Nonnull
                                         IResourceDependencyList rdl,
                                         @Nonnull
                                         String rurl)
                                  throws Exception

Throws:

Exception

collectFragments

public List<String> collectFragments(List<String> directoryStack,
                                     String suffix)
                              throws Exception

Throws:

Exception

getThemeName

protected String getThemeName()

getApplication

protected DomApplication getApplication()

getStylesheet

@Nullable
protected String getStylesheet()

getSearchList

protected List<String> getSearchList()