Package com.itextpdf.layout.properties.margins

Class FootnotesProperties

java.lang.Object

com.itextpdf.layout.properties.margins.FootnotesProperties

       public class FootnotesProperties extends Object
      

Class representing properties to customize footnotes.

Can be specified via Document.setFootnotesProperties(FootnotesProperties) or SectionBreak.setFootnotesProperties(FootnotesProperties).

Constructor Summary

Constructors

Constructor	Description
FootnotesProperties()	Creates new FootnotesProperties instance.

Method Summary

Modifier and Type	Method	Description
Style	getFootnoteAnchorLabelStyle()	Gets Style storing style properties for footnote anchors that are placed inside the footnotes container.
FootnoteNumberingConfig	getFootnoteNumberingConfig()	Gets FootnoteNumberingConfig representing numbering configuration for footnotes.
FootnoteNumberingType	getFootnoteNumberingType()	Gets FootnoteNumberingType representing numbering type for footnote anchors.
Style	getFootnotesContainerStyle()	Gets Style storing style properties for footnotes container.
FootnotesProperties	setFootnoteAnchorLabelStyle(Style footnoteAnchorLabelStyle)	Sets Style storing style properties for footnote anchors that are placed inside the footnotes container.
FootnotesProperties	setFootnoteNumberingConfig(FootnoteNumberingConfig footnoteNumberingConfig)	Sets FootnoteNumberingConfig representing numbering configuration for footnotes.
FootnotesProperties	setFootnoteNumberingType(FootnoteNumberingType footnoteNumberingType)	Sets FootnoteNumberingType representing numbering type for footnote anchors.
FootnotesProperties	setFootnotesContainerStyle(Style footnotesContainerStyle)	Sets Style storing style properties for footnotes container.

Methods inherited from class java.lang.Object

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

Constructor Details

FootnotesProperties

             public FootnotesProperties()
            

Creates new FootnotesProperties instance.

Method Details

getFootnoteNumberingType

             public FootnoteNumberingType getFootnoteNumberingType()
            

Gets FootnoteNumberingType representing numbering type for footnote anchors.

Returns:

FootnoteNumberingType numbering type

setFootnoteNumberingType

             public FootnotesProperties setFootnoteNumberingType
             (FootnoteNumberingType footnoteNumberingType)
            

Sets FootnoteNumberingType representing numbering type for footnote anchors.

Parameters:

footnoteNumberingType - FootnoteNumberingType representing numbering type for footnote anchors

Returns:

this same FootnotesProperties instance

getFootnoteNumberingConfig

             public FootnoteNumberingConfig getFootnoteNumberingConfig()
            

Gets FootnoteNumberingConfig representing numbering configuration for footnotes.

Returns:

FootnoteNumberingConfig representing footnotes numbering configuration

setFootnoteNumberingConfig

             public FootnotesProperties setFootnoteNumberingConfig
             (FootnoteNumberingConfig footnoteNumberingConfig)
            

Sets FootnoteNumberingConfig representing numbering configuration for footnotes.

Parameters:

footnoteNumberingConfig - FootnoteNumberingConfig representing footnotes numbering configuration

Returns:

this same FootnotesProperties instance

getFootnotesContainerStyle

             public Style getFootnotesContainerStyle()
            

Gets Style storing style properties for footnotes container.

Returns:

Style storing properties for footnotes container

setFootnotesContainerStyle

             public FootnotesProperties setFootnotesContainerStyle
             (Style footnotesContainerStyle)
            

Sets Style storing style properties for footnotes container.

Parameters:

footnotesContainerStyle - Style storing properties for footnotes container

Returns:

this same FootnotesProperties instance

getFootnoteAnchorLabelStyle

             public Style getFootnoteAnchorLabelStyle()
            

Gets Style storing style properties for footnote anchors that are placed inside the footnotes container.

Returns:

Style storing properties for footnote anchors that are inside the footnotes

setFootnoteAnchorLabelStyle

             public FootnotesProperties setFootnoteAnchorLabelStyle
             (Style footnoteAnchorLabelStyle)
            

Sets Style storing style properties for footnote anchors that are placed inside the footnotes container.

Parameters:

footnoteAnchorLabelStyle - Style storing properties for footnote anchors inside the footnotes

Returns:

this same FootnotesProperties instance