pdfrb 0.7.22 → 0.7.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06bcf184cd873b50571015f1848d43e3692c041d98bd278237b86d06f79d14c0
-  data.tar.gz: 768be65b94d3a987e83278429a765563974ee95cd7125ca05d9a0b9a303074c8
+  metadata.gz: 8d9ae8c6a5750a4998d51924dc9d011b6b41565e2435e7dc87f25e913a5bf532
+  data.tar.gz: 7041b81cedd1d7387cc5ba54829da445add3278151d6579f30da6192d0244043
 SHA512:
-  metadata.gz: 912a23d9b0d4e2b122ea255214dc4d443ee0233d592ed483cea6a12c5ff60ec52db59a183edb8790b8b4acc50badfef728da2de56028fef8df5c58fd507e0d04
-  data.tar.gz: ec728839ee2d5db65428b681aa0bc41dd7613569e3baca4adea7e197e5388f64440342547ef2e538b2568a3bab3bce12f0ec584a6165b867f36bf20c676941b6
+  metadata.gz: 35a3f9fe4ea0933fd2e33b2089799e32477e04824884ccc29f0c78377699d051a584e3facaef01c5a62666568db22f859557c394daff2c96c441574c2a054d75
+  data.tar.gz: 6baf785a854c19b549f6d66807bc9531fdd665164c6a02ab1570650a5faf9a8a5d5c412b7a7d01a9b467b4fb24301f53ac456bc6579d24615be837e786476a00

data/lib/pdfrb/model/type/action_go_to_e.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # GoToE action (s12.6.4.4, PDF 1.6). Navigate to a destination in
+      # an embedded PDF file.
+      class ActionGoToE < Action
+        arlington_object "ActionGoToE"
+        register_subtype :GoToE
+
+        def target_file; self[:F]; end
+        def destination; self[:D]; end
+        def new_window; self[:NewWindow]; end
+        def target; self[:T]; end
+
+        def new_window?
+          new_window == true
+        end
+
+        def targets_embedded_file?
+          !target_file.nil?
+        end
+
+        def named_destination?
+          destination.is_a?(Symbol) || destination.is_a?(String)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/action_rich_media_execute.rb

@@ -6,11 +6,12 @@ module Pdfrb
       # RichMediaExecute action (s12.6.4.12, PDF 2.0). Execute a
       # command on a RichMedia annotation.
       class ActionRichMediaExecute < Action
+        arlington_object "ActionRichMediaExecute"
         register_subtype :RichMediaExecute
 
         def target; self[:TA]; end
-        def instance; self[:Instance]; end
-        def arguments; self[:Args]; end
+        def instance; self[:TI]; end
+        def command; self[:CMD]; end
       end
     end
   end

data/lib/pdfrb/model/type/action_thread.rb

@@ -5,6 +5,7 @@ module Pdfrb
     module Type
       # Thread action (s12.6.4.6). Navigate within an article thread.
       class ActionThread < Action
+        arlington_object "ActionThread"
         register_subtype :Thread
 
         def thread; self[:F]; end

