Package org.ametys.skinfactory.parameters

Class CSSParameter

java.lang.Object

org.ametys.skinfactory.parameters.AbstractSkinParameter

org.ametys.skinfactory.parameters.CSSParameter

Direct Known Subclasses:

CSSColorParameter

public class CSSParameter
extends AbstractSkinParameter

Implementation of AbstractSkinParameter for a CSS property

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.skinfactory.parameters.AbstractSkinParameter

AbstractSkinParameter.SkinParameterType, AbstractSkinParameter.Widget

Constructor Summary

Constructors

Constructor	Description
CSSParameter(String id, I18nizableText label, I18nizableText description, Path cssFile, String cssProperty, String defaultValue)	Constructor
CSSParameter(String id, I18nizableText label, I18nizableText description, List<Path> cssFiles, String cssProperty, String defaultValue)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addCSSFile(Path cssFile)	Add a CSS file
void	apply(Path tempDir, Path modelDir, Object value, String lang)	Apply parameter to the skin
protected String	cssFileToString(Path cssFile)	Get the css file input stream as String
List<Path>	getCSSFiles()	Get the CSS files path
protected Pattern	getCSSPattern()	Get the CSS pattern
String	getCSSProperty()	Get the CSS property
String	getDefaultValue(SkinModel model)	Get the default value
String	getDefaultValue(SkinModel model, String lang)	Get the default value
AbstractSkinParameter.SkinParameterType	getType()	Get type
Map<String,Object>	toJson(String modelName)	Transform the parameter into a JSON object
void	toSAX(ContentHandler contentHandler, String modelName)	SAX the parameter

Methods inherited from class org.ametys.skinfactory.parameters.AbstractSkinParameter

getDescription, getId, getLabel, setDescription, setLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

CSSParameter

public CSSParameter(String id,
                    I18nizableText label,
                    I18nizableText description,
                    Path cssFile,
                    String cssProperty,
                    String defaultValue)

Constructor

Parameters:

id - the unique id

label - the label

description - the description

cssFile - the css file

cssProperty - the css property

defaultValue - the default value

CSSParameter

public CSSParameter(String id,
                    I18nizableText label,
                    I18nizableText description,
                    List<Path> cssFiles,
                    String cssProperty,
                    String defaultValue)

Constructor

Parameters:

id - the unique id

label - the label

description - the description

cssFiles - the css files

cssProperty - the css property

defaultValue - the default value

Method Detail

getType

public AbstractSkinParameter.SkinParameterType getType()

Description copied from class: AbstractSkinParameter

Get type

Specified by:

getType in class AbstractSkinParameter

Returns:

The type

getCSSFiles

public List<Path> getCSSFiles()

Get the CSS files path

Returns:

the CSS files path

addCSSFile

public void addCSSFile(Path cssFile)

Add a CSS file

Parameters:

cssFile - The CSS file

getCSSProperty

public String getCSSProperty()

Get the CSS property

Returns:

the CSS file path

apply

public void apply(Path tempDir,
                  Path modelDir,
                  Object value,
                  String lang)
           throws SkinParameterException

Description copied from class: AbstractSkinParameter

Apply parameter to the skin

Specified by:

apply in class AbstractSkinParameter

Parameters:

tempDir - the work directory

modelDir - the model directory

value - the value

lang - The language. Can be null.

Throws:

SkinParameterException

getCSSPattern

protected Pattern getCSSPattern()

Get the CSS pattern

Returns:

The CSS pattern

cssFileToString

protected String cssFileToString(Path cssFile)
                          throws SkinParameterException

Get the css file input stream as String

Parameters:

cssFile - The css file

Returns:

The css file content as String

Throws:

SkinParameterException - if the css file was not parsable

toSAX

public void toSAX(ContentHandler contentHandler,
                  String modelName)
           throws SAXException

Description copied from class: AbstractSkinParameter

SAX the parameter

Specified by:

toSAX in class AbstractSkinParameter

Parameters:

contentHandler - The content handler to SAX into

modelName - The model name

Throws:

SAXException - if an error occurred while SAXing

toJson

public Map<String,Object> toJson(String modelName)

Description copied from class: AbstractSkinParameter

Transform the parameter into a JSON object

Specified by:

toJson in class AbstractSkinParameter

Parameters:

modelName - The model name

Returns:

The JSON representation of the parameter

getDefaultValue

public String getDefaultValue(SkinModel model)

Description copied from class: AbstractSkinParameter

Get the default value

Specified by:

getDefaultValue in class AbstractSkinParameter

Parameters:

model - The model

Returns:

The default value

getDefaultValue

public String getDefaultValue(SkinModel model,
                              String lang)

Description copied from class: AbstractSkinParameter

Get the default value

Specified by:

getDefaultValue in class AbstractSkinParameter

Parameters:

model - The model

lang - The language

Returns:

The default value