Package com.itextpdf.layout.properties.margins

Class FootnoteAnchor

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement<FootnoteAnchor>

com.itextpdf.layout.properties.margins.FootnoteAnchor

All Implemented Interfaces:

IAbstractElement, IElement, IPropertyContainer, IAccessibleElement

       public class FootnoteAnchor extends AbstractElement<FootnoteAnchor> implements IAccessibleElement
      

Class representing an anchor for a footnote which is placed at the bottom of the page. Footnote anchor indicates footnote in the text with superscript numbers (or letters or other symbols).

Field Summary

Fields

Modifier and Type	Field	Description
protected DefaultAccessibilityProperties	tagProperties

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
FootnoteAnchor(Image image, Footnote footnote)	Creates new FootnoteAnchor instance.
FootnoteAnchor(Text text, Footnote footnote)	Creates new FootnoteAnchor instance.
FootnoteAnchor(Footnote footnote)	Creates new FootnoteAnchor instance.
FootnoteAnchor(String text, Footnote footnote)	Creates new FootnoteAnchor instance.

Method Summary

Modifier and Type	Method	Description
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
Footnote	getFootnote()	Gets Footnote linked to this anchor.
IElement	getFootnoteAnchor()	Gets layout element IElement representing footnote anchor.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
FootnoteAnchor	setFootnoteAnchor(Image footnoteAnchor)	Sets Image layout element representing footnote anchor.
FootnoteAnchor	setFootnoteAnchor(Text footnoteAnchor)	Sets Text layout element representing footnote anchor.

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, hasOwnProperty, setProperty

Field Details

tagProperties

             protected DefaultAccessibilityProperties tagProperties
            

Constructor Details

FootnoteAnchor

             public FootnoteAnchor
             (Footnote footnote)
            

Creates new FootnoteAnchor instance.

Parameters:

footnote - Footnote linked to this anchor

FootnoteAnchor

             public FootnoteAnchor
             (String text, Footnote footnote)
            

Creates new FootnoteAnchor instance.

Parameters:

text - superscript text for anchor to indicate a footnote

footnote - Footnote linked to this anchor

FootnoteAnchor

             public FootnoteAnchor
             (Text text, Footnote footnote)
            

Creates new FootnoteAnchor instance.

Parameters:

text - Text for anchor to indicate a footnote

footnote - Footnote linked to this anchor

FootnoteAnchor

             public FootnoteAnchor
             (Image image, Footnote footnote)
            

Creates new FootnoteAnchor instance.

Parameters:

image - Image to use as footnote anchor

footnote - Footnote linked to this anchor

Method Details

getFootnoteAnchor

             public IElement getFootnoteAnchor()
            

Gets layout element IElement representing footnote anchor.

Returns:

IElement representing footnote anchor (can be Text or Image)

setFootnoteAnchor

             public FootnoteAnchor setFootnoteAnchor
             (Text footnoteAnchor)
            

Sets Text layout element representing footnote anchor.

Parameters:

footnoteAnchor - Text layout element representing footnote anchor

Returns:

this same FootnoteAnchor instance

setFootnoteAnchor

             public FootnoteAnchor setFootnoteAnchor
             (Image footnoteAnchor)
            

Sets Image layout element representing footnote anchor.

Parameters:

footnoteAnchor - Image layout element representing footnote anchor

Returns:

this same FootnoteAnchor instance

getFootnote

             public Footnote getFootnote()
            

Gets Footnote linked to this anchor.

Returns:

Footnote linked to this anchor

getAccessibilityProperties

             public AccessibilityProperties getAccessibilityProperties()
            

Gets the accessibility properties. See also IAccessibleElement.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

             protected IRenderer makeNewRenderer()
            

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<FootnoteAnchor>

Returns:

new IRenderer