Package org.cip4.jdflib.auto

Class JDFAutoLayout

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, IStreamWriter, org.w3c.dom.Element, org.w3c.dom.ElementTraversal, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList, org.w3c.dom.TypeInfo
    Direct Known Subclasses:
    JDFSignature
    public abstract class JDFAutoLayout
extends JDFResource
    class JDFAutoLayout : public JDFResource
    See Also:
    Serialized Form

    • Constructor Detail

      • JDFAutoLayout

        protected JDFAutoLayout​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                        java.lang.String qualifiedName)
        Constructor for JDFAutoLayout
        Parameters:
        myOwnerDocument -
        qualifiedName -

      • JDFAutoLayout

        protected JDFAutoLayout​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                        java.lang.String myNamespaceURI,
                        java.lang.String qualifiedName)
        Constructor for JDFAutoLayout
        Parameters:
        myOwnerDocument -
        myNamespaceURI -
        qualifiedName -

      • JDFAutoLayout

        protected JDFAutoLayout​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                        java.lang.String myNamespaceURI,
                        java.lang.String qualifiedName,
                        java.lang.String myLocalName)
        Constructor for JDFAutoLayout
        Parameters:
        myOwnerDocument -
        myNamespaceURI -
        qualifiedName -
        myLocalName -

    • Method Detail

      • setAutomated

        public void setAutomated​(boolean value)
        (36) set attribute Automated
        Parameters:
        value - the value to set the attribute to

      • getAutomated

        public boolean getAutomated()
        (18) get boolean attribute Automated
        Returns:
        boolean the value of the attribute

      • setLockOrigins

        public void setLockOrigins​(boolean value)
        (36) set attribute LockOrigins
        Parameters:
        value - the value to set the attribute to

      • getLockOrigins

        public boolean getLockOrigins()
        (18) get boolean attribute LockOrigins
        Returns:
        boolean the value of the attribute

      • setMaxDocOrd

        public void setMaxDocOrd​(int value)
        (36) set attribute MaxDocOrd
        Parameters:
        value - the value to set the attribute to

      • getMaxDocOrd

        public int getMaxDocOrd()
        (15) get int attribute MaxDocOrd
        Returns:
        int the value of the attribute

      • setMaxSetOrd

        public void setMaxSetOrd​(int value)
        (36) set attribute MaxSetOrd
        Parameters:
        value - the value to set the attribute to

      • getMaxSetOrd

        public int getMaxSetOrd()
        (15) get int attribute MaxSetOrd
        Returns:
        int the value of the attribute

      • setOrdReset

        public void setOrdReset​(JDFAutoLayout.EnumOrdReset enumVar)
        (5) set attribute OrdReset
        Parameters:
        enumVar - the enumVar to set the attribute to

      • setSheetCountReset

        public void setSheetCountReset​(JDFAutoLayout.EnumSheetCountReset enumVar)
        (5) set attribute SheetCountReset
        Parameters:
        enumVar - the enumVar to set the attribute to

      • setName

        public void setName​(java.lang.String value)
        (36) set attribute Name
        Parameters:
        value - the value to set the attribute to

      • getName

        public java.lang.String getName()
        (23) get String attribute Name
        Returns:
        the value of the attribute

      • setBaseOrdReset

        public void setBaseOrdReset​(JDFAutoLayout.EnumBaseOrdReset enumVar)
        (5) set attribute BaseOrdReset
        Parameters:
        enumVar - the enumVar to set the attribute to

      • setMaxCollect

        public void setMaxCollect​(int value)
        (36) set attribute MaxCollect
        Parameters:
        value - the value to set the attribute to

      • getMaxCollect

        public int getMaxCollect()
        (15) get int attribute MaxCollect
        Returns:
        int the value of the attribute

      • setMaxOrd

        public void setMaxOrd​(int value)
        (36) set attribute MaxOrd
        Parameters:
        value - the value to set the attribute to

      • getMaxOrd

        public int getMaxOrd()
        (15) get int attribute MaxOrd
        Returns:
        int the value of the attribute

      • setMinCollect

        public void setMinCollect​(int value)
        (36) set attribute MinCollect
        Parameters:
        value - the value to set the attribute to

      • getMinCollect

        public int getMinCollect()
        (15) get int attribute MinCollect
        Returns:
        int the value of the attribute

      • setOrdsConsumed

        public void setOrdsConsumed​(JDFIntegerRangeList value)
        (36) set attribute OrdsConsumed
        Parameters:
        value - the value to set the attribute to

      • getOrdsConsumed

        public JDFIntegerRangeList getOrdsConsumed()
        (20) get JDFIntegerRangeList attribute OrdsConsumed
        Returns:
        JDFIntegerRangeList the value of the attribute, null if a the attribute value is not a valid to create a JDFIntegerRangeList

      • setSheetNameFormat

        public void setSheetNameFormat​(java.lang.String value)
        (36) set attribute SheetNameFormat
        Parameters:
        value - the value to set the attribute to

      • getSheetNameFormat

        public java.lang.String getSheetNameFormat()
        (23) get String attribute SheetNameFormat
        Returns:
        the value of the attribute

      • setSheetNameTemplate

        public void setSheetNameTemplate​(java.lang.String value)
        (36) set attribute SheetNameTemplate
        Parameters:
        value - the value to set the attribute to

      • getSheetNameTemplate

        public java.lang.String getSheetNameTemplate()
        (23) get String attribute SheetNameTemplate
        Returns:
        the value of the attribute

      • setSourceWorkStyle

        public void setSourceWorkStyle​(JDFAutoLayout.EnumSourceWorkStyle enumVar)
        (5) set attribute SourceWorkStyle
        Parameters:
        enumVar - the enumVar to set the attribute to

      • setSurfaceContentsBox

        public void setSurfaceContentsBox​(JDFRectangle value)
        (36) set attribute SurfaceContentsBox
        Parameters:
        value - the value to set the attribute to

      • getSurfaceContentsBox

        public JDFRectangle getSurfaceContentsBox()
        (20) get JDFRectangle attribute SurfaceContentsBox
        Returns:
        JDFRectangle the value of the attribute, null if a the attribute value is not a valid to create a JDFRectangle

      • setTemplateType

        public void setTemplateType​(JDFAutoLayout.EnumTemplateType enumVar)
        (5) set attribute TemplateType
        Parameters:
        enumVar - the enumVar to set the attribute to

      • getCreateContentObject

        public JDFContentObject getCreateContentObject​(int iSkip)
        (26) getCreateContentObject
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFContentObject the element

      • getContentObject

        public JDFContentObject getContentObject​(int iSkip)
        (27) const get element ContentObject
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFContentObject the element default is getContentObject(0)

      • getAllContentObject

        public java.util.Collection<JDFContentObject> getAllContentObject()
        Get all ContentObject from the current element
        Returns:
        Collection, null if none are available

      • appendContentObject

        public JDFContentObject appendContentObject()
        (30) append element ContentObject
        Returns:
        JDFContentObject the element

      • getCreateInsertSheet

        public JDFInsertSheet getCreateInsertSheet​(int iSkip)
        (26) getCreateInsertSheet
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFInsertSheet the element

      • getInsertSheet

        public JDFInsertSheet getInsertSheet​(int iSkip)
        (27) const get element InsertSheet
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFInsertSheet the element default is getInsertSheet(0)

      • getAllInsertSheet

        public java.util.Collection<JDFInsertSheet> getAllInsertSheet()
        Get all InsertSheet from the current element
        Returns:
        Collection, null if none are available

      • appendInsertSheet

        public JDFInsertSheet appendInsertSheet()
        (30) append element InsertSheet
        Returns:
        JDFInsertSheet the element

      • refInsertSheet

        public void refInsertSheet​(JDFInsertSheet refTarget)
        (31) create inter-resource link to refTarget
        Parameters:
        refTarget - the element that is referenced

      • getLayerList

        public JDFLayerList getLayerList()
        (24) const get element LayerList
        Returns:
        JDFLayerList the element

      • getCreateLayerList

        public JDFLayerList getCreateLayerList()
        (25) getCreateLayerList
        Returns:
        JDFLayerList the element

      • appendLayerList

        public JDFLayerList appendLayerList()
        (29) append element LayerList
        Returns:
        JDFLayerList the element @ if the element already exists

      • getLogicalStackParams

        public JDFLogicalStackParams getLogicalStackParams()
        (24) const get element LogicalStackParams
        Returns:
        JDFLogicalStackParams the element

      • getCreateLogicalStackParams

        public JDFLogicalStackParams getCreateLogicalStackParams()
        (25) getCreateLogicalStackParams
        Returns:
        JDFLogicalStackParams the element

      • appendLogicalStackParams

        public JDFLogicalStackParams appendLogicalStackParams()
        (29) append element LogicalStackParams
        Returns:
        JDFLogicalStackParams the element @ if the element already exists

      • getCreateMarkObject

        public JDFMarkObject getCreateMarkObject​(int iSkip)
        (26) getCreateMarkObject
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFMarkObject the element

      • getMarkObject

        public JDFMarkObject getMarkObject​(int iSkip)
        (27) const get element MarkObject
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFMarkObject the element default is getMarkObject(0)

      • getAllMarkObject

        public java.util.Collection<JDFMarkObject> getAllMarkObject()
        Get all MarkObject from the current element
        Returns:
        Collection, null if none are available

      • appendMarkObject

        public JDFMarkObject appendMarkObject()
        (30) append element MarkObject
        Returns:
        JDFMarkObject the element

      • getCreateMedia

        public JDFMedia getCreateMedia​(int iSkip)
        (26) getCreateMedia
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFMedia the element

      • getMedia

        public JDFMedia getMedia​(int iSkip)
        (27) const get element Media
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFMedia the element default is getMedia(0)

      • getAllMedia

        public java.util.Collection<JDFMedia> getAllMedia()
        Get all Media from the current element
        Returns:
        Collection, null if none are available

      • appendMedia

        public JDFMedia appendMedia()
        (30) append element Media
        Returns:
        JDFMedia the element

      • refMedia

        public void refMedia​(JDFMedia refTarget)
        (31) create inter-resource link to refTarget
        Parameters:
        refTarget - the element that is referenced

      • getMediaSource

        public JDFMediaSource getMediaSource()
        (24) const get element MediaSource
        Returns:
        JDFMediaSource the element

      • getCreateMediaSource

        public JDFMediaSource getCreateMediaSource()
        (25) getCreateMediaSource
        Returns:
        JDFMediaSource the element

      • appendMediaSource

        public JDFMediaSource appendMediaSource()
        (29) append element MediaSource
        Returns:
        JDFMediaSource the element @ if the element already exists

      • refMediaSource

        public void refMediaSource​(JDFMediaSource refTarget)
        (31) create inter-resource link to refTarget
        Parameters:
        refTarget - the element that is referenced

      • getCreatePageCondition

        public JDFPageCondition getCreatePageCondition​(int iSkip)
        (26) getCreatePageCondition
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFPageCondition the element

      • getPageCondition

        public JDFPageCondition getPageCondition​(int iSkip)
        (27) const get element PageCondition
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFPageCondition the element default is getPageCondition(0)

      • getAllPageCondition

        public java.util.Collection<JDFPageCondition> getAllPageCondition()
        Get all PageCondition from the current element
        Returns:
        Collection, null if none are available

      • appendPageCondition

        public JDFPageCondition appendPageCondition()
        (30) append element PageCondition
        Returns:
        JDFPageCondition the element

      • getCreateSheetCondition

        public JDFSheetCondition getCreateSheetCondition​(int iSkip)
        (26) getCreateSheetCondition
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFSheetCondition the element

      • getSheetCondition

        public JDFSheetCondition getSheetCondition​(int iSkip)
        (27) const get element SheetCondition
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFSheetCondition the element default is getSheetCondition(0)

      • getAllSheetCondition

        public java.util.Collection<JDFSheetCondition> getAllSheetCondition()
        Get all SheetCondition from the current element
        Returns:
        Collection, null if none are available

      • appendSheetCondition

        public JDFSheetCondition appendSheetCondition()
        (30) append element SheetCondition
        Returns:
        JDFSheetCondition the element

      • getCreateSignature

        public JDFSignature getCreateSignature​(int iSkip)
        (26) getCreateSignature
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFSignature the element

      • getSignature

        public JDFSignature getSignature​(int iSkip)
        (27) const get element Signature
        Parameters:
        iSkip - number of elements to skip
        Returns:
        JDFSignature the element default is getSignature(0)

      • getAllSignature

        public java.util.Collection<JDFSignature> getAllSignature()
        Get all Signature from the current element
        Returns:
        Collection, null if none are available

      • appendSignature

        public JDFSignature appendSignature()
        (30) append element Signature
        Returns:
        JDFSignature the element

      • getTransferCurvePool

        public JDFTransferCurvePool getTransferCurvePool()
        (24) const get element TransferCurvePool
        Returns:
        JDFTransferCurvePool the element

      • getCreateTransferCurvePool

        public JDFTransferCurvePool getCreateTransferCurvePool()
        (25) getCreateTransferCurvePool
        Returns:
        JDFTransferCurvePool the element

      • appendTransferCurvePool

        public JDFTransferCurvePool appendTransferCurvePool()
        (29) append element TransferCurvePool
        Returns:
        JDFTransferCurvePool the element @ if the element already exists

      • refTransferCurvePool

        public void refTransferCurvePool​(JDFTransferCurvePool refTarget)
        (31) create inter-resource link to refTarget
        Parameters:
        refTarget - the element that is referenced