hexapdf 0.16.0 → 0.17.3

data/lib/hexapdf/type/acro_form/field.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -247,14 +247,33 @@ module HexaPDF
         #
         # Yields each widget, i.e. visual representation, of this field.
         #
+        # Widgets can be associated to the field in three ways:
+        #
+        # 1. The widget can be embedded in the field itself.
+        # 2. One or more widgets are defined as children of this field.
+        # 3. Widgets of *another field instance with the same full field name*.
+        #
+        # Because of possibility 3 all fields of the form have to be searched to check whether there
+        # is another field with the same full field name.
+        #
         # See: HexaPDF::Type::Annotations::Widget
-        def each_widget # :yields: widget
+        def each_widget(direct_only: false, &block) # :yields: widget
           return to_enum(__method__) unless block_given?
+
           if embedded_widget?
             yield(document.wrap(self))
           elsif terminal_field?
             self[:Kids]&.each {|kid| yield(document.wrap(kid)) }
           end
+
+          unless direct_only
+            my_name = full_field_name
+            document.acro_form&.each_field do |field|
+              next if field.full_field_name != my_name || field == self
+              field.each_widget(direct_only: true, &block)
+            end
+          end
+
           self
         end
 

data/lib/hexapdf/type/acro_form/form.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -96,7 +96,7 @@ module HexaPDF
         def find_root_fields
           result = []
           document.pages.each do |page|
-            page[:Annots]&.each do |annot|
+            page.each_annotation do |annot|
               if !annot.key?(:Parent) && annot.key?(:FT)
                 result << document.wrap(annot, type: :XXAcroFormField, subtype: annot[:FT])
               elsif annot.key?(:Parent)
@@ -157,18 +157,27 @@ module HexaPDF
         # The optional keyword arguments allow setting often used properties of the field:
         #
         # +font+::
-        #     The font that should be used for the text of the field. If +font_size+ is specified
-        #     but +font+ isn't, the font Helvetica is used.
+        #     The font that should be used for the text of the field. If +font_size+ or
+        #     +font_options+ is specified but +font+ isn't, the font Helvetica is used.
+        #
+        #     If no font is set on the text field, the default font properties of the AcroForm form
+        #     are used. Note that field specific or form specific font properties have to be set.
+        #     Otherwise there will be an error when trying to generate a visual representation of
+        #     the field value.
+        #
+        # +font_options+::
+        #     A hash with font options like :variant that should be used.
         #
         # +font_size+::
-        #     The font size that should be used. If +font+ is specified but +font_size+ isn't, font
-        #     size defaults to 0 (= auto-sizing).
+        #     The font size that should be used. If +font+ or +font_options+ is specified but
+        #     +font_size+ isn't, font size defaults to 0 (= auto-sizing).
         #
         # +align+::
         #     The alignment of the text, either :left, :center or :right.
-        def create_text_field(name, font: nil, font_size: nil, align: nil)
+        def create_text_field(name, font: nil, font_options: nil, font_size: nil, align: nil)
           create_field(name, :Tx) do |field|
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
           end
         end
 
@@ -179,10 +188,12 @@ module HexaPDF
         #
         # The optional keyword arguments allow setting often used properties of the field, see
         # #create_text_field for details.
-        def create_multiline_text_field(name, font: nil, font_size: nil, align: nil)
+        def create_multiline_text_field(name, font: nil, font_options: nil, font_size: nil,
+                                        align: nil)
           create_field(name, :Tx) do |field|
             field.initialize_as_multiline_text_field
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
           end
         end
 
@@ -196,10 +207,12 @@ module HexaPDF
         #
         # The optional keyword arguments allow setting often used properties of the field, see
         # #create_text_field for details.
-        def create_comb_text_field(name, max_chars:, font: nil, font_size: nil, align: nil)
+        def create_comb_text_field(name, max_chars:, font: nil, font_options: nil, font_size: nil,
+                                   align: nil)
           create_field(name, :Tx) do |field|
             field.initialize_as_comb_text_field
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
             field[:MaxLen] = max_chars
           end
         end
