Package org.ametys.skinfactory.parameters

Class TextParameter

java.lang.Object

org.ametys.skinfactory.parameters.AbstractSkinParameter

org.ametys.skinfactory.parameters.TextParameter

public class TextParameter
extends AbstractSkinParameter

Implementation of AbstractSkinParameter for a i18niable text

Nested Class Summary

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

AbstractSkinParameter.SkinParameterType, AbstractSkinParameter.Widget

Constructor Summary

Constructors

Constructor	Description
TextParameter(String id, I18nizableText label, I18nizableText description, Path xslFile, String defaultValue)	Constructor

Method Summary

Modifier and Type	Method	Description
void	apply(Path tempDir, Path modelDir, Object value, String lang)	Apply parameter to the skin
String	getDefaultValue(SkinModel model)	Get the default value
String	getDefaultValue(SkinModel model, String lang)	Get the default value
Path	getPath()	Get the CSS file path
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 Details

TextParameter

public TextParameter(String id,
 I18nizableText label,
 I18nizableText description,
 Path xslFile,
 String defaultValue)

Constructor

Parameters:

id - the unique id

label - the label

description - the description

xslFile - the XSL file

defaultValue - the default value in the default language

Method Details

getPath

public Path getPath()

Get the CSS file path

Returns:

the CSS file path

getType

public AbstractSkinParameter.SkinParameterType getType()

Description copied from class: AbstractSkinParameter

Get type

Specified by:

getType in class AbstractSkinParameter

Returns:

The type

apply

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

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.

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