Class: HexaPDF::DictionaryFields::Field

Inherits:
Object
  • Object
show all
Defined in:
lib/hexapdf/dictionary_fields.rb

Overview

A dictionary field contains information about one field of a structured PDF object and this information comes directly from the PDF specification.

By incorporating this field information into HexaPDF it is possible to do many things automatically, like checking for the correct minimum PDF version to use or converting a date from its string representation to a Time object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, required: false, default: nil, indirect: nil, allowed_values: nil, version: nil) ⇒ Field

Create a new Field object. See Dictionary::define_field for information on the arguments.

Depending on the type entry an appropriate field converter object is chosen from the available converters.



116
117
118
119
120
121
122
123
 
# File 'lib/hexapdf/dictionary_fields.rb', line 116

def initialize(type, required: false, default: nil, indirect: nil, allowed_values: nil,
               version: nil)
  @type = [type].flatten
  @type_mapped = false
  @required, @default, @indirect, @version = required, default, indirect, version
  @allowed_values = allowed_values && [allowed_values].flatten
  @converters = @type.map {|t| self.class.converter_for(t) }.compact
end

Instance Attribute Details

#allowed_values ⇒ Object (readonly)

Returns an array with the allowed values for this field, or nil if the values are not constrained.



107
108
109
 
# File 'lib/hexapdf/dictionary_fields.rb', line 107

def allowed_values
  @allowed_values
end

#indirect ⇒ Object (readonly)

Returns true if the value for this field needs to be an indirect object, false if it needs to be a direct object or nil if it can be either.



103
104
105
 
# File 'lib/hexapdf/dictionary_fields.rb', line 103

def indirect
  @indirect
end

#version ⇒ Object (readonly)

Returns the PDF version that is required for this field.



110
111
112
 
# File 'lib/hexapdf/dictionary_fields.rb', line 110

def version
  @version
end

Class Method Details

.converter_for(type) ⇒ Object

Returns the converter for the given type specification.

The converter list is checked for a suitable converter from the front to the back. So if two converters could potentially be used for the same type, the one that appears earlier is used.



97
98
99
 
# File 'lib/hexapdf/dictionary_fields.rb', line 97

def self.converter_for(type)
  @converters.find {|converter| converter.usable_for?(type) }
end

.converters ⇒ Object

Returns the list of available converter objects.

See ::converter_for for information on how this list is used.



88
89
90
 
# File 'lib/hexapdf/dictionary_fields.rb', line 88

def self.converters
  @converters ||= []
end

Instance Method Details

#convert(data, document) ⇒ Object

Converts the data into a useful object if possible. Otherwise returns nil.



164
165
166
167
168
169
170
 
# File 'lib/hexapdf/dictionary_fields.rb', line 164

def convert(data, document)
  @converters.each do |converter|
    result = converter.convert(data, type, document)
    return result unless result.nil?
  end
  nil
end

#default ⇒ Object

Returns a duplicated default value, automatically taking unduplicatable classes into account.



153
154
155
 
# File 'lib/hexapdf/dictionary_fields.rb', line 153

def default
  @default.dup
end

#default? ⇒ Boolean

Returns true if a default value is available.

Returns:



147
148
149
 
# File 'lib/hexapdf/dictionary_fields.rb', line 147

def default?
  !@default.nil?
end

#required? ⇒ Boolean

Returns true if this field is required.

Returns:



142
143
144
 
# File 'lib/hexapdf/dictionary_fields.rb', line 142

def required?
  @required
end

#type ⇒ Object

Returns the array with valid types for this field.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/hexapdf/dictionary_fields.rb', line 126

def type
  return @type if @type_mapped
  @type.concat(@converters.flat_map(&:additional_types).compact)
  @type.map! do |type|
    if type.kind_of?(Symbol)
      HexaPDF::GlobalConfiguration.constantize('object.type_map', type)
    else
      type
    end
  end
  @type.uniq!
  @type_mapped = true
  @type
end

#valid_object?(obj) ⇒ Boolean

Returns true if the given object is valid for this field.

Returns:



158
159
160
161
 
# File 'lib/hexapdf/dictionary_fields.rb', line 158

def valid_object?(obj)
  type.any? {|t| obj.kind_of?(t) } ||
    (obj.kind_of?(HexaPDF::Object) && type.any? {|t| obj.value.kind_of?(t) })
end