Package net.webpdf.wsclient.schema.operation

Class FileAnnotationType

java.lang.Object

net.webpdf.wsclient.schema.operation.FileAnnotationType

public class FileAnnotationType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the annotation element that should be linked to the file attachment.
                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                     If an "annotation element" is not defined for the "file element," the attachment will be stored at the document level.
                 </p>
 

Java class for FileAnnotationType complex type

.

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

 <complexType name="FileAnnotationType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="point" type="{http://schema.webpdf.de/1.0/operation}PointType"/>
       </all>
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}fileAnnotationGroup"/>
       <attribute name="opacity" type="{http://schema.webpdf.de/1.0/operation}OpacityType" default="100" />
       <attribute name="color" type="{http://schema.webpdf.de/1.0/operation}RgbColorType" default="#4800FF" />
       <attribute name="width" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="height" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}float">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	color	<?
protected Float	height	<?
protected IconsType	icon	<?
protected Boolean	lockedPosition	<?
protected Integer	opacity	<?
protected Integer	page	<?
protected PointType	point
protected String	popupText	<?
protected Float	width	<?

Constructor Summary

Constructors

Constructor	Description
FileAnnotationType()

Method Summary

Modifier and Type	Method	Description
String	getColor()	<?
float	getHeight()	<?
IconsType	getIcon()	<?
int	getOpacity()	<?
int	getPage()	<?
PointType	getPoint()	Gets the value of the point property.
String	getPopupText()	<?
float	getWidth()	<?
boolean	isLockedPosition()	<?
boolean	isSetColor()
boolean	isSetHeight()
boolean	isSetIcon()
boolean	isSetLockedPosition()
boolean	isSetOpacity()
boolean	isSetPage()
boolean	isSetPoint()
boolean	isSetPopupText()
boolean	isSetWidth()
void	setColor(String value)	Sets the value of the color property.
void	setHeight(float value)	Sets the value of the height property.
void	setIcon(IconsType value)	Sets the value of the icon property.
void	setLockedPosition(boolean value)	Sets the value of the lockedPosition property.
void	setOpacity(int value)	Sets the value of the opacity property.
void	setPage(int value)	Sets the value of the page property.
void	setPoint(PointType value)	Sets the value of the point property.
void	setPopupText(String value)	Sets the value of the popupText property.
void	setWidth(float value)	Sets the value of the width property.
void	unsetHeight()
void	unsetLockedPosition()
void	unsetOpacity()
void	unsetPage()
void	unsetWidth()

Methods inherited from class java.lang.Object

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

Field Detail

point

protected PointType point

opacity

protected Integer opacity

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the opacity for the attachment's icon. A percent value between 0 and 100 is allowed, whereby 0 equals the minimum opacity. The higher the value, the more the content of the PDF document will be covered over.</p>
 

color

protected String color

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation colour will change the main colour of the attachment's icon. The colour needs to be specified as a hexadecimal RGB value with a number sign before it.</p>
 

width

protected Float width

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is positive, the annotation will be generated with a fixed width corresponding to the value instead of using the dimensions of the specified icon.</p>
 

height

protected Float height

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is positive, the annotation will be generated with a fixed height corresponding to the value instead of using the dimensions of the specified icon.</p>
 

page

protected Integer page

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page on which the annotation will be generated, i.e., the page where the attachment will be stored.</p>
 

lockedPosition

protected Boolean lockedPosition

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the person viewing the document will not be allowed to move the icon for the file attached at the page level.</p>
 

popupText

protected String popupText

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The text that should be displayed in the pop-up for the annotation.</p>
 

icon

protected IconsType icon

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If an attachment is embedded at the page level, this option can be used to specify the icon that should be used to show it:</p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The value you use here will define which icon will be used, as well as the basic dimensions for the annotation generated in the PDF.
                         If you use the "None" icon type, a predefined icon will not be used. Instead, this option will only use the dimensions specified in "width" and "height" to generate an annotation with a transparent selection box at the specified position.
                         <ul><li>graph = Diagram</li><li>paperclip = Paper clip</li><li>pushPin = Thumb tack</li><li>tag = Tag</li><li>none = Rectangular selection box</li></ul></p>
 

