java.lang.Object
- net.webpdf.wsclient.schema.operation.BaseToolboxType
- - net.webpdf.wsclient.schema.operation.AnnotationType

All Implemented Interfaces:: ParameterInterface

public class AnnotationType
extends BaseToolboxType

 <?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">The annotation operation can be used to remove, edit or add markup annotations of/to a document.</p>

Java class for AnnotationType complex type

.

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


 <complexType name="AnnotationType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
       <choice>
         <element name="add" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice maxOccurs="unbounded">
                   <element name="text" type="{http://schema.webpdf.de/1.0/operation}TextAnnotationType"/>
                   <element name="markup" type="{http://schema.webpdf.de/1.0/operation}MarkupAnnotationType"/>
                   <element name="redact" type="{http://schema.webpdf.de/1.0/operation}RedactAnnotationType"/>
                   <element name="freetext" type="{http://schema.webpdf.de/1.0/operation}FreeTextAnnotationType"/>
                   <element name="rubberstamp" type="{http://schema.webpdf.de/1.0/operation}RubberStampAnnotationType"/>
                   <element name="circle" type="{http://schema.webpdf.de/1.0/operation}CircleAnnotationType"/>
                   <element name="square" type="{http://schema.webpdf.de/1.0/operation}SquareAnnotationType"/>
                   <element name="line" type="{http://schema.webpdf.de/1.0/operation}LineAnnotationType"/>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="remove" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <all>
                   <element name="selection">
                     <complexType>
                       <complexContent>
                         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                           <choice maxOccurs="unbounded" minOccurs="0">
                             <element name="select" type="{http://schema.webpdf.de/1.0/operation}SelectionAnnotationType"/>
                           </choice>
                         </restriction>
                       </complexContent>
                     </complexType>
                   </element>
                 </all>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="edit" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <all>
                   <element name="selection">
                     <complexType>
                       <complexContent>
                         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                           <choice maxOccurs="unbounded" minOccurs="0">
                             <element name="select" type="{http://schema.webpdf.de/1.0/operation}SelectionAnnotationType"/>
                           </choice>
                         </restriction>
                       </complexContent>
                     </complexType>
                   </element>
                   <element name="text" type="{http://schema.webpdf.de/1.0/operation}TextAnnotationType" minOccurs="0"/>
                   <element name="markup" type="{http://schema.webpdf.de/1.0/operation}MarkupAnnotationType" minOccurs="0"/>
                   <element name="redact" type="{http://schema.webpdf.de/1.0/operation}RedactAnnotationType" minOccurs="0"/>
                   <element name="freetext" type="{http://schema.webpdf.de/1.0/operation}FreeTextAnnotationType" minOccurs="0"/>
                   <element name="rubberstamp" type="{http://schema.webpdf.de/1.0/operation}RubberStampAnnotationType" minOccurs="0"/>
                   <element name="circle" type="{http://schema.webpdf.de/1.0/operation}CircleAnnotationType" minOccurs="0"/>
                   <element name="square" type="{http://schema.webpdf.de/1.0/operation}SquareAnnotationType" minOccurs="0"/>
                   <element name="line" type="{http://schema.webpdf.de/1.0/operation}LineAnnotationType" minOccurs="0"/>
                 </all>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="clear" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="flatten" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="comment" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice minOccurs="0">
                   <element name="add">
                     <complexType>
                       <complexContent>
                         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                           <choice maxOccurs="unbounded">
                             <element name="replyTo" type="{http://schema.webpdf.de/1.0/operation}ReplyToAnnotationType"/>
                             <element name="changeAnnotationState" type="{http://schema.webpdf.de/1.0/operation}ReplyStateAnnotationType"/>
                             <element name="markAnnotation" type="{http://schema.webpdf.de/1.0/operation}MarkedStateAnnotationType"/>
                           </choice>
                         </restriction>
                       </complexContent>
                     </complexType>
                   </element>
                   <element name="edit">
                     <complexType>
                       <complexContent>
                         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                           <choice maxOccurs="unbounded">
                             <element name="replyTo" type="{http://schema.webpdf.de/1.0/operation}ReplyToAnnotationEditType"/>
                           </choice>
                         </restriction>
                       </complexContent>
                     </complexType>
                   </element>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </choice>
     </extension>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AnnotationType.Add`	Java class for anonymous complex type
`static class`	`AnnotationType.Clear`	Java class for anonymous complex type
`static class`	`AnnotationType.Comment`	Java class for anonymous complex type
`static class`	`AnnotationType.Edit`	Java class for anonymous complex type
`static class`	`AnnotationType.Remove`	Java class for anonymous complex type

Field Summary

Fields
Modifier and Type	Field	Description
`protected AnnotationType.Add`	`add`	<?
`protected AnnotationType.Clear`	`clear`	<?
`protected AnnotationType.Comment`	`comment`	<?
`protected AnnotationType.Edit`	`edit`	<?
`protected AnnotationType.Remove`	`remove`	<?

Constructor Summary

Constructors
Constructor Description

AnnotationType()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AnnotationType.Add`	`getAdd()`	<?
`AnnotationType.Clear`	`getClear()`	<?
`AnnotationType.Comment`	`getComment()`	<?
`AnnotationType.Edit`	`getEdit()`	<?
`AnnotationType.Remove`	`getRemove()`	<?
`boolean`	`isSetAdd()`
`boolean`	`isSetClear()`
`boolean`	`isSetComment()`
`boolean`	`isSetEdit()`
`boolean`	`isSetRemove()`
`void`	`setAdd(AnnotationType.Add value)`	Sets the value of the add property.
`void`	`setClear(AnnotationType.Clear value)`	Sets the value of the clear property.
`void`	`setComment(AnnotationType.Comment value)`	Sets the value of the comment property.
`void`	`setEdit(AnnotationType.Edit value)`	Sets the value of the edit property.
`void`	`setRemove(AnnotationType.Remove value)`	Sets the value of the remove property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

