Package org.ametys.core.ui.widgets

Interface ClientSideWidget

All Superinterfaces:

ClientSideElement

All Known Implementing Classes:

SearchServiceClientSideWidget, SkinClientSideWidget, StaticClientSideWidget

public interface ClientSideWidget
extends ClientSideElement

This class is a particular client side element that stands for widgets

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Method Summary

Modifier and Type	Method	Description
String[]	getFormTypes(Map<String,Object> contextParameters)	Returns the supported types
boolean	supportsEnumerated(Map<String,Object> contextParameters)	Determine if the widget can handle enumerated values
boolean	supportsMultiple(Map<String,Object> contextParameters)	Determine if the widget can handle multiple values
boolean	supportsNonEnumerated(Map<String,Object> contextParameters)	Determine if the widget can handle non-enumerated values
boolean	supportsNonMultiple(Map<String,Object> contextParameters)	Determine if the widget can handle non-multiple values

Methods inherited from interface org.ametys.core.ui.ClientSideElement

getDependencies, getId, getPluginName, getRights, getScripts, getScripts

Method Detail

getFormTypes

String[] getFormTypes(Map<String,Object> contextParameters)

Returns the supported types

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

An non null and non empty list of supported types

supportsEnumerated

boolean supportsEnumerated(Map<String,Object> contextParameters)

Determine if the widget can handle enumerated values

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does

supportsNonEnumerated

boolean supportsNonEnumerated(Map<String,Object> contextParameters)

Determine if the widget can handle non-enumerated values

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does

supportsMultiple

boolean supportsMultiple(Map<String,Object> contextParameters)

Determine if the widget can handle multiple values

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does

supportsNonMultiple

boolean supportsNonMultiple(Map<String,Object> contextParameters)

Determine if the widget can handle non-multiple values

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does