Package org.ametys.core.ui

Interface ClientSideElement

All Known Subinterfaces:
ClientSideRelation, ClientSideWidget, RightAssignmentContext, TargetToContextConvertor
All Known Implementing Classes:
AbstractAmetysObjectThreadClientSideElement, AbstractContentClientSideElement, AbstractExportClientSideElement, AbstractFormEntriesWorkflowStepsClientSideElement, AbstractPageClientSideElement, AbstractPageMenu, AbstractSitemapElementClientSideElement, AbstractStaticODFTreeIndicator, AbstractStaticRightAssignmentContext, ACLAmetysObjectRightAssignmentContext, AddContentToCurrentSelectionClientSideElement, AddOrgUnitToCurrentClientSideElement, AddPilotageContentToCurrentSelectionClientSideElement, AddReportTaskClientSideElement, AddTaskClientSideElement, AdminWelcomeClientSideElement, AmetysObjectTargetToContextConvertor, ApogeeExportClientSideElement, ApogeeGlobalSynchronizationClientSideElement, ArchiveContentClientSideElement, ArchivedLogClientSideElement, AutomaticNewsletterClientSideElement, CacheClientSideElement, CartProfileAssignmentsToolClientSideElement, CartRightAssignmentContext, CategoriesToolClientSideElement, ChooseHierarchicalContentFileImportsClientSideElement, CommentClientSideElement, CompareContentVersionClientSideElement, CompareContentVersionToolClientSideElement, CompareContentWithLiveVersionClientSideElement, CompareOldContentWithCurrentVersionClientSideElement, ConfigClientSideElement, ConfigureServiceClientSideElement, ConfigureViewParametersClientSideElement, ContentAlertsClientSideElement, ContentConsistencyTestClientSideElement, ContentPrivacyMenu, ContentRightAssignmentContext, ContentThreadClientSideElement, ContentTypeEditorToolElement, ContentTypeRightAssignmentContext, ContentTypesGallery, ContentTypesGallery, ContentTypesMenuItem, CopyODFContentClientSideElement, CopyODFPilotageContentClientSideElement, CostModelingButtonClientSideElement, CostModelingClientSideElement, CourseListTypeIndicator, CoursePartClientSideElement, CourseStepHolderIndicator, DefaultFormEntryWorkflowStepsClientSideElement, DeleteContentClientSideElement, DeleteContentClientSideElement, DeleteContentClientSideElement, DeleteDataSourceClientSideElement, DeleteExtractionResultFilesClientSideElement, DeleteODFPilotageContentClientSideElement, DeleteOrgUnitClientSideElement, DeletePageClientSideElement, DeleteUserClientSideElement, DesignsMenu, DevModeClientSideElement, DevModeMenuItemClientSideElement, EditContentTypeClientSideElement, EditExtractionClientSideElement, EditorStyleMenu, ExecuteExtractionClientSideElement, ExplainUserRightButton, ExplainUserRightTool, ExportClientSiteElement, ExportSimpleMenu, ExtractionDetailsToolElement, ExtractionProfileAssignmentsToolClientSideElement, ExtractionRightAssignmentContext, ExtractionTargetToContextConvertor, FoldersClientSideElement, FormEditionModeMenu, FormEntriesWorkflowStepsClientSideElement, FormEntryWorkflowStepsClientSideElement, FormQuestionButtonMenu, FormsContentClientSideElement, FormsDirectoryRightAssignmentContext, FormsProfileAssignmentsToolClientSideElement, FormWorkflowButtonMenu, FormWorkflowClientSideElement, GlobalSynchronizationClientSideElement, HierarchicalReferenceTableClientSideElement, HTMLExpertEditClientSideElement, ImagesContainerClientSideElement, ImportArchiveClientSideElement, ImportModelClientSideElement, ImportSkinClientSideElement, InvitationsClientSideElement, LanguageMenu, LanguageMenu, LinkDirectoryRightAssignmentContext, LivePageClientSideElement, LockedContentClientSideElement, LogsClientSideElement, MaintenanceClientSideElement, MaintenanceTaskClientSideElement, MaintenanceTaskClientSideElement, MCCWorkflowClientSideElement, MigrationsActionsClientSideElement, MigrationsStatusClientSideElement, MixinContentTypesGallery, ModelsMenu, MultifactorAuthenticationClientSideElement, NotPublishableIndicator, ODFPilotageSimpleMenuClientSideElement, ODFRightAssignmentContext, ODFRootClientSideElement, ODFSelectionAwareAddReportTaskClientSideElement, ODFThematicCreationClientSideElement, ODFTreeToolClientSideElement, OpenSkinEditorClientSideElement, OpenSkinFactoryClientSideElement, OpenTreeControllerClientSideElement, PageRightAssignmentContext, PageRobotsClientSideElement, ParametersClientSideElement, ParaStyleClientSideElement, PegaseExportClientSideElement, PegaseGlobalSynchronizationClientSideElement, PegaseSCCClientSideElement, PegaseSCCSmartContentClientSideElement, PilotageClientSideElement, PilotageSmartContentClientSideElement, PilotageStatusButtonClientSideElement, PlantUMLClientSideElement, ProfileAssignmentsToolClientSideElement, ProfileToolsClientSideElement, ProgramItemCodeIndicator, ProgramMCCWorkflowClientSideElement, ProjectSuperUserClientSideElement, QueriesDirectoryRightAssignmentContext, QueriesProfileAssignmentsToolClientSideElement, QueryTargetToContextConvertor, RedirectPageClientSideElement, ReferenceTableRightAssignmentContext, ReferenceTablesGallery, RemoveContentTypeClientSideElement, ReportsClientSideElement, RepublishContentClientSideElement, ResourceRightAssignmentContext, RichTextConfigurationFileImportsClientSideElement, RNCPAbstractProgramClientSideElement, RNCPSubProgramClientSideElement, RulesSmartContentClientSideElement, RulesStaticClientSideElement, SaveContentTypeClientSideElement, SCCClientSideElement, SCCSmartContentClientSideElement, ScheduleArchivingClientSideElement, ScheduledPageClientSideElement, ScheduledSurveyClientSideElement, SearchClientSideElement, SearchReferencingContentsWithSameValuesClientSideElement, SearchServiceClientSideWidget, SelectionAwareAddTaskClientSideElement, ServerLogMessageTargetFactoryElement, ServiceMenu, SessionClientSideElement, SetContentAttributeClientSideElement, SetContentAttributeClientSideElement, SetContentViewMenu, SetOrganisationChartRootClientSideElement, SetParentContentClientSideElement, SetUGCRootClientSideElement, SetUserDirectoryRootClientSideElement, ShareableCourseClientSideElement, ShareableCourseContentClientSideElement, ShareableCourseMenuItemClientSideElement, ShareableCourseStatusButtonClientSideElement, SharedCoursePartIndicator, ShareStatusIndicator, SignupInvitationClientSideElement, SimpleMenu, SimpleSearchClientSideElement, SiteSelectionAwareAddTaskClientSideElement, SkinClientSideWidget, SkinLanguageMenu, SmartContentClientSideElement, SmartContentMenu, SpecificRulesClientSideElement, StaticClientSideElement, StaticClientSideRelation, StaticClientSideWidget, StaticFileImportsClientSideElement, StaticMenu, StaticRichTextConfiguration.StaticRichTextConfigurationClientSideElement, StringRightAssignmentContext, StringTargetToContextConvertor, SubscribersClientSideElement, SuperUserClientSideElement, SuperUserClientSideElement, SurveyClientSideElement, SurveyRightAssignmentContext, SynchronizeContentRightAssignmentContext, SystemAnnouncementClientSideElement, TagsHelperClientSideElement, TagsToolClientSideElement, TagsToolClientSideElement, TemplatesMenu, TemplatesMenu, ThemeColorsMenu, ThesaurusGallery, TranslationFlaggingClientSideElement, TreeToolClientSideElement, UGCContentModerationClientSideElement, UserDirectoryRightAssignmentContext, UserManagmentClientSideElement, UserPermissionsToolClientSideElement, ValidateSurveyClientSideElement, WallContentReportsClientSideElement, WebContentTypeRightAssignmentContext, WebReferenceTableRightAssignmentContext, WebStringRightAssignmentContext, WelcomeButtonClientSideElement, WelcomeToolClientSideElement, WorkflowStepIndicator, WorkflowStepsClientSideElement, WorkflowToolClientSideElement
public interface ClientSideElement
Object binding of a client side element, ie something that is loaded and executed by the browser.
Such elements may be UI controls (buttons, menu, tools, ...) but also only JS or CSS files.

