Class PdfTemplateDocument

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, net.anotheria.anodoc.data.IBasicStoreableObject, net.anotheria.anodoc.data.ICompositeDataObject, PdfTemplate, net.anotheria.asg.data.DataObject, net.anotheria.asg.data.LockableObject, net.anotheria.asg.data.MultilingualObject, net.anotheria.util.sorter.IComparable

    public class PdfTemplateDocument
    extends net.anotheria.asg.data.AbstractASGDocument
    implements PdfTemplate, net.anotheria.util.sorter.IComparable, net.anotheria.asg.data.MultilingualObject
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addLocalizationsElement​(java.lang.String guard)
      Adds a new element to the list.
      int compareTo​(PdfTemplate comparable)  
      int compareTo​(net.anotheria.util.sorter.IComparable anotherComparable, int method)  
      void copyLANG2LANG​(java.lang.String sourceLanguage, java.lang.String destLanguage)
      Copies all multilingual properties from source language to destination language
      boolean equals​(java.lang.Object o)  
      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.
      java.lang.String getDefinedName()  
      java.lang.String getDefinedParentName()  
      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.
      java.lang.String getFootprint()  
      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.
      boolean isMultilingualDisabledInstance()  
      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 setMultilingualDisabledInstance​(boolean value)  
      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.
      java.lang.String toString()  
      • Methods inherited from class net.anotheria.asg.data.AbstractASGDocument

        getInternalProperty, getLockerId, getLockingTime, getObjectInfo, isLocked, setInternalProperty, setLocked, setLockerId, setLockingTime
      • Methods inherited from class net.anotheria.anodoc.data.Document

        addDataHolder, clone, copyFromBooleanList, copyFromDoubleList, copyFromFloatList, copyFromIntegerList, copyFromLongList, copyFromStringList, copyToBooleanList, copyToDoubleList, copyToFloatList, copyToIntegerList, copyToLongList, copyToStringList, createDocument, createDocumentList, createListProperty, getAuthor, getBoolean, getBooleanProperty, getDataHolder, getDocument, getDocumentAnyCase, getDocumentList, getDocumentListAnyCase, getDouble, getDoubleProperty, getEmptyBoolean, getEmptyDouble, getEmptyFloat, getEmptyInt, getEmptyList, getEmptyLong, getEmptyString, getFloat, getFloatProperty, getInt, getIntProperty, getKeys, getLastUpdateTimestamp, getList, getListProperty, getListPropertyAnyCase, getLong, getLongProperty, getObject, getProperties, getProperty, getPropertyValue, getSizeInBytes, getStorageId, getString, getStringProperty, getTypeIdentifier, putBooleanProperty, putDocument, putDoubleProperty, putFloatProperty, putIntProperty, putList, putListProperty, putLongProperty, putProperty, putStringProperty, removeDataHolder, removeDataHolder, removeProperty, removeProperty, renameTo, setBoolean, setCallContextAuthor, setDouble, setFloat, setInt, setLastUpdateNow, setList, setLong, setString, setTypeIdentifier, toXMLNode
      • Methods inherited from class net.anotheria.anodoc.data.DataHolder

        getId, hashCode, setId
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface net.anotheria.asg.data.DataObject

        clone, getId, getLastUpdateTimestamp, getObjectInfo, getPropertyValue, toXMLNode
    • Constructor Detail

      • PdfTemplateDocument

        public PdfTemplateDocument()
      • PdfTemplateDocument

        public PdfTemplateDocument​(java.lang.String id)
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: PdfTemplate
        Returns the value of the name attribute.
        Specified by:
        getName in interface PdfTemplate
      • setName

        public void setName​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the name attribute.
        Specified by:
        setName in interface PdfTemplate
      • getShowPageNumbers

        public boolean getShowPageNumbers()
        Description copied from interface: PdfTemplate
        Returns the value of the showPageNumbers attribute.
        Specified by:
        getShowPageNumbers in interface PdfTemplate
      • setShowPageNumbers

        public void setShowPageNumbers​(boolean value)
        Description copied from interface: PdfTemplate
        Sets the value of the showPageNumbers attribute.
        Specified by:
        setShowPageNumbers in interface PdfTemplate
      • getApplyBackgroundStyles

        public boolean getApplyBackgroundStyles()
        Description copied from interface: PdfTemplate
        Returns the value of the applyBackgroundStyles attribute.
        Specified by:
        getApplyBackgroundStyles in interface PdfTemplate
      • setApplyBackgroundStyles

        public void setApplyBackgroundStyles​(boolean value)
        Description copied from interface: PdfTemplate
        Sets the value of the applyBackgroundStyles attribute.
        Specified by:
        setApplyBackgroundStyles in interface PdfTemplate
      • getHeaderTemplateEN

        public java.lang.String getHeaderTemplateEN()
        Description copied from interface: PdfTemplate
        Returns the value of the headerTemplate attribute in the "EN" domain.
        Specified by:
        getHeaderTemplateEN in interface PdfTemplate
      • getHeaderTemplate

        public java.lang.String getHeaderTemplate()
        Description copied from interface: PdfTemplate
        Returns the current value of the headerTemplate attribute. Current means in the currently selected domain.
        Specified by:
        getHeaderTemplate in interface PdfTemplate
      • setHeaderTemplateEN

        public void setHeaderTemplateEN​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the headerTemplate attribute in the domain "EN"
        Specified by:
        setHeaderTemplateEN in interface PdfTemplate
      • setHeaderTemplate

        public void setHeaderTemplate​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the headerTemplate attribute in the current domain. Current means in the currently selected domain.
        Specified by:
        setHeaderTemplate in interface PdfTemplate
      • getHeaderMargin

        public int getHeaderMargin()
        Description copied from interface: PdfTemplate
        Returns the value of the headerMargin attribute.
        Specified by:
        getHeaderMargin in interface PdfTemplate
      • setHeaderMargin

        public void setHeaderMargin​(int value)
        Description copied from interface: PdfTemplate
        Sets the value of the headerMargin attribute.
        Specified by:
        setHeaderMargin in interface PdfTemplate
      • getFooterTemplateEN

        public java.lang.String getFooterTemplateEN()
        Description copied from interface: PdfTemplate
        Returns the value of the footerTemplate attribute in the "EN" domain.
        Specified by:
        getFooterTemplateEN in interface PdfTemplate
      • getFooterTemplate

        public java.lang.String getFooterTemplate()
        Description copied from interface: PdfTemplate
        Returns the current value of the footerTemplate attribute. Current means in the currently selected domain.
        Specified by:
        getFooterTemplate in interface PdfTemplate
      • setFooterTemplateEN

        public void setFooterTemplateEN​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the footerTemplate attribute in the domain "EN"
        Specified by:
        setFooterTemplateEN in interface PdfTemplate
      • setFooterTemplate

        public void setFooterTemplate​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the footerTemplate attribute in the current domain. Current means in the currently selected domain.
        Specified by:
        setFooterTemplate in interface PdfTemplate
      • getFooterMargin

        public int getFooterMargin()
        Description copied from interface: PdfTemplate
        Returns the value of the footerMargin attribute.
        Specified by:
        getFooterMargin in interface PdfTemplate
      • setFooterMargin

        public void setFooterMargin​(int value)
        Description copied from interface: PdfTemplate
        Sets the value of the footerMargin attribute.
        Specified by:
        setFooterMargin in interface PdfTemplate
      • getContentTemplateEN

        public java.lang.String getContentTemplateEN()
        Description copied from interface: PdfTemplate
        Returns the value of the contentTemplate attribute in the "EN" domain.
        Specified by:
        getContentTemplateEN in interface PdfTemplate
      • getContentTemplate

        public java.lang.String getContentTemplate()
        Description copied from interface: PdfTemplate
        Returns the current value of the contentTemplate attribute. Current means in the currently selected domain.
        Specified by:
        getContentTemplate in interface PdfTemplate
      • setContentTemplateEN

        public void setContentTemplateEN​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the contentTemplate attribute in the domain "EN"
        Specified by:
        setContentTemplateEN in interface PdfTemplate
      • setContentTemplate

        public void setContentTemplate​(java.lang.String value)
        Description copied from interface: PdfTemplate
        Sets the value of the contentTemplate attribute in the current domain. Current means in the currently selected domain.
        Specified by:
        setContentTemplate in interface PdfTemplate
      • getLocalizations

        public java.util.List<java.lang.String> getLocalizations()
        Description copied from interface: PdfTemplate
        Returns the value of the localizations attribute.
        Specified by:
        getLocalizations in interface PdfTemplate
      • setLocalizations

        public void setLocalizations​(java.util.List<java.lang.String> value)
        Description copied from interface: PdfTemplate
        Sets the value of the localizations attribute.
        Specified by:
        setLocalizations in interface PdfTemplate
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class net.anotheria.anodoc.data.Document
      • getLocalizationsSize

        public int getLocalizationsSize()
        Description copied from interface: PdfTemplate
        Returns the number of elements in the "localizations" container
        Specified by:
        getLocalizationsSize in interface PdfTemplate
      • addLocalizationsElement

        public void addLocalizationsElement​(java.lang.String guard)
        Description copied from interface: PdfTemplate
        Adds a new element to the list.
        Specified by:
        addLocalizationsElement in interface PdfTemplate
      • removeLocalizationsElement

        public void removeLocalizationsElement​(int index)
        Description copied from interface: PdfTemplate
        Removes the element at position index from the list.
        Specified by:
        removeLocalizationsElement in interface PdfTemplate
      • swapLocalizationsElement

        public void swapLocalizationsElement​(int index1,
                                             int index2)
        Description copied from interface: PdfTemplate
        Swaps elements at positions index1 and index2 in the list.
        Specified by:
        swapLocalizationsElement in interface PdfTemplate
      • getLocalizationsElement

        public java.lang.String getLocalizationsElement​(int index)
        Description copied from interface: PdfTemplate
        Returns the element at the position index in the list.
        Specified by:
        getLocalizationsElement in interface PdfTemplate
      • compareTo

        public int compareTo​(PdfTemplate comparable)
      • compareTo

        public int compareTo​(net.anotheria.util.sorter.IComparable anotherComparable,
                             int method)
        Specified by:
        compareTo in interface net.anotheria.util.sorter.IComparable
      • getDefinedName

        public java.lang.String getDefinedName()
        Specified by:
        getDefinedName in interface net.anotheria.asg.data.DataObject
      • getDefinedParentName

        public java.lang.String getDefinedParentName()
        Specified by:
        getDefinedParentName in interface net.anotheria.asg.data.DataObject
      • getFootprint

        public java.lang.String getFootprint()
        Specified by:
        getFootprint in interface net.anotheria.asg.data.DataObject
      • copyLANG2LANG

        public void copyLANG2LANG​(java.lang.String sourceLanguage,
                                  java.lang.String destLanguage)
        Description copied from interface: PdfTemplate
        Copies all multilingual properties from source language to destination language
        Specified by:
        copyLANG2LANG in interface PdfTemplate
      • isMultilingualDisabledInstance

        public boolean isMultilingualDisabledInstance()
        Specified by:
        isMultilingualDisabledInstance in interface net.anotheria.asg.data.MultilingualObject
      • setMultilingualDisabledInstance

        public void setMultilingualDisabledInstance​(boolean value)
        Specified by:
        setMultilingualDisabledInstance in interface net.anotheria.asg.data.MultilingualObject
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object