Package de.espirit.firstspirit.webedit.plugin.inlineedit

Interface ExecutableInlineEditItem

All Superinterfaces:
ExecutablePluginItem<InlineEditContext>, InlineEditItem, Item<InlineEditContext>, WebeditExecutablePluginItem<InlineEditContext>
public interface ExecutableInlineEditItem extends InlineEditItem, WebeditExecutablePluginItem<InlineEditContext>
Item for inline editing providing an executable operation.
Since:
5.0.103

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(@NotNull InlineEditContext context)
    Executes an operation associated with this item, taking into consideration the given context.
    @Nullable String
    getIconPath(@NotNull InlineEditContext context)
    Returns a URL for the button item's icon graphic that will be shown in the WebClient.
    @NotNull String
    getLabel(@NotNull InlineEditContext context)
    Provides a label for this item.

    Methods inherited from interface de.espirit.firstspirit.webedit.plugin.inlineedit.InlineEditItem

    isEnabled, isVisible

  • Method Details

    • getLabel

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

    • getIconPath

      @Nullable @Nullable String getIconPath(@NotNull @NotNull InlineEditContext 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 WebeditExecutablePluginItem<InlineEditContext>
      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 InlineEditContext context)
      Executes an operation associated with this item, taking into consideration the given context.
      Specified by:
      execute in interface ExecutablePluginItem<InlineEditContext>
      Parameters:
      context - The item's operational context.
      Since:
      5.0.103