Constructor Detail

FileAnnotationType

public FileAnnotationType()

Method Detail

getPoint

public PointType getPoint()

Gets the value of the point property.

Returns:

possible object is PointType

setPoint

public void setPoint(PointType value)

Sets the value of the point property.

Parameters:

value - allowed object is PointType

isSetPoint

public boolean isSetPoint()

getOpacity

public int getOpacity()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the opacity for the attachment's icon. A percent value between 0 and 100 is allowed, whereby 0 equals the minimum opacity. The higher the value, the more the content of the PDF document will be covered over.</p>
 

Returns:

possible object is Integer

setOpacity

public void setOpacity(int value)

Sets the value of the opacity property.

Parameters:

value - allowed object is Integer

See Also:

getOpacity()

isSetOpacity

public boolean isSetOpacity()

unsetOpacity

public void unsetOpacity()

getColor

public String getColor()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The annotation colour will change the main colour of the attachment's icon. The colour needs to be specified as a hexadecimal RGB value with a number sign before it.</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()

getWidth

public float getWidth()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is positive, the annotation will be generated with a fixed width corresponding to the value instead of using the dimensions of the specified icon.</p>
 

Returns:

possible object is Float

setWidth

public void setWidth(float value)

Sets the value of the width property.

Parameters:

value - allowed object is Float

See Also:

getWidth()

isSetWidth

public boolean isSetWidth()

unsetWidth

public void unsetWidth()

getHeight

public float getHeight()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is positive, the annotation will be generated with a fixed height corresponding to the value instead of using the dimensions of the specified icon.</p>
 

Returns:

possible object is Float

setHeight

public void setHeight(float value)

Sets the value of the height property.

Parameters:

value - allowed object is Float

See Also:

getHeight()

isSetHeight

public boolean isSetHeight()

unsetHeight

public void unsetHeight()

getPage

public int getPage()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page on which the annotation will be generated, i.e., the page where the attachment will be stored.</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()

isLockedPosition

public boolean isLockedPosition()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", the person viewing the document will not be allowed to move the icon for the file attached at the page level.</p>
 

Returns:

possible object is Boolean

setLockedPosition

public void setLockedPosition(boolean value)

Sets the value of the lockedPosition property.

Parameters:

value - allowed object is Boolean

See Also:

isLockedPosition()

isSetLockedPosition

public boolean isSetLockedPosition()

unsetLockedPosition

public void unsetLockedPosition()

getPopupText

public String getPopupText()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The text that should be displayed in the pop-up for the annotation.</p>
 

Returns:

possible object is String

setPopupText

public void setPopupText(String value)

Sets the value of the popupText property.

Parameters:

value - allowed object is String

See Also:

getPopupText()

isSetPopupText

public boolean isSetPopupText()

getIcon

public IconsType getIcon()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If an attachment is embedded at the page level, this option can be used to specify the icon that should be used to show it:</p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p338479_="https://jakarta.ee/xml/ns/jaxb" xmlns:p733184_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The value you use here will define which icon will be used, as well as the basic dimensions for the annotation generated in the PDF.
                         If you use the "None" icon type, a predefined icon will not be used. Instead, this option will only use the dimensions specified in "width" and "height" to generate an annotation with a transparent selection box at the specified position.
                         <ul><li>graph = Diagram</li><li>paperclip = Paper clip</li><li>pushPin = Thumb tack</li><li>tag = Tag</li><li>none = Rectangular selection box</li></ul></p>
 

Returns:

possible object is IconsType

setIcon

public void setIcon(IconsType value)

Sets the value of the icon property.

Parameters:

value - allowed object is IconsType

See Also:

getIcon()

isSetIcon

public boolean isSetIcon()