Package net.webpdf.wsclient.openapi

Class OperationConverterFooter

java.lang.Object

net.webpdf.wsclient.openapi.OperationConverterFooter

public class OperationConverterFooter
extends Object

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. The footer can contain the variables `${html.pageNumber}` (page number), `${html.totalPages}` (total number of pages) and `${html.title}` (HTML head meta tag `<title>`). **Important:**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). Example: ```html <p> <span style=\"font-size: 12px\">Page ${html.pageNumber} of ${html.totalPages} pages</span> </p> ```

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationConverterFooter.SourceEnum	Selects the data source for the hereby expressed resource.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_SOURCE
static String	JSON_PROPERTY_URI
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
OperationConverterFooter()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable OperationConverterFooter.SourceEnum	getSource()	Selects the data source for the hereby expressed resource.
@Nullable String	getUri()	The uri the data shall be located at.
@org.jetbrains.annotations.Nullable byte[]	getValue()	Get value
int	hashCode()
void	setSource(OperationConverterFooter.SourceEnum source)
void	setUri(String uri)
void	setValue(byte[] value)
OperationConverterFooter	source(OperationConverterFooter.SourceEnum source)
String	toString()
OperationConverterFooter	uri(String uri)
OperationConverterFooter	value(byte[] value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_SOURCE

public static final String JSON_PROPERTY_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_URI

public static final String JSON_PROPERTY_URI

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

OperationConverterFooter

public OperationConverterFooter()

Method Detail

source

public OperationConverterFooter source(OperationConverterFooter.SourceEnum source)

getSource

@Nullable
public @Nullable OperationConverterFooter.SourceEnum getSource()

Selects the data source for the hereby expressed resource. Possible values are: * value = The element's value shall contain the BASE64 encoded data. * uri = The data shall be located at the given uri.

Returns:

source

setSource

public void setSource(OperationConverterFooter.SourceEnum source)

uri

public OperationConverterFooter uri(String uri)

getUri

@Nullable
public @Nullable String getUri()

The uri the data shall be located at. (This shall only have effect, if the \"source\" is \"uri\".)

Returns:

uri

setUri

public void setUri(String uri)

value

public OperationConverterFooter value(byte[] value)

getValue

@Nullable
public @org.jetbrains.annotations.Nullable byte[] getValue()

Get value

Returns:

value

setValue

public void setValue(byte[] value)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object