ClientScriptProvidingMediaManagementItem (FirstSpirit Developer-API)

All Superinterfaces:: ClientScriptProvidingItem<MediaManagementContext>, Item<MediaManagementContext>, MediaManagementItem

public interface ClientScriptProvidingMediaManagementItem extends MediaManagementItem, ClientScriptProvidingItem<MediaManagementContext>

Definition of an item targeting media managing providing a native script for client-side execution.

Since:: 5.2.33

Method Summary

Modifier and Type

Method

Description

String

getScript(MediaManagementContext context)

Returns script code, that will be executed on client-side.

boolean

isEnabled(MediaManagementContext context)

Indicates the visibility of this item wrt. the given context.

boolean

isVisible(MediaManagementContext context)

Indicates, whether this item is enabled wrt. the given context.

Methods inherited from interface de.espirit.firstspirit.webedit.plugin.ClientScriptProvidingItem
getIconPath, getLabel

Method Details
- isEnabled
  
  boolean isEnabled(@NotNull MediaManagementContext context)
  
  Indicates the visibility of this item wrt. the given context.
  
  Specified by:
  
  isEnabled in interface Item<MediaManagementContext>
  
  Specified by:
  
  isEnabled in interface MediaManagementItem
  
  Parameters:
  
  context - The context to be considered for deciding upon visibility.
  
  Returns:
  
  true, if visible, false, else.
  
  Since:
  
  5.2.33
- isVisible
  
  boolean isVisible(@NotNull MediaManagementContext context)
  
  Indicates, whether this item is enabled wrt. the given context.
  
  Specified by:
  
  isVisible in interface Item<MediaManagementContext>
  
  Specified by:
  
  isVisible in interface MediaManagementItem
  
  Parameters:
  
  context - The context to be considered for deciding upon the item being enabled.
  
  Returns:
  
  true, if enabled, false, else.
  
  Since:
  
  5.2.33
- getScript
  
  @Nullable String getScript(@NotNull MediaManagementContext context)
  
  Returns script code, that will be executed on client-side.
  
  Specified by:
  
  getScript in interface ClientScriptProvidingItem<MediaManagementContext>
  
  Parameters:
  
  context - The plug-in context.
  
  Returns:
  
  Native client script code or null.
  
  Since:
  
  5.2.33