Package net.webpdf.wsclient.schema.operation

Class ConverterFooterType

java.lang.Object

net.webpdf.wsclient.schema.operation.ConverterFooterType

All Implemented Interfaces:

FileDataType<byte[]>

public class ConverterFooterType
extends Object
implements FileDataType<byte[]>

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the content that will be used as a footer. The content is passed in BASE64 encoded and contains
                     HTML and (embedded) CSS code to position and format the footer.
                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The footer can contain the variables <code>${html.pageNumber}</code> (page number), <code>${html.totalPages}</code> (total number of pages)
                     and <code>${html.title}</code> (HTML head meta tag <code>&lt;title&gt;</code>).
                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>The footer is not used for all file format conversions. The footer is not supported for file formats that
                     already contain their own footer definition, such as Office formats. The footer defined here works only for HTML-based
                     formats such as HTML files, emails, or template-based conversions (e.g. text formats).
                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Example:</p>
 

 <?xml version="1.0" encoding="UTF-8"?><pre xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema" class="language-html">
                     
 &lt;p&gt;
   &lt;span style="font-size: 12px"&gt;Page ${html.pageNumber} of ${html.totalPages} pages&lt;/span&gt;
 &lt;/p&gt;
 
                 </pre>
 

Java class for ConverterFooterType complex type

.

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

 <complexType name="ConverterFooterType">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>base64Binary">
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}FileDataGroup"/>
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected FileDataSourceType	source	<?
protected String	uri	<?
protected byte[]	value

Constructor Summary

Constructors

Constructor	Description
ConverterFooterType()

Method Summary

Modifier and Type	Method	Description
FileDataSourceType	getSource()	<?
String	getUri()	<?
byte[]	getValue()	Gets the value of the value property.
boolean	isSetSource()	Returns true, if a file data source has been set.
boolean	isSetUri()	Returns true, if a file source URI has been set.
boolean	isSetValue()	Returns true, if a direct byte value has been set.
void	setSource(FileDataSourceType value)	Sets the value of the source property.
void	setUri(String value)	Sets the value of the uri property.
void	setValue(byte[] value)	Sets the value of the value property.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected byte[] value

source

protected FileDataSourceType source

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the data source for the hereby expressed resource.
                         Possible values are:
                         <ul><li>value = The element's value shall contain the BASE64 encoded data.</li><li>uri = The data shall be located at the given uri.</li></ul></p>
 

uri

protected String uri

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The uri the data shall be located at. (This shall only have effect, if the "source" is "uri".)</p>
 

Constructor Detail

ConverterFooterType

public ConverterFooterType()

Method Detail

getValue

public byte[] getValue()

Gets the value of the value property.

Specified by:

getValue in interface FileDataType<byte[]>

Returns:

possible object is byte[]

setValue

public void setValue(byte[] value)

Sets the value of the value property.

Specified by:

setValue in interface FileDataType<byte[]>

Parameters:

value - allowed object is byte[]

isSetValue

public boolean isSetValue()

Description copied from interface: FileDataType

Returns true, if a direct byte value has been set.

Specified by:

isSetValue in interface FileDataType<byte[]>

Returns:

true, if a direct byte value has been set.

getSource

public FileDataSourceType getSource()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the data source for the hereby expressed resource.
                         Possible values are:
                         <ul><li>value = The element's value shall contain the BASE64 encoded data.</li><li>uri = The data shall be located at the given uri.</li></ul></p>
 

Specified by:

getSource in interface FileDataType<byte[]>

Returns:

possible object is FileDataSourceType

setSource

public void setSource(FileDataSourceType value)

Sets the value of the source property.

Specified by:

setSource in interface FileDataType<byte[]>

Parameters:

value - allowed object is FileDataSourceType

See Also:

getSource()

isSetSource

public boolean isSetSource()

Description copied from interface: FileDataType

Returns true, if a file data source has been set.

Specified by:

isSetSource in interface FileDataType<byte[]>

Returns:

true, if a file data source has been set.

getUri

public String getUri()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The uri the data shall be located at. (This shall only have effect, if the "source" is "uri".)</p>
 

Specified by:

getUri in interface FileDataType<byte[]>

Returns:

possible object is String

setUri

public void setUri(String value)

Sets the value of the uri property.

Specified by:

setUri in interface FileDataType<byte[]>

Parameters:

value - allowed object is String

See Also:

getUri()

isSetUri

public boolean isSetUri()

Description copied from interface: FileDataType

Returns true, if a file source URI has been set.

Specified by:

isSetUri in interface FileDataType<byte[]>

Returns:

true, if a file source URI has been set.