add

protected AnnotationType.Add add

 <?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">The add element can be used to define one or multiple annotations, that shall be added to the document.</p>

remove

protected AnnotationType.Remove remove

 <?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 annotations for removal.</p>

edit

protected AnnotationType.Edit edit

 <?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 change properties of selected, already existing annotations.</p>

clear

protected AnnotationType.Clear clear

 <?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 remove the annotations of the selected pages.</p>

comment

protected AnnotationType.Comment comment

 <?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 add/edit comment/replies to and of existing annotations.</p>

Constructor Detail
- AnnotationType
```
public AnnotationType()
```

Method Detail

getAdd

public AnnotationType.Add getAdd()

 <?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">The add element can be used to define one or multiple annotations, that shall be added to the document.</p>

Returns:: possible object is AnnotationType.Add

setAdd
```
public void setAdd(AnnotationType.Add value)
```
Sets the value of the add property.

Parameters:

value - allowed object is AnnotationType.Add

See Also:

getAdd()

isSetAdd
```
public boolean isSetAdd()
```

getRemove

public AnnotationType.Remove getRemove()

 <?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 annotations for removal.</p>

Returns:: possible object is AnnotationType.Remove

setRemove
```
public void setRemove(AnnotationType.Remove value)
```
Sets the value of the remove property.

Parameters:

value - allowed object is AnnotationType.Remove

See Also:

getRemove()

isSetRemove
```
public boolean isSetRemove()
```

getEdit

public AnnotationType.Edit getEdit()

 <?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 change properties of selected, already existing annotations.</p>

Returns:: possible object is AnnotationType.Edit

setEdit
```
public void setEdit(AnnotationType.Edit value)
```
Sets the value of the edit property.

Parameters:

value - allowed object is AnnotationType.Edit

See Also:

getEdit()

isSetEdit
```
public boolean isSetEdit()
```

getClear

public AnnotationType.Clear getClear()

 <?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 remove the annotations of the selected pages.</p>

Returns:: possible object is AnnotationType.Clear

setClear
```
public void setClear(AnnotationType.Clear value)
```
Sets the value of the clear property.

Parameters:

value - allowed object is AnnotationType.Clear

See Also:

getClear()

isSetClear
```
public boolean isSetClear()
```

getComment

public AnnotationType.Comment getComment()

 <?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 add/edit comment/replies to and of existing annotations.</p>

Returns:: possible object is AnnotationType.Comment

setComment
```
public void setComment(AnnotationType.Comment value)
```
Sets the value of the comment property.

Parameters:

value - allowed object is AnnotationType.Comment

See Also:

getComment()

isSetComment
```
public boolean isSetComment()
```

Class AnnotationType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

add

remove

edit

clear

comment

Constructor Detail

AnnotationType

Method Detail

getAdd

setAdd

isSetAdd

getRemove

setRemove

isSetRemove

getEdit

setEdit

isSetEdit

getClear

setClear

isSetClear

getComment

setComment

isSetComment