Package net.webpdf.wsclient.schema.operation

Class WatermarkPositionType

java.lang.Object

net.webpdf.wsclient.schema.operation.WatermarkPositionType

public class WatermarkPositionType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the position of the watermark in the PDF document.</p>
 

Java class for WatermarkPositionType complex type

.

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

 <complexType name="WatermarkPositionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="x" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="y" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="width" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="height" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="position" type="{http://schema.webpdf.de/1.0/operation}WatermarkPositionModeType" default="center_center" />
       <attribute name="aspectRatio" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="metrics" type="{http://schema.webpdf.de/1.0/operation}MetricsType" default="mm" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	aspectRatio	<?
protected Integer	height	<?
protected MetricsType	metrics	<?
protected WatermarkPositionModeType	position	<?
protected Integer	width	<?
protected Integer	x	<?
protected Integer	y	<?

Constructor Summary

Constructors

Constructor	Description
WatermarkPositionType()

Method Summary

Modifier and Type	Method	Description
int	getHeight()	<?
MetricsType	getMetrics()	<?
WatermarkPositionModeType	getPosition()	<?
int	getWidth()	<?
int	getX()	<?
int	getY()	<?
boolean	isAspectRatio()	<?
boolean	isSetAspectRatio()
boolean	isSetHeight()
boolean	isSetMetrics()
boolean	isSetPosition()
boolean	isSetWidth()
boolean	isSetX()
boolean	isSetY()
void	setAspectRatio(boolean value)	Sets the value of the aspectRatio property.
void	setHeight(int value)	Sets the value of the height property.
void	setMetrics(MetricsType value)	Sets the value of the metrics property.
void	setPosition(WatermarkPositionModeType value)	Sets the value of the position property.
void	setWidth(int value)	Sets the value of the width property.
void	setX(int value)	Sets the value of the x property.
void	setY(int value)	Sets the value of the y property.
void	unsetAspectRatio()
void	unsetHeight()
void	unsetWidth()
void	unsetX()
void	unsetY()

Methods inherited from class java.lang.Object

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

Field Detail

x

protected Integer x

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the X-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to "custom.". If "position is set to a different value, these arguments will be interpreted as "offsets" from the selected position. This specification applies for both the text and image output.</p>
 

y

protected Integer y

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the Y-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to "custom.". If "position is set to a different value, these arguments will be interpreted as "offsets" from the selected position. This specification applies for both the text and image output.</p>
 

width

protected Integer width

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Forces the specified width for the watermark if the values are not equal 0. In this case, the watermark will be scaled inside the area, which may result in the image losing quality or being distorted (please refer to "aspectRatio" as well)</p>
 

height

protected Integer height

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Forces the specified height for the watermark if the values are not equal 0. In this case, the watermark will be scaled inside the area, which may result in the image losing quality or being distorted (please refer to "aspectRatio" as well)</p>
 

position

protected WatermarkPositionModeType position

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Uses one of multiple preset positions in order to position the watermark on the page.
                         <ul><li>custom = Disable the use of a preset position.</li><li>top_left = Positions the watermark in the top left corner.</li><li>top_center = Positions the watermark in the centre at the top margin.</li><li>top_right = Positions the watermark in the top right corner.</li><li>center_left = Positions the watermark at the centre of the page, to the left.</li><li>center_center = Positions the watermark at the centre of the page.</li><li>center_right = Positions the watermark at the centre of the page, to the right.</li><li>bottom_left = Positions the watermark in the bottom left corner.</li><li>bottom_center = Positions the watermark in the centre at the bottom margin.</li><li>bottom_right = Positions the watermark in the bottom right corner.</li></ul></p>
 

aspectRatio

protected Boolean aspectRatio

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Forces the aspect ratio to be maintained when a watermark is scaled if "width" and "height" are specified.</p>
 

metrics

protected MetricsType metrics

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the unit in which the maximum dimensions are specified.
                         <ul><li>pt = Points(1/72 inch)</li><li>pc = Picas(12 points)</li><li>px = Pixels(1/96 inch)</li><li>mm = Millimeters</li><li>in = Inches</li></ul></p>
 

Constructor Detail

WatermarkPositionType

public WatermarkPositionType()

Method Detail

getX

public int getX()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the X-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to "custom.". If "position is set to a different value, these arguments will be interpreted as "offsets" from the selected position. This specification applies for both the text and image output.</p>
 

Returns:

possible object is Integer

setX

public void setX(int value)

Sets the value of the x property.

Parameters:

value - allowed object is Integer

See Also:

getX()

isSetX

public boolean isSetX()

unsetX

public void unsetX()

getY

public int getY()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the Y-axis position (as per metrics), starting from the top left corner of the PDF document, if position is set to "custom.". If "position is set to a different value, these arguments will be interpreted as "offsets" from the selected position. This specification applies for both the text and image output.</p>
 

Returns:

possible object is Integer

setY

public void setY(int value)

Sets the value of the y property.

Parameters:

value - allowed object is Integer

See Also:

getY()

isSetY

public boolean isSetY()

unsetY

public void unsetY()

getWidth

public int getWidth()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Forces the specified width for the watermark if the values are not equal 0. In this case, the watermark will be scaled inside the area, which may result in the image losing quality or being distorted (please refer to "aspectRatio" as well)</p>
 

Returns:

possible object is Integer

setWidth

public void setWidth(int value)

Sets the value of the width property.

Parameters:

value - allowed object is Integer

See Also:

getWidth()

isSetWidth

public boolean isSetWidth()

unsetWidth

public void unsetWidth()

getHeight

public int getHeight()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Forces the specified height for the watermark if the values are not equal 0. In this case, the watermark will be scaled inside the area, which may result in the image losing quality or being distorted (please refer to "aspectRatio" as well)</p>
 

Returns:

possible object is Integer

setHeight

public void setHeight(int value)

Sets the value of the height property.

Parameters:

value - allowed object is Integer

See Also:

getHeight()

isSetHeight

public boolean isSetHeight()

unsetHeight

public void unsetHeight()

getPosition

public WatermarkPositionModeType getPosition()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Uses one of multiple preset positions in order to position the watermark on the page.
                         <ul><li>custom = Disable the use of a preset position.</li><li>top_left = Positions the watermark in the top left corner.</li><li>top_center = Positions the watermark in the centre at the top margin.</li><li>top_right = Positions the watermark in the top right corner.</li><li>center_left = Positions the watermark at the centre of the page, to the left.</li><li>center_center = Positions the watermark at the centre of the page.</li><li>center_right = Positions the watermark at the centre of the page, to the right.</li><li>bottom_left = Positions the watermark in the bottom left corner.</li><li>bottom_center = Positions the watermark in the centre at the bottom margin.</li><li>bottom_right = Positions the watermark in the bottom right corner.</li></ul></p>
 

Returns:

possible object is WatermarkPositionModeType

setPosition

public void setPosition(WatermarkPositionModeType value)

Sets the value of the position property.

Parameters:

value - allowed object is WatermarkPositionModeType

See Also:

getPosition()

isSetPosition

public boolean isSetPosition()

isAspectRatio

public boolean isAspectRatio()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Forces the aspect ratio to be maintained when a watermark is scaled if "width" and "height" are specified.</p>
 

Returns:

possible object is Boolean

setAspectRatio

public void setAspectRatio(boolean value)

Sets the value of the aspectRatio property.

Parameters:

value - allowed object is Boolean

See Also:

isAspectRatio()

isSetAspectRatio

public boolean isSetAspectRatio()

unsetAspectRatio

public void unsetAspectRatio()

getMetrics

public MetricsType getMetrics()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p463494_="https://jakarta.ee/xml/ns/jaxb" xmlns:p758801_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the unit in which the maximum dimensions are specified.
                         <ul><li>pt = Points(1/72 inch)</li><li>pc = Picas(12 points)</li><li>px = Pixels(1/96 inch)</li><li>mm = Millimeters</li><li>in = Inches</li></ul></p>
 

Returns:

possible object is MetricsType

setMetrics

public void setMetrics(MetricsType value)

Sets the value of the metrics property.

Parameters:

value - allowed object is MetricsType

See Also:

getMetrics()

isSetMetrics

public boolean isSetMetrics()