Package org.ametys.skinfactory.parameters

Class ImageParameter

java.lang.Object

org.ametys.skinfactory.parameters.AbstractSkinParameter

org.ametys.skinfactory.parameters.ImageParameter

public class ImageParameter
extends AbstractSkinParameter

Implementation of AbstractSkinParameter for an image

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageParameter.FileValue	Class representing a file value

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

AbstractSkinParameter.SkinParameterType, AbstractSkinParameter.Widget

Constructor Summary

Constructors

Constructor	Description
ImageParameter(String relPath, I18nizableText label, I18nizableText description)	Constructor
ImageParameter(String relPath, I18nizableText label, I18nizableText description, String iconGlyph, String iconSmall, String iconLarge)	Constructor

Method Summary

Modifier and Type	Method	Description
void	apply(Path tempDir, Path modelDir, Object value, String lang)	Apply parameter to the skin
ImageParameter.FileValue	getDefaultValue(SkinModel model)	Get the default value
ImageParameter.FileValue	getDefaultValue(SkinModel model, String lang)	Get the default value
String	getIconGlyph()	Get the CSS icon
String	getIconLarge()	Get the large icon
String	getIconSmall()	Get the small icon
String	getLibraryPath()	Get relative path of images
AbstractSkinParameter.SkinParameterType	getType()	Get type
boolean	isLocalUploadEnabled()	Determines if local upload is enabled
void	setIconGlyph(String iconGlyph)	Set the CSS icon
void	setIconLarge(String iconLarge)	Set the large icon relative path
void	setIconSmall(String iconSmall)	Set the small icon relative path
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

ImageParameter

public ImageParameter(String relPath,
                      I18nizableText label,
                      I18nizableText description)

Constructor

Parameters:

relPath - the relative path of the target image

label - the label

description - the description

ImageParameter

public ImageParameter(String relPath,
                      I18nizableText label,
                      I18nizableText description,
                      String iconGlyph,
                      String iconSmall,
                      String iconLarge)

Constructor

Parameters:

relPath - the relative path of the target image

label - the label

description - the description

iconGlyph - The CSS classe for icon, to use instead of small and large icon

iconSmall - The small icon

iconLarge - The large icon

Method Detail

getType

public AbstractSkinParameter.SkinParameterType getType()

Description copied from class: AbstractSkinParameter

Get type

Specified by:

getType in class AbstractSkinParameter

Returns:

The type

isLocalUploadEnabled

public boolean isLocalUploadEnabled()

Determines if local upload is enabled

Returns:

true if local upload is enabled

getLibraryPath

public String getLibraryPath()

Get relative path of images

Returns:

the relative path of images

setIconGlyph

public void setIconGlyph(String iconGlyph)

Set the CSS icon

Parameters:

iconGlyph - the CSS icon

getIconGlyph

public String getIconGlyph()

Get the CSS icon

Returns:

The CSS icon

setIconSmall

public void setIconSmall(String iconSmall)

Set the small icon relative path

Parameters:

iconSmall - the relative path of the small icon

getIconSmall

public String getIconSmall()

Get the small icon

Returns:

The small icon

setIconLarge

public void setIconLarge(String iconLarge)

Set the large icon relative path

Parameters:

iconLarge - the relative path of the large icon

getIconLarge

public String getIconLarge()

Get the large icon

Returns:

The large icon

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 ImageParameter.FileValue 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 ImageParameter.FileValue 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