Package net.webpdf.wsclient.schema.operation

Class BackgroundBaseSettingsType

java.lang.Object

net.webpdf.wsclient.schema.operation.BackgroundBaseSettingsType

public class BackgroundBaseSettingsType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines basic configuration settings for generating background layers.</p>
 

Java class for BackgroundBaseSettingsType complex type

.

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

 <complexType name="BackgroundBaseSettingsType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="position" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="x" default="0">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}float">
                       <minInclusive value="0"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="y" default="0">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}float">
                       <minInclusive value="0"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="metrics" type="{http://schema.webpdf.de/1.0/operation}MetricsType" default="mm" />
                 <attribute name="position" type="{http://schema.webpdf.de/1.0/operation}BackgroundPositionModeType" default="center_center" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="visibility" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <attribute name="onPrint" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
                 <attribute name="onScreen" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="pages" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <choice>
                   <element name="pageInterval" type="{http://schema.webpdf.de/1.0/operation}PageIntervalType" minOccurs="0"/>
                 </choice>
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </all>
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}BaseBackgroundGroup"/>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackgroundBaseSettingsType.Pages	Java class for anonymous complex type
static class	BackgroundBaseSettingsType.Position	Java class for anonymous complex type
static class	BackgroundBaseSettingsType.Visibility	Java class for anonymous complex type

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	opacity	<?
protected BackgroundBaseSettingsType.Pages	pages	<?
protected BackgroundBaseSettingsType.Position	position	<?
protected Boolean	relativeToPage	<?
protected Boolean	replaceExisting	<?
protected Integer	rotation	<?
protected Integer	scale	<?
protected BackgroundBaseSettingsType.Visibility	visibility	<?

Constructor Summary

Constructors

Constructor	Description
BackgroundBaseSettingsType()

Method Summary

Modifier and Type	Method	Description
int	getOpacity()	<?
BackgroundBaseSettingsType.Pages	getPages()	<?
BackgroundBaseSettingsType.Position	getPosition()	<?
int	getRotation()	<?
int	getScale()	<?
BackgroundBaseSettingsType.Visibility	getVisibility()	<?
boolean	isRelativeToPage()	<?
boolean	isReplaceExisting()	<?
boolean	isSetOpacity()
boolean	isSetPages()
boolean	isSetPosition()
boolean	isSetRelativeToPage()
boolean	isSetReplaceExisting()
boolean	isSetRotation()
boolean	isSetScale()
boolean	isSetVisibility()
void	setOpacity(int value)	Sets the value of the opacity property.
void	setPages(BackgroundBaseSettingsType.Pages value)	Sets the value of the pages property.
void	setPosition(BackgroundBaseSettingsType.Position value)	Sets the value of the position property.
void	setRelativeToPage(boolean value)	Sets the value of the relativeToPage property.
void	setReplaceExisting(boolean value)	Sets the value of the replaceExisting property.
void	setRotation(int value)	Sets the value of the rotation property.
void	setScale(int value)	Sets the value of the scale property.
void	setVisibility(BackgroundBaseSettingsType.Visibility value)	Sets the value of the visibility property.
void	unsetOpacity()
void	unsetRelativeToPage()
void	unsetReplaceExisting()
void	unsetRotation()
void	unsetScale()

Methods inherited from class java.lang.Object

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

Field Detail

position

protected BackgroundBaseSettingsType.Position position

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="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 define the position of the background layer.</p>
 

visibility

protected BackgroundBaseSettingsType.Visibility visibility

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="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 define the element's visibility in various use contexts.</p>
 

pages

protected BackgroundBaseSettingsType.Pages pages

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the pages to which backgrounds shall be applied.</p>
 

relativeToPage

protected Boolean relativeToPage

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, the background layer will not be scaled relative to its own original size, but rather to the dimensions of the page containing it.</p>
 

replaceExisting

protected Boolean replaceExisting

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, an existing background layer will be automatically deleted and replaced with the new one. If false, an existing background layer will cause the operation to be aborted.</p>
 

