CTPageSetup (docx4j 6.0.1 API)

java.lang.Object
- org.xlsx4j.sml.CTPageSetup

All Implemented Interfaces:: Child

public class CTPageSetup
extends Object
implements Child

Java class for CT_PageSetup complex type.

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

 <complexType name="CT_PageSetup">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="paperSize" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="1" />
       <attribute name="paperHeight" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_PositiveUniversalMeasure" />
       <attribute name="paperWidth" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_PositiveUniversalMeasure" />
       <attribute name="scale" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="100" />
       <attribute name="firstPageNumber" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="1" />
       <attribute name="fitToWidth" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="1" />
       <attribute name="fitToHeight" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="1" />
       <attribute name="pageOrder" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_PageOrder" default="downThenOver" />
       <attribute name="orientation" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_Orientation" default="default" />
       <attribute name="usePrinterDefaults" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="blackAndWhite" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="draft" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="cellComments" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_CellComments" default="none" />
       <attribute name="useFirstPageNumber" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="errors" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_PrintError" default="displayed" />
       <attribute name="horizontalDpi" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="600" />
       <attribute name="verticalDpi" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="600" />
       <attribute name="copies" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="1" />
       <attribute ref="{http://schemas.openxmlformats.org/officeDocument/2006/relationships}id"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`blackAndWhite`
`protected STCellComments`	`cellComments`
`protected Long`	`copies`
`protected Boolean`	`draft`
`protected STPrintError`	`errors`
`protected Long`	`firstPageNumber`
`protected Long`	`fitToHeight`
`protected Long`	`fitToWidth`
`protected Long`	`horizontalDpi`
`protected String`	`id`
`protected STOrientation`	`orientation`
`protected STPageOrder`	`pageOrder`
`protected String`	`paperHeight`
`protected Long`	`paperSize`
`protected String`	`paperWidth`
`protected Long`	`scale`
`protected Boolean`	`useFirstPageNumber`
`protected Boolean`	`usePrinterDefaults`
`protected Long`	`verticalDpi`

Constructor Summary

Constructors
Constructor and Description

CTPageSetup()

Constructors
Constructor and Description
`CTPageSetup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`STCellComments`	`getCellComments()` Gets the value of the cellComments property.
`long`	`getCopies()` Gets the value of the copies property.
`STPrintError`	`getErrors()` Gets the value of the errors property.
`long`	`getFirstPageNumber()` Gets the value of the firstPageNumber property.
`long`	`getFitToHeight()` Gets the value of the fitToHeight property.
`long`	`getFitToWidth()` Gets the value of the fitToWidth property.
`long`	`getHorizontalDpi()` Gets the value of the horizontalDpi property.
`String`	`getId()` Gets the value of the id property.
`STOrientation`	`getOrientation()` Gets the value of the orientation property.
`STPageOrder`	`getPageOrder()` Gets the value of the pageOrder property.
`String`	`getPaperHeight()` Gets the value of the paperHeight property.
`long`	`getPaperSize()` Gets the value of the paperSize property.
`String`	`getPaperWidth()` Gets the value of the paperWidth property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`long`	`getScale()` Gets the value of the scale property.
`long`	`getVerticalDpi()` Gets the value of the verticalDpi property.
`boolean`	`isBlackAndWhite()` Gets the value of the blackAndWhite property.
`boolean`	`isDraft()` Gets the value of the draft property.
`boolean`	`isUseFirstPageNumber()` Gets the value of the useFirstPageNumber property.
`boolean`	`isUsePrinterDefaults()` Gets the value of the usePrinterDefaults property.
`void`	`setBlackAndWhite(Boolean value)` Sets the value of the blackAndWhite property.
`void`	`setCellComments(STCellComments value)` Sets the value of the cellComments property.
`void`	`setCopies(Long value)` Sets the value of the copies property.
`void`	`setDraft(Boolean value)` Sets the value of the draft property.
`void`	`setErrors(STPrintError value)` Sets the value of the errors property.
`void`	`setFirstPageNumber(Long value)` Sets the value of the firstPageNumber property.
`void`	`setFitToHeight(Long value)` Sets the value of the fitToHeight property.
`void`	`setFitToWidth(Long value)` Sets the value of the fitToWidth property.
`void`	`setHorizontalDpi(Long value)` Sets the value of the horizontalDpi property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setOrientation(STOrientation value)` Sets the value of the orientation property.
`void`	`setPageOrder(STPageOrder value)` Sets the value of the pageOrder property.
`void`	`setPaperHeight(String value)` Sets the value of the paperHeight property.
`void`	`setPaperSize(Long value)` Sets the value of the paperSize property.
`void`	`setPaperWidth(String value)` Sets the value of the paperWidth property.
`void`	`setParent(Object parent)`
`void`	`setScale(Long value)` Sets the value of the scale property.
`void`	`setUseFirstPageNumber(Boolean value)` Sets the value of the useFirstPageNumber property.
`void`	`setUsePrinterDefaults(Boolean value)` Sets the value of the usePrinterDefaults property.
`void`	`setVerticalDpi(Long value)` Sets the value of the verticalDpi property.

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

