Package org.docx4j.dml.chart

Class CTHeaderFooter

java.lang.Object
org.docx4j.dml.chart.CTHeaderFooter
All Implemented Interfaces:
Child
public class CTHeaderFooter
extends java.lang.Object
implements Child

Java class for CT_HeaderFooter complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="CT_HeaderFooter">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="oddHeader" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}ST_Xstring" minOccurs="0"/>
         <element name="oddFooter" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}ST_Xstring" minOccurs="0"/>
         <element name="evenHeader" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}ST_Xstring" minOccurs="0"/>
         <element name="evenFooter" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}ST_Xstring" minOccurs="0"/>
         <element name="firstHeader" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}ST_Xstring" minOccurs="0"/>
         <element name="firstFooter" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}ST_Xstring" minOccurs="0"/>
       </sequence>
       <attribute name="alignWithMargins" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="differentOddEven" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="differentFirst" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected java.lang.Boolean alignWithMargins  
    protected java.lang.Boolean differentFirst  
    protected java.lang.Boolean differentOddEven  
    protected java.lang.String evenFooter  
    protected java.lang.String evenHeader  
    protected java.lang.String firstFooter  
    protected java.lang.String firstHeader  
    protected java.lang.String oddFooter  
    protected java.lang.String oddHeader  

  • Constructor Summary

    Constructors
    Constructor Description
    CTHeaderFooter()  

  • Method Summary

    Modifier and Type Method Description
    void afterUnmarshal​(jakarta.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    java.lang.String getEvenFooter()
    Gets the value of the evenFooter property.
    java.lang.String getEvenHeader()
    Gets the value of the evenHeader property.
    java.lang.String getFirstFooter()
    Gets the value of the firstFooter property.
    java.lang.String getFirstHeader()
    Gets the value of the firstHeader property.
    java.lang.String getOddFooter()
    Gets the value of the oddFooter property.
    java.lang.String getOddHeader()
    Gets the value of the oddHeader property.
    java.lang.Object getParent()
    Gets the parent object in the object tree representing the unmarshalled xml document.
    boolean isAlignWithMargins()
    Gets the value of the alignWithMargins property.
    boolean isDifferentFirst()
    Gets the value of the differentFirst property.
    boolean isDifferentOddEven()
    Gets the value of the differentOddEven property.
    void setAlignWithMargins​(java.lang.Boolean value)
    Sets the value of the alignWithMargins property.
    void setDifferentFirst​(java.lang.Boolean value)
    Sets the value of the differentFirst property.
    void setDifferentOddEven​(java.lang.Boolean value)
    Sets the value of the differentOddEven property.
    void setEvenFooter​(java.lang.String value)
    Sets the value of the evenFooter property.
    void setEvenHeader​(java.lang.String value)
    Sets the value of the evenHeader property.
    void setFirstFooter​(java.lang.String value)
    Sets the value of the firstFooter property.
    void setFirstHeader​(java.lang.String value)
    Sets the value of the firstHeader property.
    void setOddFooter​(java.lang.String value)
    Sets the value of the oddFooter property.
    void setOddHeader​(java.lang.String value)
    Sets the value of the oddHeader property.
    void setParent​(java.lang.Object parent)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • oddHeader

      protected java.lang.String oddHeader

    • oddFooter

      protected java.lang.String oddFooter

    • evenHeader

      protected java.lang.String evenHeader

    • evenFooter

      protected java.lang.String evenFooter

    • firstHeader

      protected java.lang.String firstHeader

    • firstFooter

      protected java.lang.String firstFooter

    • alignWithMargins

      protected java.lang.Boolean alignWithMargins

    • differentOddEven

      protected java.lang.Boolean differentOddEven

    • differentFirst

      protected java.lang.Boolean differentFirst

  • Constructor Details

    • CTHeaderFooter

      public CTHeaderFooter()

  • Method Details

    • getOddHeader

      public java.lang.String getOddHeader()
      Gets the value of the oddHeader property.
      Returns:
      possible object is String

    • setOddHeader

      public void setOddHeader​(java.lang.String value)
      Sets the value of the oddHeader property.
      Parameters:
      value - allowed object is String

    • getOddFooter

      public java.lang.String getOddFooter()
      Gets the value of the oddFooter property.
      Returns:
      possible object is String

    • setOddFooter

      public void setOddFooter​(java.lang.String value)
      Sets the value of the oddFooter property.
      Parameters:
      value - allowed object is String

    • getEvenHeader

      public java.lang.String getEvenHeader()
      Gets the value of the evenHeader property.
      Returns:
      possible object is String

    • setEvenHeader

      public void setEvenHeader​(java.lang.String value)
      Sets the value of the evenHeader property.
      Parameters:
      value - allowed object is String

    • getEvenFooter

      public java.lang.String getEvenFooter()
      Gets the value of the evenFooter property.
      Returns:
      possible object is String

    • setEvenFooter

      public void setEvenFooter​(java.lang.String value)
      Sets the value of the evenFooter property.
      Parameters:
      value - allowed object is String

    • getFirstHeader

      public java.lang.String getFirstHeader()
      Gets the value of the firstHeader property.
      Returns:
      possible object is String

    • setFirstHeader

      public void setFirstHeader​(java.lang.String value)
      Sets the value of the firstHeader property.
      Parameters:
      value - allowed object is String

    • getFirstFooter

      public java.lang.String getFirstFooter()
      Gets the value of the firstFooter property.
      Returns:
      possible object is String

    • setFirstFooter

      public void setFirstFooter​(java.lang.String value)
      Sets the value of the firstFooter property.
      Parameters:
      value - allowed object is String

    • isAlignWithMargins

      public boolean isAlignWithMargins()
      Gets the value of the alignWithMargins property.
      Returns:
      possible object is Boolean

    • setAlignWithMargins

      public void setAlignWithMargins​(java.lang.Boolean value)
      Sets the value of the alignWithMargins property.
      Parameters:
      value - allowed object is Boolean

    • isDifferentOddEven

      public boolean isDifferentOddEven()
      Gets the value of the differentOddEven property.
      Returns:
      possible object is Boolean

    • setDifferentOddEven

      public void setDifferentOddEven​(java.lang.Boolean value)
      Sets the value of the differentOddEven property.
      Parameters:
      value - allowed object is Boolean

    • isDifferentFirst

      public boolean isDifferentFirst()
      Gets the value of the differentFirst property.
      Returns:
      possible object is Boolean

    • setDifferentFirst

      public void setDifferentFirst​(java.lang.Boolean value)
      Sets the value of the differentFirst property.
      Parameters:
      value - allowed object is Boolean

    • getParent

      public java.lang.Object getParent()
      Gets the parent object in the object tree representing the unmarshalled xml document.
      Specified by:
      getParent in interface Child
      Returns:
      The parent object.

    • setParent

      public void setParent​(java.lang.Object parent)
      Specified by:
      setParent in interface Child

    • afterUnmarshal

      public void afterUnmarshal​(jakarta.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)
      This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
      Parameters:
      parent - The parent object in the object tree.
      unmarshaller - The unmarshaller that generated the instance.