Package org.ametys.skinfactory.parameters

Class AbstractSkinParameter

java.lang.Object

org.ametys.skinfactory.parameters.AbstractSkinParameter

Direct Known Subclasses:

CSSParameter, I18nizableTextParameter, ImageParameter, TextParameter, VariantParameter

public abstract class AbstractSkinParameter
extends Object

Class representing a parameter of a skin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSkinParameter.SkinParameterType	Enumeration of supported types
class	AbstractSkinParameter.Widget	Widget class

Field Summary

Fields

Modifier and Type	Field	Description
(package private) I18nizableText	_description
(package private) String	_id
(package private) I18nizableText	_label

Constructor Summary

Constructors

Constructor	Description
AbstractSkinParameter(String id, I18nizableText label, I18nizableText description)	Constructor

Method Summary

Modifier and Type	Method	Description
abstract void	apply(Path tempDir, Path modelDir, Object value, String lang)	Apply parameter to the skin
abstract Object	getDefaultValue(SkinModel model)	Get the default value
abstract Object	getDefaultValue(SkinModel model, String lang)	Get the default value
I18nizableText	getDescription()	Get the description
String	getId()	Get the unique id
I18nizableText	getLabel()	Get the label
abstract AbstractSkinParameter.SkinParameterType	getType()	Get type
void	setDescription(I18nizableText description)	Set the description
void	setLabel(I18nizableText label)	Set the label
abstract Map<String,Object>	toJson(String modelName)	Transform the parameter into a JSON object
abstract void	toSAX(ContentHandler contentHandler, String modelName)	SAX the parameter

Methods inherited from class java.lang.Object

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

Field Detail

_id

String _id

_label

I18nizableText _label

_description

I18nizableText _description

Constructor Detail

AbstractSkinParameter

public AbstractSkinParameter(String id,
                             I18nizableText label,
                             I18nizableText description)

Constructor

Parameters:

id - the unique id

label - the label

description - the description

Method Detail

getId

public String getId()

Get the unique id

Returns:

the unique id

getLabel

public I18nizableText getLabel()

Get the label

Returns:

the label

setLabel

public void setLabel(I18nizableText label)

Set the label

Parameters:

label - the label to set

getDescription

public I18nizableText getDescription()

Get the description

Returns:

the description

setDescription

public void setDescription(I18nizableText description)

Set the description

Parameters:

description - the description to set

getType

public abstract AbstractSkinParameter.SkinParameterType getType()

Get type

Returns:

The type

apply

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

Apply parameter to the skin

Parameters:

tempDir - the work directory

modelDir - the model directory

value - the value

lang - The language. Can be null.

toSAX

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

SAX the parameter

Parameters:

contentHandler - The content handler to SAX into

modelName - The model name

Throws:

SAXException - if an error occurred while SAXing

toJson

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

Transform the parameter into a JSON object

Parameters:

modelName - The model name

Returns:

The JSON representation of the parameter

getDefaultValue

public abstract Object getDefaultValue(SkinModel model)

Get the default value

Parameters:

model - The model

Returns:

The default value

getDefaultValue

public abstract Object getDefaultValue(SkinModel model,
                                       String lang)

Get the default value

Parameters:

model - The model

lang - The language

Returns:

The default value