- Field Detail
  - paperSize
```
protected Long paperSize
```
  - paperHeight
```
protected String paperHeight
```
  - paperWidth
```
protected String paperWidth
```
  - scale
```
protected Long scale
```
  - firstPageNumber
```
protected Long firstPageNumber
```
  - fitToWidth
```
protected Long fitToWidth
```
  - fitToHeight
```
protected Long fitToHeight
```
  - pageOrder
```
protected STPageOrder pageOrder
```
  - orientation
```
protected STOrientation orientation
```
  - usePrinterDefaults
```
protected Boolean usePrinterDefaults
```
  - blackAndWhite
```
protected Boolean blackAndWhite
```
  - draft
```
protected Boolean draft
```
  - cellComments
```
protected STCellComments cellComments
```
  - useFirstPageNumber
```
protected Boolean useFirstPageNumber
```
  - errors
```
protected STPrintError errors
```
  - horizontalDpi
```
protected Long horizontalDpi
```
  - verticalDpi
```
protected Long verticalDpi
```
  - copies
```
protected Long copies
```
  - id
```
protected String id
```
- Constructor Detail
  - CTPageSetup
```
public CTPageSetup()
```
- Method Detail
  - getPaperSize
```
public long getPaperSize()
```
    Gets the value of the paperSize property.
    
    Returns:
    
    possible object is Long
  - setPaperSize
```
public void setPaperSize(Long value)
```
    Sets the value of the paperSize property.
    
    Parameters:
    
    value - allowed object is Long
  - getPaperHeight
```
public String getPaperHeight()
```
    Gets the value of the paperHeight property.
    
    Returns:
    
    possible object is String
  - setPaperHeight
```
public void setPaperHeight(String value)
```
    Sets the value of the paperHeight property.
    
    Parameters:
    
    value - allowed object is String
  - getPaperWidth
```
public String getPaperWidth()
```
    Gets the value of the paperWidth property.
    
    Returns:
    
    possible object is String
  - setPaperWidth
```
public void setPaperWidth(String value)
```
    Sets the value of the paperWidth property.
    
    Parameters:
    
    value - allowed object is String
  - getScale
```
public long getScale()
```
    Gets the value of the scale property.
    
    Returns:
    
    possible object is Long
  - setScale
```
public void setScale(Long value)
```
    Sets the value of the scale property.
    
    Parameters:
    
    value - allowed object is Long
  - getFirstPageNumber
```
public long getFirstPageNumber()
```
    Gets the value of the firstPageNumber property.
    
    Returns:
    
    possible object is Long
  - setFirstPageNumber
```
public void setFirstPageNumber(Long value)
```
    Sets the value of the firstPageNumber property.
    
    Parameters:
    
    value - allowed object is Long
  - getFitToWidth
```
public long getFitToWidth()
```
    Gets the value of the fitToWidth property.
    
    Returns:
    
    possible object is Long
  - setFitToWidth
```
public void setFitToWidth(Long value)
```
    Sets the value of the fitToWidth property.
    
    Parameters:
    
    value - allowed object is Long
  - getFitToHeight
```
public long getFitToHeight()
```
    Gets the value of the fitToHeight property.
    
    Returns:
    
    possible object is Long
  - setFitToHeight
```
public void setFitToHeight(Long value)
```
    Sets the value of the fitToHeight property.
    
    Parameters:
    
    value - allowed object is Long
  - getPageOrder
```
public STPageOrder getPageOrder()
```
    Gets the value of the pageOrder property.
    
    Returns:
    
    possible object is STPageOrder
  - setPageOrder
```
public void setPageOrder(STPageOrder value)
```
    Sets the value of the pageOrder property.
    
    Parameters:
    
    value - allowed object is STPageOrder
  - getOrientation
```
public STOrientation getOrientation()
```
    Gets the value of the orientation property.
    
    Returns:
    
    possible object is STOrientation
  - setOrientation
