Interface PdfTemplate

  • All Superinterfaces:
    java.lang.Cloneable, net.anotheria.asg.data.DataObject, net.anotheria.util.sorter.IComparable
    All Known Implementing Classes:
    PdfTemplateDocument

    public interface PdfTemplate
    extends net.anotheria.asg.data.DataObject, net.anotheria.util.sorter.IComparable
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROP_APPLY_BACKGROUND_STYLES
      Constant property name for "applyBackgroundStyles" for internal storage and queries.
      static java.lang.String PROP_CONTENT_TEMPLATE_EN
      Constant property name for "contentTemplate" and domain "EN" for internal storage and queries.
      static java.lang.String PROP_FOOTER_MARGIN
      Constant property name for "footerMargin" for internal storage and queries.
      static java.lang.String PROP_FOOTER_TEMPLATE_EN
      Constant property name for "footerTemplate" and domain "EN" for internal storage and queries.
      static java.lang.String PROP_HEADER_MARGIN
      Constant property name for "headerMargin" for internal storage and queries.
      static java.lang.String PROP_HEADER_TEMPLATE_EN
      Constant property name for "headerTemplate" and domain "EN" for internal storage and queries.
      static java.lang.String PROP_ID
      Constant property name for "id" for internal storage and queries.
      static java.lang.String PROP_LOCALIZATIONS
      Constant property name for "localizations" for internal storage and queries.
      static java.lang.String PROP_NAME
      Constant property name for "name" for internal storage and queries.
      static java.lang.String PROP_SHOW_PAGE_NUMBERS
      Constant property name for "showPageNumbers" for internal storage and queries.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addLocalizationsElement​(java.lang.String guard)
      Adds a new element to the list.
      void copyLANG2LANG​(java.lang.String sourceLanguge, java.lang.String destLanguage)
      Copies all multilingual properties from source language to destination language
      boolean getApplyBackgroundStyles()
      Returns the value of the applyBackgroundStyles attribute.
      java.lang.String getContentTemplate()
      Returns the current value of the contentTemplate attribute.
      java.lang.String getContentTemplateEN()
      Returns the value of the contentTemplate attribute in the "EN" domain.
      int getFooterMargin()
      Returns the value of the footerMargin attribute.
      java.lang.String getFooterTemplate()
      Returns the current value of the footerTemplate attribute.
      java.lang.String getFooterTemplateEN()
      Returns the value of the footerTemplate attribute in the "EN" domain.
      int getHeaderMargin()
      Returns the value of the headerMargin attribute.
      java.lang.String getHeaderTemplate()
      Returns the current value of the headerTemplate attribute.
      java.lang.String getHeaderTemplateEN()
      Returns the value of the headerTemplate attribute in the "EN" domain.
      java.util.List<java.lang.String> getLocalizations()
      Returns the value of the localizations attribute.
      java.lang.String getLocalizationsElement​(int index)
      Returns the element at the position index in the list.
      int getLocalizationsSize()
      Returns the number of elements in the "localizations" container
      java.lang.String getName()
      Returns the value of the name attribute.
      boolean getShowPageNumbers()
      Returns the value of the showPageNumbers attribute.
      void removeLocalizationsElement​(int index)
      Removes the element at position index from the list.
      void setApplyBackgroundStyles​(boolean value)
      Sets the value of the applyBackgroundStyles attribute.
      void setContentTemplate​(java.lang.String value)
      Sets the value of the contentTemplate attribute in the current domain.
      void setContentTemplateEN​(java.lang.String value)
      Sets the value of the contentTemplate attribute in the domain "EN"
      void setFooterMargin​(int value)
      Sets the value of the footerMargin attribute.
      void setFooterTemplate​(java.lang.String value)
      Sets the value of the footerTemplate attribute in the current domain.
      void setFooterTemplateEN​(java.lang.String value)
      Sets the value of the footerTemplate attribute in the domain "EN"
      void setHeaderMargin​(int value)
      Sets the value of the headerMargin attribute.
      void setHeaderTemplate​(java.lang.String value)
      Sets the value of the headerTemplate attribute in the current domain.
      void setHeaderTemplateEN​(java.lang.String value)
      Sets the value of the headerTemplate attribute in the domain "EN"
      void setLocalizations​(java.util.List<java.lang.String> value)
      Sets the value of the localizations attribute.
      void setName​(java.lang.String value)
      Sets the value of the name attribute.
      void setShowPageNumbers​(boolean value)
      Sets the value of the showPageNumbers attribute.
      void swapLocalizationsElement​(int index1, int index2)
      Swaps elements at positions index1 and index2 in the list.
      • Methods inherited from interface net.anotheria.asg.data.DataObject

        clone, getDefinedName, getDefinedParentName, getFootprint, getId, getLastUpdateTimestamp, getObjectInfo, getPropertyValue, toXMLNode
      • Methods inherited from interface net.anotheria.util.sorter.IComparable

        compareTo
    • Field Detail

      • PROP_ID

        static final java.lang.String PROP_ID
        Constant property name for "id" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_NAME

        static final java.lang.String PROP_NAME
        Constant property name for "name" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_SHOW_PAGE_NUMBERS

        static final java.lang.String PROP_SHOW_PAGE_NUMBERS
        Constant property name for "showPageNumbers" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_APPLY_BACKGROUND_STYLES

        static final java.lang.String PROP_APPLY_BACKGROUND_STYLES
        Constant property name for "applyBackgroundStyles" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_HEADER_TEMPLATE_EN

        static final java.lang.String PROP_HEADER_TEMPLATE_EN
        Constant property name for "headerTemplate" and domain "EN" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_HEADER_MARGIN

        static final java.lang.String PROP_HEADER_MARGIN
        Constant property name for "headerMargin" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_FOOTER_TEMPLATE_EN

        static final java.lang.String PROP_FOOTER_TEMPLATE_EN
        Constant property name for "footerTemplate" and domain "EN" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_FOOTER_MARGIN

        static final java.lang.String PROP_FOOTER_MARGIN
        Constant property name for "footerMargin" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_CONTENT_TEMPLATE_EN

        static final java.lang.String PROP_CONTENT_TEMPLATE_EN
        Constant property name for "contentTemplate" and domain "EN" for internal storage and queries.
        See Also:
        Constant Field Values
      • PROP_LOCALIZATIONS

        static final java.lang.String PROP_LOCALIZATIONS
        Constant property name for "localizations" for internal storage and queries.
        See Also:
        Constant Field Values
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the value of the name attribute.
      • setName

        void setName​(java.lang.String value)
        Sets the value of the name attribute.
      • getShowPageNumbers

        boolean getShowPageNumbers()
        Returns the value of the showPageNumbers attribute.
      • setShowPageNumbers

        void setShowPageNumbers​(boolean value)
        Sets the value of the showPageNumbers attribute.
      • getApplyBackgroundStyles

        boolean getApplyBackgroundStyles()
        Returns the value of the applyBackgroundStyles attribute.
      • setApplyBackgroundStyles

        void setApplyBackgroundStyles​(boolean value)
        Sets the value of the applyBackgroundStyles attribute.
      • getHeaderTemplateEN

        java.lang.String getHeaderTemplateEN()
        Returns the value of the headerTemplate attribute in the "EN" domain.
      • getHeaderTemplate

        java.lang.String getHeaderTemplate()
        Returns the current value of the headerTemplate attribute. Current means in the currently selected domain.
      • setHeaderTemplateEN

        void setHeaderTemplateEN​(java.lang.String value)
        Sets the value of the headerTemplate attribute in the domain "EN"
      • setHeaderTemplate

        void setHeaderTemplate​(java.lang.String value)
        Sets the value of the headerTemplate attribute in the current domain. Current means in the currently selected domain.
      • getHeaderMargin

        int getHeaderMargin()
        Returns the value of the headerMargin attribute.
      • setHeaderMargin

        void setHeaderMargin​(int value)
        Sets the value of the headerMargin attribute.
      • getFooterTemplateEN

        java.lang.String getFooterTemplateEN()
        Returns the value of the footerTemplate attribute in the "EN" domain.
      • getFooterTemplate

        java.lang.String getFooterTemplate()
        Returns the current value of the footerTemplate attribute. Current means in the currently selected domain.
      • setFooterTemplateEN

        void setFooterTemplateEN​(java.lang.String value)
        Sets the value of the footerTemplate attribute in the domain "EN"
      • setFooterTemplate

        void setFooterTemplate​(java.lang.String value)
        Sets the value of the footerTemplate attribute in the current domain. Current means in the currently selected domain.
      • getFooterMargin

        int getFooterMargin()
        Returns the value of the footerMargin attribute.
      • setFooterMargin

        void setFooterMargin​(int value)
        Sets the value of the footerMargin attribute.
      • getContentTemplateEN

        java.lang.String getContentTemplateEN()
        Returns the value of the contentTemplate attribute in the "EN" domain.
      • getContentTemplate

        java.lang.String getContentTemplate()
        Returns the current value of the contentTemplate attribute. Current means in the currently selected domain.
      • setContentTemplateEN

        void setContentTemplateEN​(java.lang.String value)
        Sets the value of the contentTemplate attribute in the domain "EN"
      • setContentTemplate

        void setContentTemplate​(java.lang.String value)
        Sets the value of the contentTemplate attribute in the current domain. Current means in the currently selected domain.
      • getLocalizations

        java.util.List<java.lang.String> getLocalizations()
        Returns the value of the localizations attribute.
      • setLocalizations

        void setLocalizations​(java.util.List<java.lang.String> value)
        Sets the value of the localizations attribute.
      • getLocalizationsSize

        int getLocalizationsSize()
        Returns the number of elements in the "localizations" container
      • addLocalizationsElement

        void addLocalizationsElement​(java.lang.String guard)
        Adds a new element to the list.
      • removeLocalizationsElement

        void removeLocalizationsElement​(int index)
        Removes the element at position index from the list.
      • swapLocalizationsElement

        void swapLocalizationsElement​(int index1,
                                      int index2)
        Swaps elements at positions index1 and index2 in the list.
      • getLocalizationsElement

        java.lang.String getLocalizationsElement​(int index)
        Returns the element at the position index in the list.
      • copyLANG2LANG

        void copyLANG2LANG​(java.lang.String sourceLanguge,
                           java.lang.String destLanguage)
        Copies all multilingual properties from source language to destination language