public class XSSFHeaderFooterProperties
extends java.lang.Object
All Header/Footer properties for a sheet are scoped to the sheet. This includes Different First Page, and Different Even/Odd. These properties can be set or unset explicitly in this class. Note that while Scale With Document and Align With Margins default to unset, Different First, and Different Even/Odd are updated automatically as headers and footers are added and removed.
Constructor and Description |
---|
XSSFHeaderFooterProperties(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter headerFooter)
Create an instance of XSSFHeaderFooterProperties from the supplied XML bean
|
Modifier and Type | Method and Description |
---|---|
boolean |
getAlignWithMargins()
returns alignWithMargins attribute
|
boolean |
getDifferentFirst()
returns differentFirst attribute
|
boolean |
getDifferentOddEven()
returns differentOddEven attribute
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter |
getHeaderFooter()
Returns the underlying CTHeaderFooter xml bean
|
boolean |
getScaleWithDoc()
returns scaleWithDoc attribute
|
void |
removeAlignWithMargins()
remove alignWithMargins attribute
|
void |
removeDifferentFirst()
remove differentFirst attribute
|
void |
removeDifferentOddEven()
remove differentOddEven attribute
|
void |
removeScaleWithDoc()
remove scaleWithDoc attribute
|
void |
setAlignWithMargins(boolean flag)
set alignWithMargins attribute
|
void |
setDifferentFirst(boolean flag)
set differentFirst attribute
|
void |
setDifferentOddEven(boolean flag)
set differentOddEven attribute
|
void |
setScaleWithDoc(boolean flag)
set scaleWithDoc attribute
|
public XSSFHeaderFooterProperties(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter headerFooter)
@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHeaderFooter getHeaderFooter()
public boolean getAlignWithMargins()
public boolean getDifferentFirst()
public boolean getDifferentOddEven()
public boolean getScaleWithDoc()
public void setAlignWithMargins(boolean flag)
public void setDifferentFirst(boolean flag)
public void setDifferentOddEven(boolean flag)
public void setScaleWithDoc(boolean flag)
public void removeAlignWithMargins()
public void removeDifferentFirst()
public void removeDifferentOddEven()
public void removeScaleWithDoc()
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.