```
public void setOrientation(STOrientation value)
```
    Sets the value of the orientation property.
    
    Parameters:
    
    value - allowed object is STOrientation
  - isUsePrinterDefaults
```
public boolean isUsePrinterDefaults()
```
    Gets the value of the usePrinterDefaults property.
    
    Returns:
    
    possible object is Boolean
  - setUsePrinterDefaults
```
public void setUsePrinterDefaults(Boolean value)
```
    Sets the value of the usePrinterDefaults property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isBlackAndWhite
```
public boolean isBlackAndWhite()
```
    Gets the value of the blackAndWhite property.
    
    Returns:
    
    possible object is Boolean
  - setBlackAndWhite
```
public void setBlackAndWhite(Boolean value)
```
    Sets the value of the blackAndWhite property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isDraft
```
public boolean isDraft()
```
    Gets the value of the draft property.
    
    Returns:
    
    possible object is Boolean
  - setDraft
```
public void setDraft(Boolean value)
```
    Sets the value of the draft property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getCellComments
```
public STCellComments getCellComments()
```
    Gets the value of the cellComments property.
    
    Returns:
    
    possible object is STCellComments
  - setCellComments
```
public void setCellComments(STCellComments value)
```
    Sets the value of the cellComments property.
    
    Parameters:
    
    value - allowed object is STCellComments
  - isUseFirstPageNumber
```
public boolean isUseFirstPageNumber()
```
    Gets the value of the useFirstPageNumber property.
    
    Returns:
    
    possible object is Boolean
  - setUseFirstPageNumber
```
public void setUseFirstPageNumber(Boolean value)
```
    Sets the value of the useFirstPageNumber property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getErrors
```
public STPrintError getErrors()
```
    Gets the value of the errors property.
    
    Returns:
    
    possible object is STPrintError
  - setErrors
```
public void setErrors(STPrintError value)
```
    Sets the value of the errors property.
    
    Parameters:
    
    value - allowed object is STPrintError
  - getHorizontalDpi
```
public long getHorizontalDpi()
```
    Gets the value of the horizontalDpi property.
    
    Returns:
    
    possible object is Long
  - setHorizontalDpi
```
public void setHorizontalDpi(Long value)
```
    Sets the value of the horizontalDpi property.
    
    Parameters:
    
    value - allowed object is Long
  - getVerticalDpi
```
public long getVerticalDpi()
```
    Gets the value of the verticalDpi property.
    
    Returns:
    
    possible object is Long
  - setVerticalDpi
```
public void setVerticalDpi(Long value)
```
    Sets the value of the verticalDpi property.
    
    Parameters:
    
    value - allowed object is Long
  - getCopies
```
public long getCopies()
```
    Gets the value of the copies property.
    
    Returns:
    
    possible object is Long
  - setCopies
```
public void setCopies(Long value)
```
    Sets the value of the copies property.
    
    Parameters:
    
    value - allowed object is Long
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - getParent
```
public Object getParent()
```
    Gets the parent object in the object tree representing the unmarshalled xml document.
    
    Specified by:
    
    getParent in interface Child
    
    Returns:
    
    The parent object.
  - setParent
```
public void setParent(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)
```
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    
    Parameters:
    
    parent - The parent object in the object tree.
    
    unmarshaller - The unmarshaller that generated the instance.

Class CTPageSetup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

paperSize

paperHeight

paperWidth

scale

firstPageNumber

fitToWidth

fitToHeight

pageOrder

orientation

usePrinterDefaults

blackAndWhite

draft

cellComments

useFirstPageNumber

errors

horizontalDpi

verticalDpi

copies

id

Constructor Detail

CTPageSetup

Method Detail

getPaperSize

setPaperSize

getPaperHeight

setPaperHeight

getPaperWidth

setPaperWidth

getScale

setScale

getFirstPageNumber

setFirstPageNumber

getFitToWidth

setFitToWidth

getFitToHeight

setFitToHeight

getPageOrder

setPageOrder

getOrientation

setOrientation

isUsePrinterDefaults

setUsePrinterDefaults

isBlackAndWhite

setBlackAndWhite

isDraft

setDraft

getCellComments

setCellComments

isUseFirstPageNumber

setUseFirstPageNumber

getErrors

setErrors

getHorizontalDpi

setHorizontalDpi

getVerticalDpi

setVerticalDpi

getCopies

setCopies

getId

setId

getParent

setParent

afterUnmarshal