Package de.espirit.firstspirit.webedit.plugin.toolbar

Interface ClientScriptProvidingToolbarActionsItem

All Superinterfaces:
ClientScriptProvidingItem<ToolbarContext>, Item<ToolbarContext>, WebeditToolbarItem
public interface ClientScriptProvidingToolbarActionsItem extends WebeditToolbarItem, ClientScriptProvidingItem<ToolbarContext>
Item providing a native script for client-side execution in the context of toolbar actions.
Since:
5.0.103

  • Method Details

    • getIconPath

      String getIconPath(@NotNull @NotNull ToolbarContext context)
      Returns a URL for the button item's icon graphic that will be shown in the WebClient. The URL may be relative to the WebClient web application's root directory or absolute.
      Specified by:
      getIconPath in interface ClientScriptProvidingItem<ToolbarContext>
      Parameters:
      context - The item's operational context.
      Returns:
      A resource path to the icon file or null if the item has no icon (in this case, a default icon may be displayed).
      Since:
      5.0.103

    • getLabel

      @NotNull @NotNull String getLabel(@NotNull @NotNull ToolbarContext context)
      Provides a label for this item wrt. the given context.
      Specified by:
      getLabel in interface ClientScriptProvidingItem<ToolbarContext>
      Parameters:
      context - The item's operational context.
      Returns:
      The item label.
      Since:
      5.0.103

    • getScript

      String getScript(ToolbarContext context)
      Returns client script code that will be executed within the WebClient interface.
      Specified by:
      getScript in interface ClientScriptProvidingItem<ToolbarContext>
      Parameters:
      context - The item's operational context.
      Returns:
      Native client script code or null.
      Since:
      5.0.103