Class: HexaPDF::Type::AcroForm::TextField

Inherits:
VariableTextField show all
Defined in:
lib/hexapdf/type/acro_form/text_field.rb

Overview

AcroForm text fields provide a box or space to fill-in data entered from keyboard. The text may be restricted to a single line or can span multiple lines.

A special type of single-line text field is the comb text field. This type of field divides the existing space into /MaxLen equally spaced positions.

Type Specific Field Flags

:multiline

If set, the text field may contain multiple lines.

:password

The field is a password field. This changes the behaviour of the PDF reader application to not echo the input text and to not store it in the PDF file.

:file_select

The text field represents a file selection control where the input text is the path to a file.

:do_not_spell_check

The text should not be spell-checked.

:do_not_scroll

The text field should not scroll (horizontally for single-line fields and vertically for multiline fields) to accomodate more text than fits into the annotation rectangle. This means that no more text can be entered once the field is full.

:comb

The field is divided into /MaxLen equally spaced positions (so /MaxLen needs to be set). This is useful, for example, when entering things like social security numbers which always have the same length.

:rich_text

The field is a rich text field.

See: PDF1.7 s12.7.4.3

Constant Summary collapse

INHERITABLE_FIELDS =

All inheritable dictionary fields for text fields.

(superclass::INHERITABLE_FIELDS + [:MaxLen]).freeze
FLAGS_BIT_MAPPING =

Updated list of field flags.

superclass::FLAGS_BIT_MAPPING.merge(
  {
    multiline: 12,
    password: 13,
    file_select: 20,
    do_not_spell_check: 22,
    do_not_scroll: 23,
    comb: 24,
    rich_text: 25,
  }
).freeze

Constants inherited from VariableTextField

VariableTextField::UNSET_ARG

Constants included from DictionaryFields

DictionaryFields::Boolean, DictionaryFields::PDFByteString, DictionaryFields::PDFDate

Instance Attribute Summary

Attributes inherited from Object

#data, #document, #must_be_indirect

Instance Method Summary collapse

Methods inherited from VariableTextField

#parse_default_appearance_string, #set_default_appearance_string, #text_alignment

Methods inherited from Field

#[], #alternate_field_name, #alternate_field_name=, #create_widget, #delete_widget, #each_widget, #embedded_widget?, #field_name, #field_type, #flags, #full_field_name, inherited_value, #must_be_indirect?, #terminal_field?

Methods included from Utils::BitField

#bit_field

Methods inherited from Dictionary

#[], #[]=, define_field, define_type, #delete, #each, each_field, #empty?, field, #key?, #to_h, type, #type

Methods inherited from Object

#<=>, #==, #cache, #cached?, #clear_cache, deep_copy, #deep_copy, #document?, #eql?, #gen, #gen=, #hash, #indirect?, #initialize, #inspect, #must_be_indirect?, #null?, #oid, #oid=, #type, #validate, #value, #value=

Constructor Details

This class inherits a constructor from HexaPDF::Object

Instance Method Details

#comb_text_field? ⇒ Boolean

Returns true if this field is a comb text field.

Returns:



137
138
139
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 137

def comb_text_field?
  flagged?(:comb) && !(flagged?(:file_select) || flagged?(:multiline) || flagged?(:password))
end

#concrete_field_type ⇒ Object

Returns the concrete text field type, either :single_line_text_field, :multiline_text_field, :password_field, :file_select_field, :comb_text_field or :rich_text_field.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 190

def concrete_field_type
  if flagged?(:multiline)
    :multiline_text_field
  elsif flagged?(:password)
    :password_field
  elsif flagged?(:file_select)
    :file_select_field
  elsif flagged?(:comb)
    :comb_text_field
  elsif flagged?(:rich_text)
    :rich_text_field
  else
    :single_line_text_field
  end
end

#create_appearances(force: false) ⇒ Object

Creates appropriate appearances for all widgets.

