Class RTF::FooterNode
In: lib/rtf/node.rb
Parent: CommandNode

This class represents a document footer.

Methods

footnote   new  

Constants

UNIVERSAL = :footer   A definition for a header type.
LEFT_PAGE = :footerl   A definition for a header type.
RIGHT_PAGE = :footerr   A definition for a header type.
FIRST_PAGE = :footerf   A definition for a header type.

Attributes

type  [R]  Attribute accessor.
type  [W]  Attribute mutator.

Public Class methods

This is the constructor for the FooterNode class.

Parameters

document:A reference to the Document object that will own the new footer.
type:The style type for the new footer. Defaults to a value of FooterNode::UNIVERSAL.

Public Instance methods

This method overloads the footnote method inherited from the CommandNode class to prevent footnotes being added to footers.

Parameters

text:Not used.

Exceptions

RTFError:Always generated whenever this method is called.

[Validate]