Package org.ametys.core.ui.widgets

Class StaticClientSideWidget

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.widgets.StaticClientSideWidget

All Implemented Interfaces:

ClientSideElement, ClientSideWidget, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

SearchServiceClientSideWidget, SkinClientSideWidget

public class StaticClientSideWidget
extends StaticClientSideElement
implements ClientSideWidget

This implementation creates a widget from a static configuration. Classes should have the parameters defined as constants in their class.

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAMETER_FTYPES	The parameter in the configuration for ftype.
static final String	PARAMETER_SUPPORTS_ENUMERATED	The parameter in the configuration for supporting enumarated.
static final String	PARAMETER_SUPPORTS_MULTIPLE	The parameter in the configuration for supporting multiple.
static final String	PARAMETER_SUPPORTS_NONENUMERATED	The parameter in the configuration for supporting non-enumarated.
static final String	PARAMETER_SUPPORTS_NONMULTIPLE	The parameter in the configuration for supporting non-multiple.

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
StaticClientSideWidget()

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 class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, service, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

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

getDependencies, getId, getPluginName, getRights, getScripts, getScripts

Field Details

PARAMETER_FTYPES

public static final String PARAMETER_FTYPES

The parameter in the configuration for ftype. Comma-separated list. Defaut value is 'string'.

See Also:

• Constant Field Values

PARAMETER_SUPPORTS_ENUMERATED

public static final String PARAMETER_SUPPORTS_ENUMERATED

The parameter in the configuration for supporting enumarated. Default value is false.

See Also:

• Constant Field Values

PARAMETER_SUPPORTS_NONENUMERATED

public static final String PARAMETER_SUPPORTS_NONENUMERATED

The parameter in the configuration for supporting non-enumarated. Default value is true.

See Also:

• Constant Field Values

PARAMETER_SUPPORTS_MULTIPLE

public static final String PARAMETER_SUPPORTS_MULTIPLE

The parameter in the configuration for supporting multiple. Default value is false.

See Also:

• Constant Field Values

PARAMETER_SUPPORTS_NONMULTIPLE

public static final String PARAMETER_SUPPORTS_NONMULTIPLE

The parameter in the configuration for supporting non-multiple. Default value is true.

See Also:

• Constant Field Values

Constructor Details

StaticClientSideWidget

public StaticClientSideWidget()

Method Details

getFormTypes

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

Description copied from interface: ClientSideWidget

Returns the supported types

Specified by:

getFormTypes in interface ClientSideWidget

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

An non null and non empty list of supported types

supportsEnumerated

public boolean supportsEnumerated(Map<String,Object> contextParameters)

Description copied from interface: ClientSideWidget

Determine if the widget can handle enumerated values

Specified by:

supportsEnumerated in interface ClientSideWidget

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does

supportsNonEnumerated

public boolean supportsNonEnumerated(Map<String,Object> contextParameters)

Description copied from interface: ClientSideWidget

Determine if the widget can handle non-enumerated values

Specified by:

supportsNonEnumerated in interface ClientSideWidget

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does

supportsMultiple

public boolean supportsMultiple(Map<String,Object> contextParameters)

Description copied from interface: ClientSideWidget

Determine if the widget can handle multiple values

Specified by:

supportsMultiple in interface ClientSideWidget

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does

supportsNonMultiple

public boolean supportsNonMultiple(Map<String,Object> contextParameters)

Description copied from interface: ClientSideWidget

Determine if the widget can handle non-multiple values

Specified by:

supportsNonMultiple in interface ClientSideWidget

Parameters:

contextParameters - Contextuals parameters transmitted by the environment.

Returns:

true if it does