org.ametys.web.site

Class SiteParameter

java.lang.Object

org.ametys.runtime.parameter.Parameter<ParameterHelper.ParameterType>

org.ametys.web.site.SiteParameter

public class SiteParameter
extends Parameter<ParameterHelper.ParameterType>

Definition of a Site parameter.

Field Summary

Fields

Modifier and Type	Field and Description
protected I18nizableText	_displayCategory The display category.
protected I18nizableText	_displayGroup The display group.
protected Set<String>	_siteTypes The list of site types to which this parameter belongs, or null for no restriction.

Constructor Summary

Constructors

Constructor and Description
SiteParameter()

Method Summary

Modifier and Type	Method and Description
I18nizableText	getDisplayCategory() Get the display category.
I18nizableText	getDisplayGroup() Get the display group.
Set<String>	getSiteTypes() Get the site type restriction, null for no restriction.
boolean	isInSiteType(String siteType) Test if the parameter is to appear in the specified site type.
void	setDisplayCategory(I18nizableText displayCategory) Set the parameter display category.
void	setDisplayGroup(I18nizableText displayGroup) Set the parameter display group.
void	setSiteTypes(Set<String> siteTypes) Set the site type restriction, null for no restriction.
String	toString()

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

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

Field Detail

_displayCategory

protected I18nizableText _displayCategory

The display category.

_displayGroup

protected I18nizableText _displayGroup

The display group.

_siteTypes

protected Set<String> _siteTypes

The list of site types to which this parameter belongs, or null for no restriction.

Constructor Detail

SiteParameter

public SiteParameter()

Method Detail

getDisplayCategory

public I18nizableText getDisplayCategory()

Get the display category.

Returns:

the display category.

setDisplayCategory

public void setDisplayCategory(I18nizableText displayCategory)

Set the parameter display category.

Parameters:

displayCategory - the display category to set.

getDisplayGroup

public I18nizableText getDisplayGroup()

Get the display group.

Returns:

the display group.

setDisplayGroup

public void setDisplayGroup(I18nizableText displayGroup)

Set the parameter display group.

Parameters:

displayGroup - the display group to set.

getSiteTypes

public Set<String> getSiteTypes()

Get the site type restriction, null for no restriction.

Returns:

the site types or null for no restriction.

setSiteTypes

public void setSiteTypes(Set<String> siteTypes)

Set the site type restriction, null for no restriction.

Parameters:

siteTypes - the site types to set.

isInSiteType

public boolean isInSiteType(String siteType)

Test if the parameter is to appear in the specified site type.

Parameters:

siteType - the site type name (i.e. 'default', 'blog'...)

Returns:

true to appear, false otherwise.

toString

public String toString()

Overrides:

toString in class Object