This interface only covers files to be loaded, but its implementations are also meant to hold associated business-logic, if any.
To implement such logic, implementing classes should write any method, annotated with Callable, that will be directly called by the kernel upon execution of the JavaScript method serverCall('methodeName', params).

All Map<String, Object> instances found in this class and its implementations are directly converted from and to JSON to interact with browser-site JavaScript.

  • Method Details

    • getId

      String getId()
      Get the id of the element.
      Returns:
      the id. Can not be null.

    • getScripts

      List<ClientSideElement.Script> getScripts(Map<String,Object> contextParameters)
      This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.
      Parameters:
      contextParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The list of scripts or an empty list.

    • getScripts

      List<ClientSideElement.Script> getScripts(boolean ignoreRights, Map<String,Object> contextParameters)
      This method return the scripts that will be used on client side. This class will be parametrized by initial and current parameters.
      Parameters:
      ignoreRights - True to ignore the rights verification.
      contextParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The list of scripts or an empty list.

    • getRights

      Map<String,String> getRights(Map<String,Object> contextParameters)
      This method return the right that will be needed on client side. This class will be parametrized by initial and current parameters.
      Parameters:
      contextParameters - Contextuals parameters transmitted by the environment.
      Returns:
      The rights in a Map of (rightId, context). Can be empty.

    • getPluginName

      String getPluginName()
      Get the plugin name where the control was declared
      Returns:
      The plugin name. Can not be null.

    • getDependencies

      Map<String,List<String>> getDependencies()
      This method returns the list of dependencies, sorted by extension point.
      Returns:
      a map of dependencies ids by extension point.