Package net.webpdf.parameter.schema.extraction.info

Class BackgroundContentType

java.lang.Object

net.webpdf.parameter.schema.extraction.info.BackgroundContentType

public class BackgroundContentType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">An element of this type defines a background for a page of the document.</p>
 

Java class for BackgroundContentType complex type

.

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

 <complexType name="BackgroundContentType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="pieceInfo" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="absoluteScaling" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
                 <attribute name="scale" default="1">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}float">
                       <minInclusive value="0"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="rotation" default="0">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}int">
                       <minInclusive value="0"/>
                       <maxInclusive value="360"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="opacity" default="1.0">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}float">
                       <minInclusive value="0"/>
                       <maxInclusive value="1"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="color" type="{http://schema.webpdf.de/1.0/extraction/info}RgbColorType" default="#FFFFFF" />
                 <attribute name="alignment" type="{http://schema.webpdf.de/1.0/extraction/info}Alignment" default="top_left" />
                 <attribute name="horizOffset" type="{http://www.w3.org/2001/XMLSchema}float" default="0.0" />
                 <attribute name="vertOffset" type="{http://www.w3.org/2001/XMLSchema}float" default="0.0" />
                 <attribute name="unit" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="bounds" type="{http://schema.webpdf.de/1.0/extraction/info}RectangleType"/>
       </sequence>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="page" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="onprint" default="true">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}boolean">
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="onscreen" default="true">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}boolean">
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="isImage" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackgroundContentType.PieceInfo	Java class for anonymous complex type

Field Summary

Fields

Modifier and Type	Field	Description
protected RectangleType	bounds	<?
protected Boolean	isImage	<?
protected String	objectKey	<?
protected Boolean	onprint	<?
protected Boolean	onscreen	<?
protected Integer	page	<?
protected BackgroundContentType.PieceInfo	pieceInfo	<?

Constructor Summary

Constructors

Constructor	Description
BackgroundContentType()

Method Summary

Modifier and Type	Method	Description
RectangleType	getBounds()	<?
String	getObjectKey()	<?
int	getPage()	<?
BackgroundContentType.PieceInfo	getPieceInfo()	<?
boolean	isIsImage()	<?
boolean	isOnprint()	<?
boolean	isOnscreen()	<?
void	setBounds(RectangleType value)	Sets the value of the bounds property.
void	setIsImage(Boolean value)	Sets the value of the isImage property.
void	setObjectKey(String value)	Sets the value of the objectKey property.
void	setOnprint(Boolean value)	Sets the value of the onprint property.
void	setOnscreen(Boolean value)	Sets the value of the onscreen property.
void	setPage(Integer value)	Sets the value of the page property.
void	setPieceInfo(BackgroundContentType.PieceInfo value)	Sets the value of the pieceInfo property.

Methods inherited from class java.lang.Object

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

Field Detail

pieceInfo

protected BackgroundContentType.PieceInfo pieceInfo

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Properties listed in the Adobe piece info.</p>
 

bounds

protected RectangleType bounds

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The bounding box of the background.</p>
 

objectKey

protected String objectKey

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the background.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
 

page

protected Integer page

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The page the background shall be set for.</p>
 

onprint

protected Boolean onprint

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Whether the background shall be visible in printouts of the document.</p>
 

onscreen

protected Boolean onscreen

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Whether the background shall be visible in Readers.</p>
 

isImage

protected Boolean isImage

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to true, the background is using an image resource. (Otherwise it is unicolor)</p>
 

Constructor Detail

BackgroundContentType

public BackgroundContentType()

Method Detail

getPieceInfo

public BackgroundContentType.PieceInfo getPieceInfo()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Properties listed in the Adobe piece info.</p>
 

Returns:

possible object is BackgroundContentType.PieceInfo

setPieceInfo

public void setPieceInfo(BackgroundContentType.PieceInfo value)

Sets the value of the pieceInfo property.

Parameters:

value - allowed object is BackgroundContentType.PieceInfo

See Also:

getPieceInfo()

getBounds

public RectangleType getBounds()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The bounding box of the background.</p>
 

Returns:

possible object is RectangleType

setBounds

public void setBounds(RectangleType value)

Sets the value of the bounds property.

Parameters:

value - allowed object is RectangleType

See Also:

getBounds()

getObjectKey

public String getObjectKey()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the background.
 
                         <b>Info:</b>
                         A PDF object ID consists of two numbers, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
 

Returns:

possible object is String

setObjectKey

public void setObjectKey(String value)

Sets the value of the objectKey property.

Parameters:

value - allowed object is String

See Also:

getObjectKey()

getPage

public int getPage()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The page the background shall be set for.</p>
 

Returns:

possible object is Integer

setPage

public void setPage(Integer value)

Sets the value of the page property.

Parameters:

value - allowed object is Integer

See Also:

getPage()

isOnprint

public boolean isOnprint()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Whether the background shall be visible in printouts of the document.</p>
 

Returns:

possible object is Boolean

setOnprint

public void setOnprint(Boolean value)

Sets the value of the onprint property.

Parameters:

value - allowed object is Boolean

See Also:

isOnprint()

isOnscreen

public boolean isOnscreen()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Whether the background shall be visible in Readers.</p>
 

Returns:

possible object is Boolean

setOnscreen

public void setOnscreen(Boolean value)

Sets the value of the onscreen property.

Parameters:

value - allowed object is Boolean

See Also:

isOnscreen()

isIsImage

public boolean isIsImage()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When set to true, the background is using an image resource. (Otherwise it is unicolor)</p>
 

Returns:

possible object is Boolean

setIsImage

public void setIsImage(Boolean value)

Sets the value of the isImage property.

Parameters:

value - allowed object is Boolean

See Also:

isIsImage()