@@ -211,10 +224,11 @@ module HexaPDF
         #
         # The optional keyword arguments allow setting often used properties of the field, see
         # #create_text_field for details.
-        def create_file_select_field(name, font: nil, font_size: nil, align: nil)
+        def create_file_select_field(name, font: nil, font_options: nil, font_size: nil, align: nil)
           create_field(name, :Tx) do |field|
             field.initialize_as_file_select_field
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
           end
         end
 
@@ -225,10 +239,11 @@ module HexaPDF
         #
         # The optional keyword arguments allow setting often used properties of the field, see
         # #create_text_field for details.
-        def create_password_field(name, font: nil, font_size: nil, align: nil)
+        def create_password_field(name, font: nil, font_options: nil, font_size: nil, align: nil)
           create_field(name, :Tx) do |field|
             field.initialize_as_password_field
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
           end
         end
 
@@ -262,15 +277,16 @@ module HexaPDF
         #     If set to +true+, the combo box allows entering an arbitrary value in addition to
         #     selecting one of the provided option items.
         #
-        # +font+, +font_size+ and +align+::
+        # +font+, +font_options+, +font_size+ and +align+::
         #     See #create_text_field
-        def create_combo_box(name, option_items: nil, editable: nil, font: nil, font_size: nil,
-                             align: nil)
+        def create_combo_box(name, option_items: nil, editable: nil, font: nil,
+                             font_options: nil, font_size: nil, align: nil)
           create_field(name, :Ch) do |field|
             field.initialize_as_combo_box
             field.option_items = option_items if option_items
             field.flag(:edit) if editable
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
           end
         end
 
@@ -287,15 +303,16 @@ module HexaPDF
         # +multi_select+::
         #     If set to +true+, the list box allows selecting multiple items instead of only one.
         #
-        # +font+, +font_size+ and +align+::
+        # +font+, +font_options+, +font_size+ and +align+::
         #     See #create_text_field.
-        def create_list_box(name, option_items: nil, multi_select: nil, font: nil, font_size: nil,
-                            align: nil)
+        def create_list_box(name, option_items: nil, multi_select: nil, font: nil,
+                            font_options: nil, font_size: nil, align: nil)
           create_field(name, :Ch) do |field|
             field.initialize_as_list_box
             field.option_items = option_items if option_items
             field.flag(:multi_select) if multi_select
-            apply_variable_text_properties(field, font: font, font_size: font_size, align: align)
+            apply_variable_text_properties(field, font: font, font_options: font_options,
+                                           font_size: font_size, align: align)
           end
         end
 
@@ -402,9 +419,12 @@ module HexaPDF
         end
 
         # Applies the given variable field properties to the field.
-        def apply_variable_text_properties(field, font: nil, font_size: nil, align: nil)
-          if font || font_size
-            field.set_default_appearance_string(font: font || 'Helvetica', font_size: font_size || 0)
+        def apply_variable_text_properties(field, font: nil, font_options: nil, font_size: nil,
+                                           align: nil)
+          if font || font_options || font_size
+            field.set_default_appearance_string(font: font || 'Helvetica',
+                                                font_options: font_options || {},
+                                                font_size: font_size || 0)
           end
           field.text_alignment(align) if align
         end
@@ -417,8 +437,7 @@ module HexaPDF
               yield("When the field /DA is present, the field /DR must also be present")
               return
             end
-            font_name = nil
-            HexaPDF::Content::Parser.parse(da) {|obj, params| font_name = params[0] if obj == :Tf }
+            font_name, _ = VariableTextField.parse_appearance_string(da)
             if font_name && !(self[:DR][:Font] && self[:DR][:Font][font_name])
               yield("The font specified in /DA is not in the /DR resource dictionary")
             end

data/lib/hexapdf/type/acro_form/text_field.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -165,7 +165,7 @@ module HexaPDF
           if flagged?(:password)
             raise HexaPDF::Error, "Storing a field value for a password field is not allowed"
           end
