Package net.webpdf.wsclient.schema.operation

Class RubberStampAnnotationType

java.lang.Object

net.webpdf.wsclient.schema.operation.BaseAnnotationType

net.webpdf.wsclient.schema.operation.RubberStampAnnotationType

public class RubberStampAnnotationType
extends BaseAnnotationType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">An annotation that either uses an custom image or text as a stamp, or that adds a prepared "named" stamp to the page.</p>
 

Java class for RubberStampAnnotationType complex type

.

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

 <complexType name="RubberStampAnnotationType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseAnnotationType">
       <all>
         <element name="position" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice minOccurs="0">
                   <element name="rectangle" type="{http://schema.webpdf.de/1.0/operation}RectangleType"/>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <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}RubberStampIconType" default="draft" />
       <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>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubberStampAnnotationType.Position	Java class for anonymous complex type

Field Summary

Fields

Modifier and Type	Field	Description
protected AppearanceGenerationType	appearanceGeneration	<?
protected String	customIconName	<?
protected RubberStampIconType	icon	<?
protected AppearanceSourceType	normalAppearance	<?
protected RubberStampAnnotationType.Position	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
RubberStampAnnotationType()

Method Summary

Modifier and Type	Method	Description
AppearanceGenerationType	getAppearanceGeneration()	<?
String	getCustomIconName()	<?
RubberStampIconType	getIcon()	<?
AppearanceSourceType	getNormalAppearance()	<?
RubberStampAnnotationType.Position	getPosition()	<?
boolean	isSetAppearanceGeneration()
boolean	isSetCustomIconName()
boolean	isSetIcon()
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(RubberStampIconType value)	Sets the value of the icon property.
void	setNormalAppearance(AppearanceSourceType value)	Sets the value of the normalAppearance property.
void	setPosition(RubberStampAnnotationType.Position value)	Sets the value of the position property.

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 RubberStampAnnotationType.Position position

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 rubberstamp.
 
                                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 RubberStampIconType icon

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The known "named" icon types for rubberstamp annotations:
                                 <ul><li>approved = A stamp that marks the stamped context as approved.</li><li>experimental = A stamp that marks the stamped content to be an experimental state.</li><li>notApproved = A stamp that disapproves the stamped context.</li><li>asIs = A stamp that marks the content as is.</li><li>expired = A stamp that marks the contained information as no longer valid.</li><li>notForPublicRelease = A stamp that marks something as information for internal use only.</li><li>confidential = A stamp marking the page as confidential.</li><li>final = A stamp that indicates, that the current state of the document is final.</li><li>sold = A stamp that indicates the marked contents to be sold and no longer available.</li><li>departmental = A stamp that forbids information to be shared to recipient outside of a given department.</li><li>forComment = Marks the stamped context as a comment.</li><li>topSecret = Marks the stamped content not to be shared publicly.</li><li>draft = A stamp marking the content to be a draft and therefore a work in progress.</li><li>forPublicRelease = Marks the content for public sharing.</li></ul></p>
 

appearanceGeneration

protected AppearanceGenerationType appearanceGeneration

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 rubberstamp annotations: approved, experimental, notApproved, asIs, expired, notForPublicRelease, confidential, final, sold, departmental, forComment, topSecret, draft and forPublicRelease are standard names.
                             </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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

RubberStampAnnotationType

public RubberStampAnnotationType()

Method Detail

getPosition

public RubberStampAnnotationType.Position getPosition()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 RubberStampAnnotationType.Position

setPosition

public void setPosition(RubberStampAnnotationType.Position value)

Sets the value of the position property.

Parameters:

value - allowed object is RubberStampAnnotationType.Position

See Also:

getPosition()

isSetPosition

public boolean isSetPosition()

getNormalAppearance

public AppearanceSourceType getNormalAppearance()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 rubberstamp.
 
                                 </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 RubberStampIconType getIcon()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The known "named" icon types for rubberstamp annotations:
                                 <ul><li>approved = A stamp that marks the stamped context as approved.</li><li>experimental = A stamp that marks the stamped content to be an experimental state.</li><li>notApproved = A stamp that disapproves the stamped context.</li><li>asIs = A stamp that marks the content as is.</li><li>expired = A stamp that marks the contained information as no longer valid.</li><li>notForPublicRelease = A stamp that marks something as information for internal use only.</li><li>confidential = A stamp marking the page as confidential.</li><li>final = A stamp that indicates, that the current state of the document is final.</li><li>sold = A stamp that indicates the marked contents to be sold and no longer available.</li><li>departmental = A stamp that forbids information to be shared to recipient outside of a given department.</li><li>forComment = Marks the stamped context as a comment.</li><li>topSecret = Marks the stamped content not to be shared publicly.</li><li>draft = A stamp marking the content to be a draft and therefore a work in progress.</li><li>forPublicRelease = Marks the content for public sharing.</li></ul></p>
 

Returns:

possible object is RubberStampIconType

setIcon

public void setIcon(RubberStampIconType value)

Sets the value of the icon property.

Parameters:

value - allowed object is RubberStampIconType

See Also:

getIcon()

isSetIcon

public boolean isSetIcon()

getAppearanceGeneration

public AppearanceGenerationType getAppearanceGeneration()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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 rubberstamp annotations: approved, experimental, notApproved, asIs, expired, notForPublicRelease, confidential, final, sold, departmental, forComment, topSecret, draft and forPublicRelease are standard names.
                             </p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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:p478056_="https://jakarta.ee/xml/ns/jaxb" xmlns:p587657_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p878301_="urn:jaxb.jvnet.org:plugin:simplify" 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()