data/lib/pdfrb/model/type/add_action_form_field.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Additional Actions for interactive form fields (s12.6.3.17,
+      # Table 199). All four triggers carry JavaScript actions.
+      class AddActionFormField < Pdfrb::Model::Cos::Dictionary
+        arlington_object "AddActionFormField"
+
+        # /K — keystroke: format before committing a changed value.
+        def on_keystroke(document = nil)
+          resolve_action(:K, document)
+        end
+
+        # /F — format: reformat after a new value is committed.
+        def on_format(document = nil)
+          resolve_action(:F, document)
+        end
+
+        # /V — validate (recalculate) after the field value changes.
+        def on_validate(document = nil)
+          resolve_action(:V, document)
+        end
+
+        # /C — recalculate when another field changes.
+        def on_calculate(document = nil)
+          resolve_action(:C, document)
+        end
+
+        private
+
+        def resolve_action(key, document)
+          ref = value[key]
+          return nil unless ref && document
+
+          ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/add_action_screen_annotation.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Additional Actions for screen annotations (s12.6.3.17, PDF 1.5).
+      # Media events on the screen's region.
+      class AddActionScreenAnnotation < Pdfrb::Model::Cos::Dictionary
+        arlington_object "AddActionScreenAnnotation"
+
+        # /E — cursor enters the screen region.
+        def on_cursor_enter(document = nil)
+          resolve_action(:E, document)
+        end
+
+        # /X — cursor exits the screen region.
+        def on_cursor_exit(document = nil)
+          resolve_action(:X, document)
+        end
+
+        # /D — mouse button pressed inside.
+        def on_mouse_down(document = nil)
+          resolve_action(:D, document)
+        end
+
+        # /U — mouse button released inside.
+        def on_mouse_up(document = nil)
+          resolve_action(:U, document)
+        end
+
+        # /PO — page containing the screen is opened.
+        def on_page_open(document = nil)
+          resolve_action(:PO, document)
+        end
+
+        # /PC — page containing the screen is closed.
+        def on_page_close(document = nil)
+          resolve_action(:PC, document)
+        end
+
+        # /PV — screen becomes visible.
+        def on_visible(document = nil)
+          resolve_action(:PV, document)
+        end
+
+        # /PI — screen becomes invisible.
+        def on_invisible(document = nil)
+          resolve_action(:PI, document)
+        end
+
+        private
+
+        def resolve_action(key, document)
+          ref = value[key]
+          return nil unless ref && document
+
+          ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/add_action_widget_annotation.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Additional Actions for widget annotations (s12.6.3.17, PDF 1.2).
+      # Mouse, focus, and page events on the widget's region.
+      class AddActionWidgetAnnotation < Pdfrb::Model::Cos::Dictionary
+        arlington_object "AddActionWidgetAnnotation"
+
+        # /E — cursor enters the widget's region.
+        def on_cursor_enter(document = nil)
+          resolve_action(:E, document)
+        end
+
+        # /X — cursor exits the widget's region.
+        def on_cursor_exit(document = nil)
+          resolve_action(:X, document)
+        end
+
+        # /D — mouse button pressed inside.
+        def on_mouse_down(document = nil)
+          resolve_action(:D, document)
+        end
+
+        # /U — mouse button released inside.
+        def on_mouse_up(document = nil)
+          resolve_action(:U, document)
+        end
+
+        # /Fo — widget receives input focus.
+        def on_focus(document = nil)
+          resolve_action(:Fo, document)
+        end
+
+        # /Bl — widget loses input focus.
+        def on_blur(document = nil)
+          resolve_action(:Bl, document)
+        end
+
+        # /PO — page containing the widget is opened.
+        def on_page_open(document = nil)
+          resolve_action(:PO, document)
+        end
+
+        # /PC — page containing the widget is closed.
+        def on_page_close(document = nil)
+          resolve_action(:PC, document)
+        end
+
+        # /PV — widget becomes visible.
+        def on_visible(document = nil)
+          resolve_action(:PV, document)
+        end
+
+        # /PI — widget becomes invisible.
+        def on_invisible(document = nil)
+          resolve_action(:PI, document)
+        end
+
+        private
+
+        def resolve_action(key, document)
+          ref = value[key]
+          return nil unless ref && document
+
+          ref.is_a?(Pdfrb::Model::Reference) ? document.object(ref) : ref
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/appearance_trap_net.rb

@@ -6,7 +6,7 @@ module Pdfrb
       # AppearanceTrapNet sub-dictionary (s7.7.3.3, Table 327). Per-
       # appearance-stream trap-net (ink-flattening) parameters.
       class AppearanceTrapNetSubDict < Pdfrb::Model::Cos::Dictionary
-        arlington_object "AppearanceTrapNet"
+        arlington_object "AppearanceTrapNetSubDict"
         def pos_h; self[:PosH]; end
         def pos_l; self[:PosL]; end
         def span_h_min; self[:SpanH]; end
@@ -19,8 +19,13 @@ module Pdfrb
       end
 
       # AppearanceTrapNet (s7.7.3.3). The trap-net dictionary that wraps
-      # appearance sub-dicts.
+      # appearance sub-dicts (/N, /R, /D).
       class AppearanceTrapNet < Pdfrb::Model::Cos::Dictionary
+        arlington_object "AppearanceTrapNet"
+        def normal; self[:N]; end
+        def rollover; self[:R]; end
+        def down; self[:D]; end
+
         def type; self[:Type]; end
         def version; self[:Version]; end
         def font_state_appearance; self[:FontStateAppearance]; end
@@ -41,6 +46,7 @@ module Pdfrb
       # AppearanceSubDict (s12.5.4). Sub-dictionary inside Appearance
       # entries /N, /R, /D that maps each appearance state to a stream.
       class AppearanceSubDict < Pdfrb::Model::Cos::Dictionary
+        arlington_object "AppearanceSubDict"
         def each_state(&block)
           return enum_for(:each_state) unless block
 
@@ -64,22 +70,6 @@ module Pdfrb
           !!app_build
         end
       end
-
-      # Annotation Projection dict (s12.5.6.21). Projection annotation
-      # for spatial content.
-      class AnnotationProjectionDict < Pdfrb::Model::Cos::Dictionary
-        def ex_data; self[:ExData]; end
-      end
-
-      # ExData Projection dict (s12.5.6.21, Table 198). Holds the
-      # geospatial projection details used by Projection annotations.
-      class ExDataProjection < Pdfrb::Model::Cos::Dictionary
-        def type; self[:Type]; end
-
-        def project?
-          type == :ProjectedPDL
-        end
-      end
     end
   end
 end

data/lib/pdfrb/model/type/movie_annotation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Movie annotation (s12.5.6.14). /Subtype /Movie. Plays a Movie
+      # when activated.
+      class MovieAnnotation < Annotation
+        arlington_object "AnnotMovie"
+
+        def movie; self[:Movie]; end
+        def action; self[:A]; end
+        def title; self[:T]; end
+
+        def has_movie?
+          !movie.nil?
+        end
+
+        def uses_action?
+          !action.nil?
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/projection_annotation.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Projection annotation (s12.5.6.19, PDF 1.7+AdobeExt). Projects
+      # a duplicate of a region of a page with a modified appearance.
+      class ProjectionAnnotation < MarkupAnnotation
+        arlington_object "AnnotProjection"
+
+        def title; self[:T]; end
+        def popup; self[:Popup]; end
+        def rich_contents; self[:RC]; end
+        def creation_date; self[:CreationDate]; end
+        def in_reply_to; self[:IRT]; end
+        def subject; self[:Subj]; end
+        def reply_type; self[:RT]; end
+        def intent; self[:IT]; end
+        def ex_data; self[:ExData]; end
+
+        def has_projection_data?
+          !ex_data.nil?
+        end
+      end
+
+      # Annotation Projection dict (s12.5.6.21). Projection annotation
+      # for spatial content.
+      class AnnotationProjectionDict < Pdfrb::Model::Cos::Dictionary
+        def ex_data; self[:ExData]; end
+      end
+
+      # ExData Projection dict (s12.5.6.21, Table 198). Holds the
+      # geospatial projection details used by Projection annotations.
+      class ExDataProjection < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+
+        def project?
+          type == :ProjectedPDL
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/three_d_annotation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # 3D annotation (s13.6.2, PDF 1.6+). /Subtype /3D. Hosts a 3D
+      # artwork stream, activation behaviour, and viewing state.
+      class ThreeDAnnotation < Annotation
+        arlington_object "Annot3D"
+
+        def artwork; self[:"3DD"]; end
+        def default_view; self[:"3DV"]; end
+        def activation; self[:"3DA"]; end
+        def interactive; self[:"3DI"]; end
+        def view_box; self[:"3DB"]; end
+        def units; self[:"3DU"]; end
+        def geometry; self[:GEO]; end
+
+        def interactive?
+          interactive == true
+        end
+
+        def has_measure?
+          !geometry.nil?
+        end
+
+        def default_view_name?
+          default_view.is_a?(Symbol) || default_view.is_a?(String)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/trap_network_annotation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Trap network annotation (s14.11.5). Marks the extent of the
+      # trap network applied by a prepress system. Its appearance
+      # stream carries per-colorant trap parameters.
+      class TrapNetworkAnnotation < MarkupAnnotation
+        arlington_object "AnnotTrapNetwork"
+
+        def last_modified; self[:LastModified]; end
+        def version; self[:Version]; end
+        def annot_states; self[:AnnotStates]; end
+        def font_fauxing; self[:FontFauxing]; end
+
+        def annot_states?
+          !annot_states.nil?
+        end
+
+        def fauxed_font_names
+          fonts = font_fauxing
+          fonts.is_a?(Pdfrb::Model::PdfArray) ? fonts.to_a : fonts
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type.rb

@@ -201,6 +201,10 @@ module Pdfrb
       autoload :PrinterMarkSubDict, "pdfrb/model/type/transition"
       autoload :ScreenAnnotation, "pdfrb/model/type/screen_annotation"
       autoload :SoundAnnotation, "pdfrb/model/type/sound_annotation"
+      autoload :ThreeDAnnotation, "pdfrb/model/type/three_d_annotation"
+      autoload :MovieAnnotation, "pdfrb/model/type/movie_annotation"
+      autoload :ProjectionAnnotation, "pdfrb/model/type/projection_annotation"
+      autoload :TrapNetworkAnnotation, "pdfrb/model/type/trap_network_annotation"
 
       # Rich Media annotation family (s13.6).
       autoload :RichMediaAnnotation, "pdfrb/model/type/rich_media_annotation"
@@ -270,6 +274,7 @@ module Pdfrb
       autoload :ActionGoTo3DView, "pdfrb/model/type/action_go_to_3d_view"
       autoload :ActionGoToDp, "pdfrb/model/type/action_go_to_dp"
       autoload :ActionRichMediaExecute, "pdfrb/model/type/action_rich_media_execute"
+      autoload :ActionGoToE, "pdfrb/model/type/action_go_to_e"
       autoload :ActionNOP, "pdfrb/model/type/action_nop"
 
       # Signature family (s12.8).
@@ -286,8 +291,8 @@ module Pdfrb
       autoload :AppearanceSubDict, "pdfrb/model/type/appearance_trap_net"
       autoload :MediaClip, "pdfrb/model/type/media_clip"
       autoload :Rendition, "pdfrb/model/type/rendition"
-      autoload :ExDataProjection, "pdfrb/model/type/appearance_trap_net"
-      autoload :AnnotationProjectionDict, "pdfrb/model/type/appearance_trap_net"
+      autoload :ExDataProjection, "pdfrb/model/type/projection_annotation"
+      autoload :AnnotationProjectionDict, "pdfrb/model/type/projection_annotation"
 
       # Media offset / player / screen types.
       autoload :MediaOffsetTime, "pdfrb/model/type/media_offset"
@@ -405,6 +410,12 @@ module Pdfrb
       # Additional actions on page objects (s12.6.3.16).
       autoload :AddActionPageObject, "pdfrb/model/type/add_action_page_object"
 
+      # Additional actions on form fields / screen + widget annotations
+      # (s12.6.3.17).
+      autoload :AddActionFormField, "pdfrb/model/type/add_action_form_field"
+      autoload :AddActionScreenAnnotation, "pdfrb/model/type/add_action_screen_annotation"
+      autoload :AddActionWidgetAnnotation, "pdfrb/model/type/add_action_widget_annotation"
+
       # Border style (s12.5.4). BorderEffect lives in its own file.
       autoload :BorderStyle, "pdfrb/model/type/border_style"
       autoload :BorderEffect, "pdfrb/model/type/border_effect"

data/lib/pdfrb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pdfrb
-  VERSION = "0.7.22"
+  VERSION = "0.7.23"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdfrb
 version: !ruby/object:Gem::Version
-  version: 0.7.22
+  version: 0.7.23
 platform: ruby
 authors:
 - Ribose Inc.
@@ -956,6 +956,7 @@ files:
 - lib/pdfrb/model/type/action.rb
 - lib/pdfrb/model/type/action_go_to_3d_view.rb
 - lib/pdfrb/model/type/action_go_to_dp.rb
+- lib/pdfrb/model/type/action_go_to_e.rb
 - lib/pdfrb/model/type/action_go_to_r.rb
 - lib/pdfrb/model/type/action_goto.rb
 - lib/pdfrb/model/type/action_hide.rb
@@ -977,7 +978,10 @@ files:
 - lib/pdfrb/model/type/action_trans.rb
 - lib/pdfrb/model/type/action_uri.rb
 - lib/pdfrb/model/type/add_action_catalog.rb
+- lib/pdfrb/model/type/add_action_form_field.rb
 - lib/pdfrb/model/type/add_action_page_object.rb
+- lib/pdfrb/model/type/add_action_screen_annotation.rb
+- lib/pdfrb/model/type/add_action_widget_annotation.rb
 - lib/pdfrb/model/type/af_embedded_file.rb
 - lib/pdfrb/model/type/af_file_specification.rb
 - lib/pdfrb/model/type/alternate_image.rb
@@ -1079,6 +1083,7 @@ files:
 - lib/pdfrb/model/type/metadata.rb
 - lib/pdfrb/model/type/misc_helpers.rb
 - lib/pdfrb/model/type/movie.rb
+- lib/pdfrb/model/type/movie_annotation.rb
 - lib/pdfrb/model/type/names.rb
 - lib/pdfrb/model/type/namespace.rb
 - lib/pdfrb/model/type/object_reference.rb
@@ -1105,6 +1110,7 @@ files:
 - lib/pdfrb/model/type/polyline_annotation.rb
 - lib/pdfrb/model/type/popup_annotation.rb
 - lib/pdfrb/model/type/printer_mark_annotation.rb
+- lib/pdfrb/model/type/projection_annotation.rb
 - lib/pdfrb/model/type/redact_annotation.rb
 - lib/pdfrb/model/type/rendition.rb
 - lib/pdfrb/model/type/resources.rb
@@ -1146,6 +1152,7 @@ files:
 - lib/pdfrb/model/type/thread.rb
 - lib/pdfrb/model/type/three_d_activation.rb
 - lib/pdfrb/model/type/three_d_animation_style.rb
+- lib/pdfrb/model/type/three_d_annotation.rb
 - lib/pdfrb/model/type/three_d_background.rb
 - lib/pdfrb/model/type/three_d_cross_section.rb
 - lib/pdfrb/model/type/three_d_lighting_scheme.rb
@@ -1165,6 +1172,7 @@ files:
 - lib/pdfrb/model/type/timespan.rb
 - lib/pdfrb/model/type/to_unicode_cmap_stream.rb
 - lib/pdfrb/model/type/transition.rb
+- lib/pdfrb/model/type/trap_network_annotation.rb
 - lib/pdfrb/model/type/trap_region.rb
 - lib/pdfrb/model/type/underline_annotation.rb
 - lib/pdfrb/model/type/ur_transform_parameters.rb