-          str = str.gsub(/[[:space:]]/, ' ') if concrete_field_type == :single_line_text_field
+          str = str.gsub(/[[:space:]]/, ' ') if str && concrete_field_type == :single_line_text_field
           self[:V] = str
           update_widgets
         end

data/lib/hexapdf/type/acro_form/variable_text_field.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -61,6 +61,16 @@ module HexaPDF
 
         UNSET_ARG = ::Object.new # :nodoc:
 
+        # Parses the given appearance string. If no block is given, the appearance string is
+        # searched for font name and font size both of which are returend. Otherwise the block is
+        # called with each found content stream operator and has to handle them themselves.
+        def self.parse_appearance_string(appearance_string, &block) # :yield: obj, params
+          font_params = nil
+          block ||= lambda {|obj, params| font_params = params.dup if obj == :Tf }
+          HexaPDF::Content::Parser.parse(appearance_string.sub(/\/\//, '/'), &block)
+          font_params
+        end
+
         # :call-seq:
         #   field.text_alignment                -> alignment
         #   field.text_alignment(alignment)     -> field
@@ -93,9 +103,12 @@ module HexaPDF
         #
         # The default argument values are a sane default. If +font_size+ is set to 0, the font size
         # is calculated using the height/width of the field.
-        def set_default_appearance_string(font: 'Helvetica', font_size: 0)
+        #
+        # Use the +font_options+ hash to provide font options like :variant, see
+        # HexaPDF::Document::Fonts#add.
+        def set_default_appearance_string(font: 'Helvetica', font_options: {}, font_size: 0)
           name = document.acro_form(create: true).default_resources.
-            add_font(document.fonts.add(font).pdf_object)
+            add_font(document.fonts.add(font, **font_options).pdf_object)
           self[:DA] = "0 g /#{name} #{font_size} Tf"
         end
 
@@ -107,12 +120,7 @@ module HexaPDF
         def parse_default_appearance_string
           da = self[:DA] || (document.acro_form && document.acro_form[:DA])
           raise HexaPDF::Error, "No default appearance string set" unless da
-
-          font_params = nil
-          HexaPDF::Content::Parser.parse(da) do |obj, params|
-            font_params = params.dup if obj == :Tf
-          end
-          font_params
+          self.class.parse_appearance_string(da)
         end
 
       end

data/lib/hexapdf/type/acro_form.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/action.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/actions/go_to.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/actions/go_to_r.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/actions/launch.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/actions/uri.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/actions.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/annotation.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/annotations/link.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/annotations/markup_annotation.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/annotations/text.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/annotations/widget.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -308,7 +308,7 @@ module HexaPDF
             size = 0
             color = [0]
             if (da = self[:DA] || field[:DA])
-              HexaPDF::Content::Parser.parse(da) do |obj, params|
+              HexaPDF::Type::AcroForm::VariableTextField.parse_appearance_string(da) do |obj, params|
                 case obj
                 when :rg, :g, :k then color = params.dup
                 when :Tf then size = params[1]

data/lib/hexapdf/type/annotations.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/catalog.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/cid_font.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/embedded_file.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/file_specification.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font_descriptor.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font_simple.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font_true_type.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font_type0.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font_type1.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/font_type3.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/form.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/graphics_state_parameter.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/icon_fit.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/image.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/info.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/names.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/object_stream.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/type/page.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2020 Thomas Leitner
+# Copyright (C) 2014-2021 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -465,6 +465,20 @@ module HexaPDF
         document.wrap(dict, stream: stream)
       end
 
+      # :call-seq:
+      #   page.each_annotation {|annotation| block}    -> page
+      #   page.each_annotation                         -> Enumerator
+      #
+      # Yields each annotation of this page.
+      def each_annotation
+        return to_enum(__method__) unless block_given?
+        self[:Annots]&.each do |annotation|
+          next unless annotation
+          yield(document.wrap(annotation, type: :Annot))
+        end
+        self
+      end
+
       # Flattens all or the given annotations of the page. Returns an array with all the annotations
       # that couldn't be flattened because they don't have an appearance stream.
       #