Class: PDF::Core::OutlineRoot Private

Inherits:
Object
  • Object
show all
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.

See Also:

  • PDF 1.7 spec, section 8.2.2 Document Outline

Instance Attribute Summary collapse

Instance Method Summary collapse

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
lib/pdf/core/outline_root.rb, line 22
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.

Returns:

  • (Integer)
Source Code
lib/pdf/core/outline_root.rb, line 12
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.

Returns:

Source Code
lib/pdf/core/outline_root.rb, line 16
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.

Returns:

Source Code
lib/pdf/core/outline_root.rb, line 20
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

Returns:

  • (Hash)
Source Code
lib/pdf/core/outline_root.rb, line 28
28
def to_hash

29
  { Type: :Outlines, Count: count, First: first, Last: last }

30
end