scale

protected Integer scale

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A percentage value used to specify the scaling for the background layer. This scaling can either be relative to the background layer's original size or to the dimensions of the page containing it (depends on the "relativeToPage" parameter)</p>
 

rotation

protected Integer rotation

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A value between 0 and 360 degrees that is used to specify the background layer's rotation.</p>
 

opacity

protected Integer opacity

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A percentage value that is used to specify the background layer's transparency (100 percent means fully visible).</p>
 

Constructor Detail

BackgroundBaseSettingsType

public BackgroundBaseSettingsType()

Method Detail

getPosition

public BackgroundBaseSettingsType.Position getPosition()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="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 define the position of the background layer.</p>
 

Returns:

possible object is BackgroundBaseSettingsType.Position

setPosition

public void setPosition(BackgroundBaseSettingsType.Position value)

Sets the value of the position property.

Parameters:

value - allowed object is BackgroundBaseSettingsType.Position

See Also:

getPosition()

isSetPosition

public boolean isSetPosition()

getVisibility

public BackgroundBaseSettingsType.Visibility getVisibility()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="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 define the element's visibility in various use contexts.</p>
 

Returns:

possible object is BackgroundBaseSettingsType.Visibility

setVisibility

public void setVisibility(BackgroundBaseSettingsType.Visibility value)

Sets the value of the visibility property.

Parameters:

value - allowed object is BackgroundBaseSettingsType.Visibility

See Also:

getVisibility()

isSetVisibility

public boolean isSetVisibility()

getPages

public BackgroundBaseSettingsType.Pages getPages()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the pages to which backgrounds shall be applied.</p>
 

Returns:

possible object is BackgroundBaseSettingsType.Pages

setPages

public void setPages(BackgroundBaseSettingsType.Pages value)

Sets the value of the pages property.

Parameters:

value - allowed object is BackgroundBaseSettingsType.Pages

See Also:

getPages()

isSetPages

public boolean isSetPages()

isRelativeToPage

public boolean isRelativeToPage()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, the background layer will not be scaled relative to its own original size, but rather to the dimensions of the page containing it.</p>
 

Returns:

possible object is Boolean

setRelativeToPage

public void setRelativeToPage(boolean value)

Sets the value of the relativeToPage property.

Parameters:

value - allowed object is Boolean

See Also:

isRelativeToPage()

isSetRelativeToPage

public boolean isSetRelativeToPage()

unsetRelativeToPage

public void unsetRelativeToPage()

isReplaceExisting

public boolean isReplaceExisting()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If true, an existing background layer will be automatically deleted and replaced with the new one. If false, an existing background layer will cause the operation to be aborted.</p>
 

Returns:

possible object is Boolean

setReplaceExisting

public void setReplaceExisting(boolean value)

Sets the value of the replaceExisting property.

Parameters:

value - allowed object is Boolean

See Also:

isReplaceExisting()

isSetReplaceExisting

public boolean isSetReplaceExisting()

unsetReplaceExisting

public void unsetReplaceExisting()

getScale

public int getScale()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A percentage value used to specify the scaling for the background layer. This scaling can either be relative to the background layer's original size or to the dimensions of the page containing it (depends on the "relativeToPage" parameter)</p>
 

Returns:

possible object is Integer

setScale

public void setScale(int value)

Sets the value of the scale property.

Parameters:

value - allowed object is Integer

See Also:

getScale()

isSetScale

public boolean isSetScale()

unsetScale

public void unsetScale()

getRotation

public int getRotation()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A value between 0 and 360 degrees that is used to specify the background layer's rotation.</p>
 

Returns:

possible object is Integer

setRotation

public void setRotation(int value)

Sets the value of the rotation property.

Parameters:

value - allowed object is Integer

See Also:

getRotation()

isSetRotation

public boolean isSetRotation()

unsetRotation

public void unsetRotation()

getOpacity

public int getOpacity()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A percentage value that is used to specify the background layer's transparency (100 percent means fully visible).</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()