For information on how this is done see AppearanceGenerator.

Note that no new appearances are created if the field value hasn’t changed between invocations.

By setting force to true the creation of the appearances can be forced.



214
215
216
217
218
219
220
221
222
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 214

def create_appearances(force: false)
  current_value = field_value
  appearance_generator_class = document.config.constantize('acro_form.appearance_generator')
  each_widget do |widget|
    next if !force && widget.cached?(:last_value) && widget.cache(:last_value) == current_value
    widget.cache(:last_value, current_value, update: true)
    appearance_generator_class.new(widget).create_text_appearances
  end
end

#default_field_value ⇒ Object

Returns the default field value.

See: #field_value



176
177
178
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 176

def default_field_value
  self[:DV].kind_of?(String) ? self[:DV] : self[:DV].stream
end

#default_field_value=(str) ⇒ Object

Sets the default field value.

See: #field_value=



183
184
185
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 183

def default_field_value=(str)
  self[:DV] = str
end

#field_value ⇒ Object

Returns the field value, i.e. the text contents of the field, or nil if no value is set.

Note that modifying the returned value *might not* modify the text contents in case it is stored as stream! So always use #field_value= to set the field value.



155
156
157
158
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 155

def field_value
  return unless value[:V]
  self[:V].kind_of?(String) ? self[:V] : self[:V].stream
end

#field_value=(str) ⇒ Object

Sets the field value, i.e. the text contents of the field, to the given string.

Note that for single line text fields, all whitespace characters are changed to simple spaces.



164
165
166
167
168
169
170
171
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 164

def field_value=(str)
  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
  self[:V] = str
  update_widgets
end

#file_select_field? ⇒ Boolean

Returns true if this field is a file select field.

Returns:



147
148
149
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 147

def file_select_field?
  flagged?(:file_select) && !(flagged?(:password) || flagged?(:multiline) || flagged?(:comb))
end

#initialize_as_comb_text_field ⇒ Object

Initializes the text field to be a comb text field.

This method should only be called directly after creating a new text field because it doesn’t completely reset the object.



107
108
109
110
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 107

def initialize_as_comb_text_field
  flag(:comb)
  unflag(:file_select, :multiline, :password)
end

#initialize_as_file_select_field ⇒ Object

Initializes the text field to be a file select field.

This method should only be called directly after creating a new text field because it doesn’t completely reset the object.



126
127
128
129
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 126

def initialize_as_file_select_field
  flag(:file_select)
  unflag(:comb, :multiline, :password)
end

#initialize_as_multiline_text_field ⇒ Object

Initializes the text field to be a multiline text field.

This method should only be called directly after creating a new text field because it doesn’t completely reset the object.



98
99
100
101
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 98

def initialize_as_multiline_text_field
  flag(:multiline)
  unflag(:file_select, :comb, :password)
end

#initialize_as_password_field ⇒ Object

Initializes the text field to be a password field.

This method should only be called directly after creating a new text field because it doesn’t completely reset the object.



116
117
118
119
120
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 116

def initialize_as_password_field
  delete(:V)
  flag(:password)
  unflag(:comb, :multiline, :file_select)
end

#multiline_text_field? ⇒ Boolean

Returns true if this field is a multiline text field.

Returns:



132
133
134
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 132

def multiline_text_field?
  flagged?(:multiline) && !(flagged?(:file_select) || flagged?(:comb) || flagged?(:password))
end

#password_field? ⇒ Boolean

Returns true if this field is a password field.

Returns:



142
143
144
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 142

def password_field?
  flagged?(:password) && !(flagged?(:file_select) || flagged?(:multiline) || flagged?(:comb))
end

#update_widgets ⇒ Object

Updates the widgets so that they reflect the current field value.



225
226
227
 
# File 'lib/hexapdf/type/acro_form/text_field.rb', line 225

def update_widgets
  create_appearances
end