Package org.cip4.jdflib.auto

Class JDFAutoLayout

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.cip4.jdflib.core.KElement
org.cip4.jdflib.core.JDFElement
org.cip4.jdflib.resource.JDFResource
org.cip4.jdflib.auto.JDFAutoLayout
All Implemented Interfaces:
Serializable, Cloneable, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
JDFSignature
public abstract class JDFAutoLayout extends JDFResource
class JDFAutoLayout : public JDFResource
See Also:

  • Constructor Details

    • JDFAutoLayout

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

    • JDFAutoLayout

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

    • JDFAutoLayout

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

  • Method Details

    • getTheAttributeInfo

      protected AttributeInfo getTheAttributeInfo()
      Overrides:
      getTheAttributeInfo in class JDFResource
      Returns:

    • getTheElementInfo

      protected ElementInfo getTheElementInfo()
      Overrides:
      getTheElementInfo in class JDFResource
      Returns:
      the elementinfo

    • init

      public boolean init()
      Description copied from class: JDFResource
      default initialization
      Overrides:
      init in class JDFResource
      Returns:
      true if ok
      See Also:

    • getValidClass

      public JDFResource.EnumResourceClass getValidClass()
      Description copied from class: JDFResource
      get the fixed class for this resource,
      Overrides:
      getValidClass in class JDFResource
      Returns:
      the resource Class

    • 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

    • getOrdReset

      public JDFAutoLayout.EnumOrdReset getOrdReset()
      (9) get attribute OrdReset
      Returns:
      the value of the attribute

    • setSheetCountReset

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

    • getSheetCountReset

      public JDFAutoLayout.EnumSheetCountReset getSheetCountReset()
      (9) get attribute SheetCountReset
      Returns:
      the value of the attribute

    • setName

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

    • getName

      public 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

    • getBaseOrdReset

      public JDFAutoLayout.EnumBaseOrdReset getBaseOrdReset()
      (9) get attribute BaseOrdReset
      Returns:
      the value of the attribute

    • 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(String value)
      (36) set attribute SheetNameFormat
      Parameters:
      value - the value to set the attribute to

    • getSheetNameFormat

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

    • setSheetNameTemplate

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

    • getSheetNameTemplate

      public 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

    • getSourceWorkStyle

      public JDFAutoLayout.EnumSourceWorkStyle getSourceWorkStyle()
      (9) get attribute SourceWorkStyle
      Returns:
      the value of the attribute

    • 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

    • getTemplateType

      public JDFAutoLayout.EnumTemplateType getTemplateType()
      (9) get attribute TemplateType
      Returns:
      the value of the attribute

    • getContentObject

      public JDFContentObject getContentObject()
      (24) const get element ContentObject
      Returns:
      JDFContentObject the element

    • getCreateContentObject

      public JDFContentObject getCreateContentObject()
      (25) getCreateContentObject
      Returns:
      JDFContentObject the element

    • 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 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

    • getInsertSheet

      public JDFInsertSheet getInsertSheet()
      (24) const get element InsertSheet
      Returns:
      JDFInsertSheet the element

    • getCreateInsertSheet

      public JDFInsertSheet getCreateInsertSheet()
      (25) getCreateInsertSheet
      Returns:
      JDFInsertSheet 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 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

    • getMarkObject

      public JDFMarkObject getMarkObject()
      (24) const get element MarkObject
      Returns:
      JDFMarkObject the element

    • getCreateMarkObject

      public JDFMarkObject getCreateMarkObject()
      (25) getCreateMarkObject
      Returns:
      JDFMarkObject the element

    • 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 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

    • getMedia

      public JDFMedia getMedia()
      (24) const get element Media
      Returns:
      JDFMedia the element

    • getCreateMedia

      public JDFMedia getCreateMedia()
      (25) getCreateMedia
      Returns:
      JDFMedia 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 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

    • getPageCondition

      public JDFPageCondition getPageCondition()
      (24) const get element PageCondition
      Returns:
      JDFPageCondition the element

    • getCreatePageCondition

      public JDFPageCondition getCreatePageCondition()
      (25) getCreatePageCondition
      Returns:
      JDFPageCondition the element

    • 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 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

    • getSheetCondition

      public JDFSheetCondition getSheetCondition()
      (24) const get element SheetCondition
      Returns:
      JDFSheetCondition the element

    • getCreateSheetCondition

      public JDFSheetCondition getCreateSheetCondition()
      (25) getCreateSheetCondition
      Returns:
      JDFSheetCondition 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 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

    • getSignature

      public JDFSignature getSignature()
      (24) const get element Signature
      Returns:
      JDFSignature the element

    • getCreateSignature

      public JDFSignature getCreateSignature()
      (25) getCreateSignature
      Returns:
      JDFSignature 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 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