Package de.espirit.firstspirit.webedit.plugin.status

Interface WebeditStatusNote

@NonExtendable public interface WebeditStatusNote
Object definition for a status information in webedit. Use WebeditStatusNoteContext.createNote() for creation.
Since:
5.2.516
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable WebeditColor
    getColor()
    Returns the color associated with this status information.
    @Nullable Image<?>
    getIcon()
    Returns the icon associated with this status information.
    @NotNull Collection<? extends WebeditStatusNoteItem>
    getItems()
    Get all items eligible for display in the status note's contextual setting.
    @Nullable String
    getText()
    Returns the text of this status information.
    @NotNull String
    getTitle()
    Returns the title of this status information.
    boolean
    isVisibleOnLoad()
    Returns the initial visibility of this status information after the preview has been loaded.

  • Method Details

    • getColor

      @Nullable @Nullable WebeditColor getColor()
      Returns the color associated with this status information.
      Returns:
      The color of the status information, or null.
      Since:
      5.2.516

    • getIcon

      @Nullable @Nullable Image<?> getIcon()
      Returns the icon associated with this status information.
      Returns:
      The icon of the status information, or null.
      Since:
      5.2.516

    • getTitle

      @NotNull @NotNull String getTitle()
      Returns the title of this status information.
      Returns:
      The title of the status information.
      Since:
      5.2.516

    • getText

      @Nullable @Nullable String getText()
      Returns the text of this status information.
      Returns:
      The text of the status information, or null.
      Since:
      5.2.516

    • isVisibleOnLoad

      boolean isVisibleOnLoad()
      Returns the initial visibility of this status information after the preview has been loaded.
      Returns:
      The initial visibility of the status information.
      Since:
      5.2.516

    • getItems

      @NotNull @NotNull Collection<? extends WebeditStatusNoteItem> getItems()
      Get all items eligible for display in the status note's contextual setting.
      Returns:
      A collection of items.
      Since:
      5.2.516