Class: RTF::HeaderNode
- Inherits:
-
CommandNode
- Object
- Node
- ContainerNode
- CommandNode
- RTF::HeaderNode
- Defined in:
- lib/rtf/node.rb
Overview
This class represents a document header.
Constant Summary collapse
- UNIVERSAL =
A definition for a header type.
:header
- LEFT_PAGE =
A definition for a header type.
:headerl
- RIGHT_PAGE =
A definition for a header type.
:headerr
- FIRST_PAGE =
A definition for a header type.
:headerf
Instance Attribute Summary collapse
-
#type ⇒ Object
Attribute accessor.
Attributes inherited from CommandNode
#prefix, #split, #suffix, #wrap
Attributes inherited from ContainerNode
Attributes inherited from Node
Instance Method Summary collapse
-
#footnote(text) ⇒ Object
This method overloads the footnote method inherited from the CommandNode class to prevent footnotes being added to headers.
-
#initialize(document, type = UNIVERSAL) ⇒ HeaderNode
constructor
This is the constructor for the HeaderNode class.
Methods inherited from CommandNode
#<<, #apply, #background, #bold, #colour, #font, #foreground, #image, #italic, #line_break, #link, #list, #paragraph, #strike, #subscript, #superscript, #table, #to_rtf, #underline
Methods inherited from ContainerNode
#[], #each, #first, #last, #size, #store, #to_rtf
Methods inherited from Node
#is_root?, #next_node, #previous_node, #root
Constructor Details
#initialize(document, type = UNIVERSAL) ⇒ HeaderNode
This is the constructor for the HeaderNode class.
Parameters
- document
-
A reference to the Document object that will own the new header.
- type
-
The style type for the new header. Defaults to a value of HeaderNode::UNIVERSAL.
1186 1187 1188 1189 |
# File 'lib/rtf/node.rb', line 1186 def initialize(document, type=UNIVERSAL) super(document, "\\#{type.id2name}", nil, false) @type = type end |
Instance Attribute Details
#type ⇒ Object
Attribute accessor.
1173 1174 1175 |
# File 'lib/rtf/node.rb', line 1173 def type @type end |
Instance Method Details
#footnote(text) ⇒ Object
This method overloads the footnote method inherited from the CommandNode class to prevent footnotes being added to headers.
Parameters
- text
-
Not used.
Exceptions
- RTFError
-
Always generated whenever this method is called.
1199 1200 1201 |
# File 'lib/rtf/node.rb', line 1199 def footnote(text) RTFError.fire("Footnotes are not permitted in page headers.") end |