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

Interface ExecutableToolbarActionsItem

All Superinterfaces:
ExecutablePluginItem<ToolbarContext>, Item<ToolbarContext>, WebeditExecutablePluginItem<ToolbarContext>, WebeditToolbarItem
public interface ExecutableToolbarActionsItem extends WebeditToolbarItem, WebeditExecutablePluginItem<ToolbarContext>
Toolbar menu item providing an executable operation.
Since:
5.0.103

  • Method Details

    • getLabel

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

    • getIconPath

      @Nullable @Nullable String getIconPath(@NotNull @NotNull ToolbarContext context)
      Returns a URL for an icon graphic associated with this item. The URL may be relative to the WebClient web application's root directory or absolute.
      Specified by:
      getIconPath in interface WebeditExecutablePluginItem<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

    • execute

      void execute(@NotNull @NotNull ToolbarContext context)
      Executes an operation associated with this item, taking into consideration the given context.
      Specified by:
      execute in interface ExecutablePluginItem<ToolbarContext>
      Parameters:
      context - The item's operational context.
      Since:
      5.0.103