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

Interface InlineEditItem

All Superinterfaces:
Item<InlineEditContext>
All Known Subinterfaces:
ClientScriptProvidingInlineEditItem, ExecutableInlineEditItem
public interface InlineEditItem extends Item<InlineEditContext>
Definition of an item targeting inline editing.

Keep in mind that this item may be requested in various contexts, like a basic IDProvider or one of its nested editors. You may use the provided contextual information of InlineEditContext to include or exclude certain contexts in your implementation of isVisible(InlineEditContext).

Since:
5.0.103

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isEnabled(@NotNull InlineEditContext context)
    Indicates, whether this item is enabled with respect to the given context.
    boolean
    isVisible(@NotNull InlineEditContext context)
    Indicates the visibility of this item with respect to the given context.

  • Method Details

    • isVisible

      boolean isVisible(@NotNull @NotNull InlineEditContext context)
      Indicates the visibility of this item with respect to the given context.

      If you want this item to only appear on top level IDProvider elements instead of its nested content, you may use context.getEditorNode() == null and !context.isMeta()

      Specified by:
      isVisible in interface Item<InlineEditContext>
      Parameters:
      context - The context to be considered for deciding upon visibility.
      Returns:
      true, if visible, false, else.
      Since:
      5.0.103

    • isEnabled

      boolean isEnabled(@NotNull @NotNull InlineEditContext context)
      Indicates, whether this item is enabled with respect to the given context.
      Specified by:
      isEnabled in interface Item<InlineEditContext>
      Parameters:
      context - The context to be considered for deciding upon the item being enabled.
      Returns:
      true, if enabled, false, else.
      Since:
      5.0.103