Class: PdfForms::Pdf

Inherits:
Object
  • Object
show all
Includes:
NormalizePath
Defined in:
lib/pdf_forms/pdf.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from NormalizePath

#normalize_path

Constructor Details

#initialize(path, pdftk, options = {}) ⇒ Pdf

Returns a new instance of Pdf.

Raises:

  • (IOError)


11
12
13
14
15
16
# File 'lib/pdf_forms/pdf.rb', line 11

def initialize(path, pdftk, options = {})
  @options = options
  @path = normalize_path(path)
  raise IOError unless File.readable?(@path)
  @pdftk = pdftk
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options.



9
10
11
# File 'lib/pdf_forms/pdf.rb', line 9

def options
  @options
end

#pathObject (readonly)

Returns the value of attribute path.



9
10
11
# File 'lib/pdf_forms/pdf.rb', line 9

def path
  @path
end

Instance Method Details

#field(name) ⇒ Object

the field object for the named field



27
28
29
# File 'lib/pdf_forms/pdf.rb', line 27

def field(name)
  fields.detect{ |f| f.name == name }
end

#fieldsObject

list of field objects for all defined fields

Initialize the object with utf8_fields: true to get utf8 encoded field names.



22
23
24
# File 'lib/pdf_forms/pdf.rb', line 22

def fields
  @fields ||= read_fields
end