java.lang.Object
- net.webpdf.wsclient.schema.extraction.info.HeaderFooterType

public class HeaderFooterType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">An element of this type defines header and footer values for a page of the document.</p>

Java class for HeaderFooterType complex type

.

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


 <complexType name="HeaderFooterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="font" type="{http://schema.webpdf.de/1.0/extraction/info}FontType"/>
         <element name="margin" type="{http://schema.webpdf.de/1.0/extraction/info}MarginType"/>
         <element name="header" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="left" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="center" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="right" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="footer" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="left" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="center" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="right" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </sequence>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="page" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="color" type="{http://schema.webpdf.de/1.0/extraction/info}RgbColorType" />
     </restriction>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HeaderFooterType.Footer`	Java class for anonymous complex type
`static class`	`HeaderFooterType.Header`	Java class for anonymous complex type

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`color`	<?
`protected FontType`	`font`
`protected HeaderFooterType.Footer`	`footer`	<?
`protected HeaderFooterType.Header`	`header`	<?
`protected MarginType`	`margin`
`protected String`	`objectKey`	<?
`protected Integer`	`page`	<?

Constructor Summary

Constructors
Constructor Description

HeaderFooterType()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getColor()`	<?
`FontType`	`getFont()`	Gets the value of the font property.
`HeaderFooterType.Footer`	`getFooter()`	<?
`HeaderFooterType.Header`	`getHeader()`	<?
`MarginType`	`getMargin()`	Gets the value of the margin property.
`String`	`getObjectKey()`	<?
`int`	`getPage()`	<?
`boolean`	`isSetColor()`
`boolean`	`isSetFont()`
`boolean`	`isSetFooter()`
`boolean`	`isSetHeader()`
`boolean`	`isSetMargin()`
`boolean`	`isSetObjectKey()`
`boolean`	`isSetPage()`
`void`	`setColor(String value)`	Sets the value of the color property.
`void`	`setFont(FontType value)`	Sets the value of the font property.
`void`	`setFooter(HeaderFooterType.Footer value)`	Sets the value of the footer property.
`void`	`setHeader(HeaderFooterType.Header value)`	Sets the value of the header property.
`void`	`setMargin(MarginType value)`	Sets the value of the margin property.
`void`	`setObjectKey(String value)`	Sets the value of the objectKey property.
`void`	`setPage(int value)`	Sets the value of the page property.
`void`	`unsetPage()`

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

Field Detail

font
```
protected FontType font
```

margin
```
protected MarginType margin
```

header

protected HeaderFooterType.Header header

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the values for a page header.</p>

footer

protected HeaderFooterType.Footer footer

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the values for a page footer.</p>

objectKey

protected String objectKey

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the header/footer definition.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.</p>

page

protected Integer page

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The page headers/footers shall be defined for.</p>

color

protected String color

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The text of headers and footers color.</p>

Constructor Detail
- HeaderFooterType
```
public HeaderFooterType()
```

Method Detail

getFont
```
public FontType getFont()
```
Gets the value of the font property.

Returns:

possible object is FontType

setFont
```
public void setFont(FontType value)
```
Sets the value of the font property.

Parameters:

value - allowed object is FontType

isSetFont
```
public boolean isSetFont()
```

getMargin
```
public MarginType getMargin()
```
Gets the value of the margin property.

Returns:

possible object is MarginType

setMargin
```
public void setMargin(MarginType value)
```
Sets the value of the margin property.

Parameters:

value - allowed object is MarginType

isSetMargin
```
public boolean isSetMargin()
```

getHeader

public HeaderFooterType.Header getHeader()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the values for a page header.</p>

Returns:: possible object is HeaderFooterType.Header

setHeader
```
public void setHeader(HeaderFooterType.Header value)
```
Sets the value of the header property.

Parameters:

value - allowed object is HeaderFooterType.Header

See Also:

getHeader()

isSetHeader
```
public boolean isSetHeader()
```

getFooter

public HeaderFooterType.Footer getFooter()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the values for a page footer.</p>

Returns:: possible object is HeaderFooterType.Footer

setFooter
```
public void setFooter(HeaderFooterType.Footer value)
```
Sets the value of the footer property.

Parameters:

value - allowed object is HeaderFooterType.Footer

See Also:

getFooter()

isSetFooter
```
public boolean isSetFooter()
```

getObjectKey

public String getObjectKey()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the header/footer definition.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.</p>

Returns:: possible object is String

setObjectKey
```
public void setObjectKey(String value)
```
Sets the value of the objectKey property.

Parameters:

value - allowed object is String

See Also:

getObjectKey()

isSetObjectKey
```
public boolean isSetObjectKey()
```

getPage

public int getPage()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The page headers/footers shall be defined for.</p>

Returns:: possible object is Integer

setPage
```
public void setPage(int value)
```
Sets the value of the page property.

Parameters:

value - allowed object is Integer

See Also:

getPage()

isSetPage
```
public boolean isSetPage()
```

unsetPage
```
public void unsetPage()
```

getColor

public String getColor()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The text of headers and footers color.</p>

Returns:: possible object is String

setColor
```
public void setColor(String value)
```
Sets the value of the color property.

Parameters:

value - allowed object is String

See Also:

getColor()

isSetColor
```
public boolean isSetColor()
```

Class HeaderFooterType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

font

margin

header

footer

objectKey

page

color

Constructor Detail

HeaderFooterType

Method Detail

getFont

setFont

isSetFont

getMargin

setMargin

isSetMargin

getHeader

setHeader

isSetHeader

getFooter

setFooter

isSetFooter

getObjectKey

setObjectKey

isSetObjectKey

getPage

setPage

isSetPage

unsetPage

getColor

setColor

isSetColor