CTHeaderFooter (docx4j-openxml-objects 8.2.3 API)

java.lang.Object
- org.docx4j.dml.chart.CTHeaderFooter

All Implemented Interfaces:: Child

public class CTHeaderFooter
extends 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 and Description
`protected Boolean`	`alignWithMargins`
`protected Boolean`	`differentFirst`
`protected Boolean`	`differentOddEven`
`protected String`	`evenFooter`
`protected String`	`evenHeader`
`protected String`	`firstFooter`
`protected String`	`firstHeader`
`protected String`	`oddFooter`
`protected String`	`oddHeader`

Constructor Summary

Constructors
Constructor and Description

CTHeaderFooter()

Constructors
Constructor and Description
`CTHeaderFooter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`String`	`getEvenFooter()` Gets the value of the evenFooter property.
`String`	`getEvenHeader()` Gets the value of the evenHeader property.
`String`	`getFirstFooter()` Gets the value of the firstFooter property.
`String`	`getFirstHeader()` Gets the value of the firstHeader property.
`String`	`getOddFooter()` Gets the value of the oddFooter property.
`String`	`getOddHeader()` Gets the value of the oddHeader property.
`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(Boolean value)` Sets the value of the alignWithMargins property.
`void`	`setDifferentFirst(Boolean value)` Sets the value of the differentFirst property.
`void`	`setDifferentOddEven(Boolean value)` Sets the value of the differentOddEven property.
`void`	`setEvenFooter(String value)` Sets the value of the evenFooter property.
`void`	`setEvenHeader(String value)` Sets the value of the evenHeader property.
`void`	`setFirstFooter(String value)` Sets the value of the firstFooter property.
`void`	`setFirstHeader(String value)` Sets the value of the firstHeader property.
`void`	`setOddFooter(String value)` Sets the value of the oddFooter property.
`void`	`setOddHeader(String value)` Sets the value of the oddHeader property.
`void`	`setParent(Object parent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - oddHeader
```
protected String oddHeader
```
  - oddFooter
```
protected String oddFooter
```
  - evenHeader
```
protected String evenHeader
```
  - evenFooter
```
protected String evenFooter
```
  - firstHeader
```
protected String firstHeader
```
  - firstFooter
```
protected String firstFooter
```
  - alignWithMargins
```
protected Boolean alignWithMargins
```
  - differentOddEven
```
protected Boolean differentOddEven
```
  - differentFirst
```
protected Boolean differentFirst
```
- Constructor Detail
  - CTHeaderFooter
```
public CTHeaderFooter()
```
- Method Detail
  - getOddHeader
```
public String getOddHeader()
```
    Gets the value of the oddHeader property.
    
    Returns:
    
    possible object is String
  - setOddHeader
```
public void setOddHeader(String value)
```
    Sets the value of the oddHeader property.
    
    Parameters:
    
    value - allowed object is String
  - getOddFooter
```
public String getOddFooter()
```
    Gets the value of the oddFooter property.
    
    Returns:
    
    possible object is String
  - setOddFooter
```
public void setOddFooter(String value)
```
    Sets the value of the oddFooter property.
    
    Parameters:
    
    value - allowed object is String
  - getEvenHeader
```
public String getEvenHeader()
```
    Gets the value of the evenHeader property.
    
    Returns:
    
    possible object is String
  - setEvenHeader
```
public void setEvenHeader(String value)
```
    Sets the value of the evenHeader property.
    
    Parameters:
    
    value - allowed object is String
  - getEvenFooter
```
public String getEvenFooter()
```
    Gets the value of the evenFooter property.
    
    Returns:
    
    possible object is String
  - setEvenFooter
```
public void setEvenFooter(String value)
```
    Sets the value of the evenFooter property.
    
    Parameters:
    
    value - allowed object is String
  - getFirstHeader
```
public String getFirstHeader()
```
    Gets the value of the firstHeader property.
    
    Returns:
    
    possible object is String
  - setFirstHeader
```
public void setFirstHeader(String value)
```
    Sets the value of the firstHeader property.
    
    Parameters:
    
    value - allowed object is String
  - getFirstFooter
```
public String getFirstFooter()
```
    Gets the value of the firstFooter property.
    
    Returns:
    
    possible object is String
  - setFirstFooter
```
public void setFirstFooter(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(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(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(Boolean value)
```
    Sets the value of the differentFirst property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getParent
```
public 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(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           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.

Class CTHeaderFooter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

oddHeader

oddFooter

evenHeader

evenFooter

firstHeader

firstFooter

alignWithMargins

differentOddEven

differentFirst

Constructor Detail

CTHeaderFooter

Method Detail

getOddHeader

setOddHeader

getOddFooter

setOddFooter

getEvenHeader

setEvenHeader

getEvenFooter

setEvenFooter

getFirstHeader

setFirstHeader

getFirstFooter

setFirstFooter

isAlignWithMargins

setAlignWithMargins

isDifferentOddEven

setDifferentOddEven

isDifferentFirst

setDifferentFirst

getParent

setParent

afterUnmarshal