Class: PDF::Core::OutlineRoot Private
- Inherits:
-
Object
- Object
- PDF::Core::OutlineRoot
- Defined in:
- lib/pdf/core/outline_root.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Document Outline root.
Instance Attribute Summary collapse
-
#count ⇒ Integer
private
The total number of open items at all levels of the outline.
-
#first ⇒ Reference
private
The first top-level item in the outline.
-
#last ⇒ Reference
private
The last top-level item in the outline.
Instance Method Summary collapse
-
#initialize ⇒ OutlineRoot
constructor
private
A new instance of OutlineRoot.
-
#to_hash ⇒ Hash
private
Hash representation of the outline root.
Constructor Details
#initialize ⇒ OutlineRoot
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of OutlineRoot.
Source Code
22 | def initialize |
23 | @count = 0 |
24 | end
|
Instance Attribute Details
#count ⇒ Integer
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The total number of open items at all levels of the outline.
Source Code
12 | def count |
13 | @count
|
14 | end
|
#first ⇒ Reference
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The first top-level item in the outline.
Source Code
16 | def first |
17 | @first
|
18 | end
|
#last ⇒ Reference
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The last top-level item in the outline.
Source Code
20 | def last |
21 | @last
|
22 | end
|
Instance Method Details
#to_hash ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Hash representation of the outline root
Source Code
28 | def to_hash |
29 | { Type: :Outlines, Count: count, First: first, Last: last } |
30 | end
|