Package de.espirit.firstspirit.access.store.templatestore

Interface FormatTemplate

All Superinterfaces:
ChannelSourceProvider, Comparable<StoreElement>, HistoryProvider, IDProvider, PackagePoolItem, StoreElement, TemplateContentProvider, TemplateStoreElement, Workflowable
public interface FormatTemplate extends IDProvider, TemplateContentProvider, PackagePoolItem, TemplateStoreElement
Definition of a template specialized for formatting tasks.
Since:
3.0

  • Field Details

    • UID_TYPE

      static final IDProvider.UidType UID_TYPE
      The template's uid type.
      Since:
      4.0.19

  • Method Details

    • getStyleNode

      Style getStyleNode()
      Get the StyleNode (properties-node) of the FormatTemplate as StoreElement
      Returns:
      StyleNode as StoreElement-object
      Since:
      3.0

    • isSystem

      boolean isSystem()
      Indicates this to be a system format.
      Returns:
      true, if it is a system format.
      Since:
      3.0

    • setSystem

      void setSystem(boolean system)
      Defines this to be a system format.
      Parameters:
      system - true, for a system format.
      Since:
      3.0

    • getFormatTag

      String getFormatTag()
      Provides this format's tag.
      Returns:
      The format's tag.
      Since:
      3.0

    • setFormatTag

      void setFormatTag(String tag)
      Defines this format's tag.
      Parameters:
      tag - The format's tag.
      Since:
      3.0

    • getView

      String getView()
      Provides the view mode for this format.
      Returns:
      The view mode.
      Since:
      3.0

    • setView

      void setView(String view)
      Sets the view mode for this format.
      Parameters:
      view - The view mode.
      Since:
      3.0

    • isQuote

      boolean isQuote()
      Indicates whether to quote the format.
      Returns:
      true, if to be quoted.
      Since:
      3.0

    • setQuote

      void setQuote(boolean value)
      Defines whether to quote the format.
      Parameters:
      value - true, if to quote.
      Since:
      3.0

    • isCdata

      boolean isCdata()
      Indicates the format to represent CDATA.
      Returns:
      true, if it is CDATA
      Since:
      3.0

    • setCdata

      void setCdata(boolean value)
      Defines the format to represent CDATA.
      Parameters:
      value - true, if it is CDATA.
      Since:
      3.0

    • isVisible

      boolean isVisible()
      Indicates whether the format will be visible.
      Returns:
      true, if visible.
      Since:
      3.0

    • setVisible

      void setVisible(boolean visible)
      Defines whether the format shall be visible.
      Parameters:
      visible - true, for visibility.
      Since:
      3.0

    • getStyleAttributes

      Map<String,String> getStyleAttributes()
      Provides the map of style attributes.
      Returns:
      The style attributes.
      Since:
      3.0

    • setStyleAttributes

      void setStyleAttributes(Map<String,String> attributes)
      Defines the style attributes.
      Parameters:
      attributes - The style attributes.
      Since:
      3.0

    • getChannel

      FormatTemplateChannel getChannel(@NotNull @NotNull TemplateSet templateSet)
      Provides the channel specifica with respect to the given template set.
      Parameters:
      templateSet - The template set.
      Returns:
      The specifica for the requested channel.
      Since:
      3.0
      See Also:

    • setUid

      void setUid(@NotNull @NotNull String value)
      The uid of format templates is used as tag name in dom and dom-table instances. The provided uid should contain only lower case characters.
      If the uid is changed and the tag name is still in use this will lead to rendering errors. Setting the uid will also change the attribute tag of the style node.
      Specified by:
      setUid in interface IDProvider
      Parameters:
      value - new unique identifier; should contain only lower case characters - internally this value is transformed to lower case
      Since:
      4.0
      See Also: