Package net.webpdf.wsclient.schema.operation

Class TextAnnotationType

java.lang.Object

net.webpdf.wsclient.schema.operation.BaseAnnotationType

net.webpdf.wsclient.schema.operation.TextAnnotationType

public class TextAnnotationType
extends BaseAnnotationType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">An annotation that adds a note icon to a page.</p>
 

Java class for TextAnnotationType complex type

.

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

 <complexType name="TextAnnotationType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseAnnotationType">
       <all>
         <element name="position" type="{http://schema.webpdf.de/1.0/operation}RectangleType" minOccurs="0"/>
         <element name="normalAppearance" type="{http://schema.webpdf.de/1.0/operation}AppearanceSourceType" minOccurs="0"/>
       </all>
       <attribute name="icon" type="{http://schema.webpdf.de/1.0/operation}TextAnnotationIconsType" default="note" />
       <attribute name="initialOpen" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="appearanceGeneration" type="{http://schema.webpdf.de/1.0/operation}AppearanceGenerationType" default="nonStandard" />
       <attribute name="customIconName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected AppearanceGenerationType	appearanceGeneration	<?
protected String	customIconName	<?
protected TextAnnotationIconsType	icon	<?
protected Boolean	initialOpen	<?
protected AppearanceSourceType	normalAppearance	<?
protected RectangleType	position	<?

Fields inherited from class net.webpdf.wsclient.schema.operation.BaseAnnotationType

color, contents, creator, hidden, intents, invisible, locked, name, opacity, page, printable, rotatable, subject, viewable, writable, zoomable

Constructor Summary

Constructors

Constructor	Description
TextAnnotationType()

Method Summary

Modifier and Type	Method	Description
AppearanceGenerationType	getAppearanceGeneration()	<?
String	getCustomIconName()	<?
TextAnnotationIconsType	getIcon()	<?
AppearanceSourceType	getNormalAppearance()	<?
RectangleType	getPosition()	<?
boolean	isInitialOpen()	<?
boolean	isSetAppearanceGeneration()
boolean	isSetCustomIconName()
boolean	isSetIcon()
boolean	isSetInitialOpen()
boolean	isSetNormalAppearance()
boolean	isSetPosition()
void	setAppearanceGeneration(AppearanceGenerationType value)	Sets the value of the appearanceGeneration property.
void	setCustomIconName(String value)	Sets the value of the customIconName property.
void	setIcon(TextAnnotationIconsType value)	Sets the value of the icon property.
void	setInitialOpen(boolean value)	Sets the value of the initialOpen property.
void	setNormalAppearance(AppearanceSourceType value)	Sets the value of the normalAppearance property.
void	setPosition(RectangleType value)	Sets the value of the position property.
void	unsetInitialOpen()

Methods inherited from class net.webpdf.wsclient.schema.operation.BaseAnnotationType

getColor, getContents, getCreator, getIntents, getName, getOpacity, getPage, getSubject, isHidden, isInvisible, isLocked, isPrintable, isRotatable, isSetColor, isSetContents, isSetCreator, isSetHidden, isSetIntents, isSetInvisible, isSetLocked, isSetName, isSetOpacity, isSetPage, isSetPrintable, isSetRotatable, isSetSubject, isSetViewable, isSetWritable, isSetZoomable, isViewable, isWritable, isZoomable, setColor, setContents, setCreator, setHidden, setIntents, setInvisible, setLocked, setName, setOpacity, setPage, setPrintable, setRotatable, setSubject, setViewable, setWritable, setZoomable, unsetHidden, unsetInvisible, unsetLocked, unsetOpacity, unsetPage, unsetPrintable, unsetRotatable, unsetViewable, unsetWritable, unsetZoomable

Methods inherited from class java.lang.Object

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

Field Detail

position

protected RectangleType position

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to select the bounds within which the shape shall be positioned.</p>
 

normalAppearance

protected AppearanceSourceType normalAppearance

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the data source for the visible appearance of a customized text annotation.
 
                                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="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>
                                     If this element is present, this shall always take precedence for the appearance generation.
                                 </p>
 

icon

protected TextAnnotationIconsType icon

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the icon that should be displayed for the note on the page. The following values are available:
                                 <ul><li>check = The text annotation approves the content.</li><li>checkmark = The text annotation adds a gray checkmark to the content.</li><li>circle = The text annotation is a comment on the circled content.</li><li>comment = The text annotation is a comment to the marked contents.</li><li>cross = The text annotation marks the content or crosses it out.</li><li>crossHair = The text annotation targets the content in the crosshair.</li><li>insert = The text annotation is suggesting inserting some content.</li><li>key = The text annotation marks or contains a key content/information.</li><li>note = The text annotation is a mere note concerning the marked content.</li><li>help = The text annotation provides helpful information concerning the marked content.</li><li>newParagraph = The text annotation suggests adding a new Paragraph at a specific point.</li><li>paragraph = The text annotation is concerning the whole paragraph.</li><li>rightArrow = The text annotation is concerning the content to the right.</li><li>rightPointer = The text annotation is concerning the content to the right.</li><li>star = The text annotation marks content as especially important.</li><li>upArrow = The text annotation is concerning the content at the top.</li><li>upLeftArrow = The text annotation is concerning the content at the top left.</li></ul></p>
 

initialOpen

protected Boolean initialOpen

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" 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 popup for the corresponding "note" annotation will be opened as soon as the corresponding document page is viewed.</p>
 

appearanceGeneration

protected AppearanceGenerationType appearanceGeneration

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Determines for which named annotations appearance streams shall be generated.</p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="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>
                                 Per definition some named annotations are defined as standard names and PDF readers shall provide the means to draw those. For text annotations: comment, insert, key, note, help, newParagraph and paragraph are standard names.
                                 <ul><li>always = An appearance stream shall be prepared for all created named annotations.</li><li>never = Don't provide appearance streams and rely on PDF readers to dynamically generate a proper representation of named annotations.</li><li>nonStandard = Only provide appearance streams for non standard annotations.</li></ul></p>
 

customIconName

protected String customIconName

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets a custom icon name for this annotation.
 
                             </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="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>
                                 This name shall always take precedence over possibly set standard names. (icon)
                             </p>
 

Constructor Detail

TextAnnotationType

public TextAnnotationType()

Method Detail

getPosition

public RectangleType getPosition()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to select the bounds within which the shape shall be positioned.</p>
 

Returns:

possible object is RectangleType

setPosition

public void setPosition(RectangleType value)

Sets the value of the position property.

Parameters:

value - allowed object is RectangleType

See Also:

getPosition()

isSetPosition

public boolean isSetPosition()

getNormalAppearance

public AppearanceSourceType getNormalAppearance()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the data source for the visible appearance of a customized text annotation.
 
                                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="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>
                                     If this element is present, this shall always take precedence for the appearance generation.
                                 </p>
 

Returns:

possible object is AppearanceSourceType

setNormalAppearance

public void setNormalAppearance(AppearanceSourceType value)

Sets the value of the normalAppearance property.

Parameters:

value - allowed object is AppearanceSourceType

See Also:

getNormalAppearance()

isSetNormalAppearance

public boolean isSetNormalAppearance()

getIcon

public TextAnnotationIconsType getIcon()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify the icon that should be displayed for the note on the page. The following values are available:
                                 <ul><li>check = The text annotation approves the content.</li><li>checkmark = The text annotation adds a gray checkmark to the content.</li><li>circle = The text annotation is a comment on the circled content.</li><li>comment = The text annotation is a comment to the marked contents.</li><li>cross = The text annotation marks the content or crosses it out.</li><li>crossHair = The text annotation targets the content in the crosshair.</li><li>insert = The text annotation is suggesting inserting some content.</li><li>key = The text annotation marks or contains a key content/information.</li><li>note = The text annotation is a mere note concerning the marked content.</li><li>help = The text annotation provides helpful information concerning the marked content.</li><li>newParagraph = The text annotation suggests adding a new Paragraph at a specific point.</li><li>paragraph = The text annotation is concerning the whole paragraph.</li><li>rightArrow = The text annotation is concerning the content to the right.</li><li>rightPointer = The text annotation is concerning the content to the right.</li><li>star = The text annotation marks content as especially important.</li><li>upArrow = The text annotation is concerning the content at the top.</li><li>upLeftArrow = The text annotation is concerning the content at the top left.</li></ul></p>
 

Returns:

possible object is TextAnnotationIconsType

setIcon

public void setIcon(TextAnnotationIconsType value)

Sets the value of the icon property.

Parameters:

value - allowed object is TextAnnotationIconsType

See Also:

getIcon()

isSetIcon

public boolean isSetIcon()

isInitialOpen

public boolean isInitialOpen()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" 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 popup for the corresponding "note" annotation will be opened as soon as the corresponding document page is viewed.</p>
 

Returns:

possible object is Boolean

setInitialOpen

public void setInitialOpen(boolean value)

Sets the value of the initialOpen property.

Parameters:

value - allowed object is Boolean

See Also:

isInitialOpen()

isSetInitialOpen

public boolean isSetInitialOpen()

unsetInitialOpen

public void unsetInitialOpen()

getAppearanceGeneration

public AppearanceGenerationType getAppearanceGeneration()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Determines for which named annotations appearance streams shall be generated.</p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="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>
                                 Per definition some named annotations are defined as standard names and PDF readers shall provide the means to draw those. For text annotations: comment, insert, key, note, help, newParagraph and paragraph are standard names.
                                 <ul><li>always = An appearance stream shall be prepared for all created named annotations.</li><li>never = Don't provide appearance streams and rely on PDF readers to dynamically generate a proper representation of named annotations.</li><li>nonStandard = Only provide appearance streams for non standard annotations.</li></ul></p>
 

Returns:

possible object is AppearanceGenerationType

setAppearanceGeneration

public void setAppearanceGeneration(AppearanceGenerationType value)

Sets the value of the appearanceGeneration property.

Parameters:

value - allowed object is AppearanceGenerationType

See Also:

getAppearanceGeneration()

isSetAppearanceGeneration

public boolean isSetAppearanceGeneration()

getCustomIconName

public String getCustomIconName()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets a custom icon name for this annotation.
 
                             </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p120009_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p426570_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p903434_="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>
                                 This name shall always take precedence over possibly set standard names. (icon)
                             </p>
 

Returns:

possible object is String

setCustomIconName

public void setCustomIconName(String value)

Sets the value of the customIconName property.

Parameters:

value - allowed object is String

See Also:

getCustomIconName()

isSetCustomIconName

public boolean isSetCustomIconName()