Package net.webpdf.wsclient.schema.operation

Class HeaderFooterType

java.lang.Object

net.webpdf.wsclient.schema.operation.HeaderFooterType

public class HeaderFooterType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the header and footer that will be added to a 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">
       <all>
         <element name="pages" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice>
                   <element name="pageInterval" type="{http://schema.webpdf.de/1.0/operation}PageIntervalType" minOccurs="0"/>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="margin" type="{http://schema.webpdf.de/1.0/operation}OptionsMarginType" minOccurs="0"/>
         <element name="font" type="{http://schema.webpdf.de/1.0/operation}OptionsFontType" minOccurs="0"/>
         <element name="header" type="{http://schema.webpdf.de/1.0/operation}HeaderFooterPositionsType" minOccurs="0"/>
         <element name="footer" type="{http://schema.webpdf.de/1.0/operation}HeaderFooterPositionsType" minOccurs="0"/>
         <element name="date" type="{http://schema.webpdf.de/1.0/operation}HeaderFooterDate" minOccurs="0"/>
       </all>
       <attribute name="firstPageNumber" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="replaceExisting" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HeaderFooterType.Pages	Java class for anonymous complex type

Field Summary

Fields

Modifier and Type	Field	Description
protected HeaderFooterDate	date
protected Integer	firstPageNumber	<?
protected OptionsFontType	font
protected HeaderFooterPositionsType	footer
protected HeaderFooterPositionsType	header
protected OptionsMarginType	margin
protected HeaderFooterType.Pages	pages	<?
protected Boolean	replaceExisting	<?

Constructor Summary

Constructors

Constructor	Description
HeaderFooterType()

Method Summary

Modifier and Type	Method	Description
HeaderFooterDate	getDate()	Gets the value of the date property.
int	getFirstPageNumber()	<?
OptionsFontType	getFont()	Gets the value of the font property.
HeaderFooterPositionsType	getFooter()	Gets the value of the footer property.
HeaderFooterPositionsType	getHeader()	Gets the value of the header property.
OptionsMarginType	getMargin()	Gets the value of the margin property.
HeaderFooterType.Pages	getPages()	<?
boolean	isReplaceExisting()	<?
boolean	isSetDate()
boolean	isSetFirstPageNumber()
boolean	isSetFont()
boolean	isSetFooter()
boolean	isSetHeader()
boolean	isSetMargin()
boolean	isSetPages()
boolean	isSetReplaceExisting()
void	setDate(HeaderFooterDate value)	Sets the value of the date property.
void	setFirstPageNumber(int value)	Sets the value of the firstPageNumber property.
void	setFont(OptionsFontType value)	Sets the value of the font property.
void	setFooter(HeaderFooterPositionsType value)	Sets the value of the footer property.
void	setHeader(HeaderFooterPositionsType value)	Sets the value of the header property.
void	setMargin(OptionsMarginType value)	Sets the value of the margin property.
void	setPages(HeaderFooterType.Pages value)	Sets the value of the pages property.
void	setReplaceExisting(boolean value)	Sets the value of the replaceExisting property.
void	unsetFirstPageNumber()
void	unsetReplaceExisting()

Methods inherited from class java.lang.Object

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

Field Detail

pages

protected HeaderFooterType.Pages pages

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the pages, to which header/footer elements shall be applied.</p>
 

margin

protected OptionsMarginType margin

font

protected OptionsFontType font

header

protected HeaderFooterPositionsType header

footer

protected HeaderFooterPositionsType footer

date

protected HeaderFooterDate date

firstPageNumber

protected Integer firstPageNumber

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the starting page for page number formats.</p>
 

replaceExisting

protected Boolean replaceExisting

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, preexisting header and footer definition will be automatically deleted from all pages of the document and replaced with the new one. If false, preexisting header and footer definitions on any page of the document will cause the operation to be aborted.</p>
 

Constructor Detail

HeaderFooterType

public HeaderFooterType()

Method Detail

getPages

public HeaderFooterType.Pages getPages()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the pages, to which header/footer elements shall be applied.</p>
 

Returns:

possible object is HeaderFooterType.Pages

setPages

public void setPages(HeaderFooterType.Pages value)

Sets the value of the pages property.

Parameters:

value - allowed object is HeaderFooterType.Pages

See Also:

getPages()

isSetPages

public boolean isSetPages()

getMargin

public OptionsMarginType getMargin()

Gets the value of the margin property.

Returns:

possible object is OptionsMarginType

setMargin

public void setMargin(OptionsMarginType value)

Sets the value of the margin property.

Parameters:

value - allowed object is OptionsMarginType

isSetMargin

public boolean isSetMargin()

getFont

public OptionsFontType getFont()

Gets the value of the font property.

Returns:

possible object is OptionsFontType

setFont

public void setFont(OptionsFontType value)

Sets the value of the font property.

Parameters:

value - allowed object is OptionsFontType

isSetFont

public boolean isSetFont()

getHeader

public HeaderFooterPositionsType getHeader()

Gets the value of the header property.

Returns:

possible object is HeaderFooterPositionsType

setHeader

public void setHeader(HeaderFooterPositionsType value)

Sets the value of the header property.

Parameters:

value - allowed object is HeaderFooterPositionsType

isSetHeader

public boolean isSetHeader()

getFooter

public HeaderFooterPositionsType getFooter()

Gets the value of the footer property.

Returns:

possible object is HeaderFooterPositionsType

setFooter

public void setFooter(HeaderFooterPositionsType value)

Sets the value of the footer property.

Parameters:

value - allowed object is HeaderFooterPositionsType

isSetFooter

public boolean isSetFooter()

getDate

public HeaderFooterDate getDate()

Gets the value of the date property.

Returns:

possible object is HeaderFooterDate

setDate

public void setDate(HeaderFooterDate value)

Sets the value of the date property.

Parameters:

value - allowed object is HeaderFooterDate

isSetDate

public boolean isSetDate()

getFirstPageNumber

public int getFirstPageNumber()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the starting page for page number formats.</p>
 

Returns:

possible object is Integer

setFirstPageNumber

public void setFirstPageNumber(int value)

Sets the value of the firstPageNumber property.

Parameters:

value - allowed object is Integer

See Also:

getFirstPageNumber()

isSetFirstPageNumber

public boolean isSetFirstPageNumber()

unsetFirstPageNumber

public void unsetFirstPageNumber()

isReplaceExisting

public boolean isReplaceExisting()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p112675_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p263167_="https://jakarta.ee/xml/ns/jaxb" xmlns:p878401_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, preexisting header and footer definition will be automatically deleted from all pages of the document and replaced with the new one. If false, preexisting header and footer definitions on any page of the document will cause the operation to be aborted.</p>
 

Returns:

possible object is Boolean

setReplaceExisting

public void setReplaceExisting(boolean value)

Sets the value of the replaceExisting property.

Parameters:

value - allowed object is Boolean

See Also:

isReplaceExisting()

isSetReplaceExisting

public boolean isSetReplaceExisting()

unsetReplaceExisting

public void unsetReplaceExisting()