Package org.ametys.core.ui

Class StaticClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

AbstractCompareContentVersionClientSideElement, AbstractContentClientSideElement, AbstractPageClientSideElement, AbstractStaticRightAssignmentContext, AddContentToCurrentSelectionClientSideElement, AddTaskClientSideElement, AdminWelcomeClientSideElement, ApogeeClientSideElement, ArchivedLogClientSideElement, AutomaticNewsletterClientSideElement, CacheClientSideElement, CommentClientSideElement, CompareContentVersionToolClientSideElement, ConfigClientSideElement, ContentAlertsClientSideElement, ContentConsistencyTestClientSideElement, ContentTypeEditorToolElement, DeleteDataSourceClientSideElement, DeleteExtractionResultFilesClientSideElement, DevModeMenuItemClientSideElement, EditContentTypeClientSideElement, EditExtractionClientSideElement, ExecuteExtractionClientSideElement, ExtractionDetailsToolElement, FoldersClientSideElement, FormWorkflowClientSideElement, HierarchicalReferenceTableClientSideElement, HTMLExpertEditClientSideElement, ImagesContainerClientSideElement, ImportArchiveClientSideElement, InvitationsClientSideElement, LogsClientSideElement, MaintenanceTaskClientSideElement, ODFRootClientSideElement, OpenSkinEditorClientSideElement, OpenSkinFactoryClientSideElement, OpenTreeControllerClientSideElement, ParametersClientSideElement, ParaStyleClientSideElement, PilotageClientSideElement, PlantUMLClientSideElement, ProfileAssignmentsToolClientSideElement, ProfileToolsClientSideElement, RedirectPageClientSideElement, RemoveContentTypeClientSideElement, ReportsClientSideElement, RepublishContentClientSideElement, RNCPAbstractProgramClientSideElement, SaveContentTypeClientSideElement, SCCClientSideElement, ScheduleArchivingClientSideElement, ScheduledSurveyClientSideElement, SearchClientSideElement, SearchReferencingContentsWithSameValuesClientSideElement, ServerLogMessageTargetFactoryElement, SessionClientSideElement, ShareableCourseClientSideElement, SimpleMenu, SimpleSearchClientSideElement, SmartContentClientSideElement, StaticClientSideRelation, StaticClientSideWidget, StaticMenu, SubscribersClientSideElement, SuperUserClientSideElement, SurveyClientSideElement, SystemAnnouncementClientSideElement, TranslationFlaggingClientSideElement, TreeToolClientSideElement, UGCContentModerationClientSideElement, ValidateSurveyClientSideElement, WallContentReportsClientSideElement, WelcomeButtonClientSideElement, WelcomeToolClientSideElement

public class StaticClientSideElement
extends StaticFileImportsClientSideElement

This implementation creates an element from a static configuration

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
StaticClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected String	_configureClass(Configuration configuration)	Configure the js class name
protected Map<String,Object>	_configureParameters(Configuration configuration)	Configure parameters recursively
protected ClientSideElement.Script	_configureScript(Configuration configuration)	Configure the script
protected Map<String,Object>	configureInitialParameters(Configuration configuration)	Configure the initial parameters

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

Constructor Details

StaticClientSideElement

public StaticClientSideElement()

Method Details

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the script

Overrides:

_configureScript in class StaticFileImportsClientSideElement

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - The configuration is incorrect

_configureClass

protected String _configureClass(Configuration configuration)
                          throws ConfigurationException

Configure the js class name

Parameters:

configuration - The configuration on action tag

Returns:

The js class name

Throws:

ConfigurationException - If an error occurs

configureInitialParameters

protected Map<String,Object> configureInitialParameters(Configuration configuration)
                                                 throws ConfigurationException

Configure the initial parameters

Parameters:

configuration - the global configuration

Returns:

The initial parameters read

Throws:

ConfigurationException - The configuration is incorrect

_configureParameters

protected Map<String,Object> _configureParameters(Configuration configuration)
                                           throws ConfigurationException

Configure parameters recursively

Parameters:

configuration - the parameters configuration

Returns:

parameters in a Map

Throws:

ConfigurationException - The configuration is incorrect