Class: GroupDocsSignatureCloud::TextFormFieldSignature

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/models/text_form_field_signature.rb

Overview

Contains text input form field signature properties for Pdf Document

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextFormFieldSignature

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 134

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'SignatureType')
    self.signature_type = attributes[:'SignatureType']
  end

  if attributes.key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end

  if attributes.key?(:'SignatureId')
    self.signature_id = attributes[:'SignatureId']
  end

  if attributes.key?(:'IsSignature')
    self.is_signature = attributes[:'IsSignature']
  end

  if attributes.key?(:'CreatedOn')
    self.created_on = attributes[:'CreatedOn']
  end

  if attributes.key?(:'ModifiedOn')
    self.modified_on = attributes[:'ModifiedOn']
  end

  if attributes.key?(:'Top')
    self.top = attributes[:'Top']
  end

  if attributes.key?(:'Left')
    self.left = attributes[:'Left']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.key?(:'Type')
    self.type = attributes[:'Type']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end

end

Instance Attribute Details

#created_on ⇒ Object

Get or set the signature creation date



47
48
49
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 47

def created_on
  @created_on
end

#height ⇒ Object

Specifies height of signature



62
63
64
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 62

def height
  @height
end

#is_signature ⇒ Object

Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).



44
45
46
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 44

def is_signature
  @is_signature
end

#left ⇒ Object

Specifies left position of signature



56
57
58
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 56

def left
  @left
end

#modified_on ⇒ Object

Get or set the signature modification date



50
51
52
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 50

def modified_on
  @modified_on
end

#name ⇒ Object

Specifies unique form field name



65
66
67
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 65

def name
  @name
end

#page_number ⇒ Object

Specifies the page signature was found on



38
39
40
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 38

def page_number
  @page_number
end

#signature_id ⇒ Object

Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.



41
42
43
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 41

def signature_id
  @signature_id
end

#signature_type ⇒ Object

Specifies the signature type (Text, Image, Digital, Barcode, QRCode, Stamp)



35
36
37
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 35

def signature_type
  @signature_type
end

#text ⇒ Object

Gets or sets text of form field text input



71
72
73
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 71

def text
  @text
end

#top ⇒ Object

Specifies top position of signature



53
54
55
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 53

def top
  @top
end

#type ⇒ Object

Specifies Form field type



68
69
70
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 68

def type
  @type
end

#width ⇒ Object

Specifies width of signature



59
60
61
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 59

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 95

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'page_number' => :'PageNumber',
    :'signature_id' => :'SignatureId',
    :'is_signature' => :'IsSignature',
    :'created_on' => :'CreatedOn',
    :'modified_on' => :'ModifiedOn',
    :'top' => :'Top',
    :'left' => :'Left',
    :'width' => :'Width',
    :'height' => :'Height',
    :'name' => :'Name',
    :'type' => :'Type',
    :'text' => :'Text'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 114

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'page_number' => :'Integer',
    :'signature_id' => :'String',
    :'is_signature' => :'BOOLEAN',
    :'created_on' => :'DateTime',
    :'modified_on' => :'DateTime',
    :'top' => :'Integer',
    :'left' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'name' => :'String',
    :'type' => :'String',
    :'text' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 286

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      signature_type == other.signature_type &&
      page_number == other.page_number &&
      signature_id == other.signature_id &&
      is_signature == other.is_signature &&
      created_on == other.created_on &&
      modified_on == other.modified_on &&
      top == other.top &&
      left == other.left &&
      width == other.width &&
      height == other.height &&
      name == other.name &&
      type == other.type &&
      text == other.text
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 349

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.parse value
  when :Date
    Date.parse value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else
  # model
    # Signature type fix
    ttype = type
    if value.is_a?(Hash) and !value[:signatureType].nil?
      ttype = value[:signatureType] + 'Signature'
      if value[:signatureType] == 'FormField' and !value[:type].nil?
        type = value[:type]
        if type == 'Checkbox'
          ttype = 'CheckboxFormFieldSignature'
        end
        if type == 'Text'
          ttype = 'TextFormFieldSignature'
        end
        if type == 'Combobox'
          ttype = 'ComboboxFormFieldSignature'
        end
        if type == 'DigitalSignature'
          ttype = 'DigitalFormFieldSignature'
        end
        if type == 'Radio'
          ttype = 'RadioButtonFormFieldSignature'
        end
      end
    end      
    temp_model = GroupDocsSignatureCloud.const_get(ttype).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 439

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 325

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not                    
      if value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?                  
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 306

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



312
313
314
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 312

def hash
  [signature_type, page_number, signature_id, is_signature, created_on, modified_on, top, left, width, height, name, type, text].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 196

def list_invalid_properties
  invalid_properties = []
  if @signature_type.nil?
    invalid_properties.push("invalid value for 'signature_type', signature_type cannot be nil.")
  end

  if @is_signature.nil?
    invalid_properties.push("invalid value for 'is_signature', is_signature cannot be nil.")
  end

  if @created_on.nil?
    invalid_properties.push("invalid value for 'created_on', created_on cannot be nil.")
  end

  if @modified_on.nil?
    invalid_properties.push("invalid value for 'modified_on', modified_on cannot be nil.")
  end

  if @top.nil?
    invalid_properties.push("invalid value for 'top', top cannot be nil.")
  end

  if @left.nil?
    invalid_properties.push("invalid value for 'left', left cannot be nil.")
  end

  if @width.nil?
    invalid_properties.push("invalid value for 'width', width cannot be nil.")
  end

  if @height.nil?
    invalid_properties.push("invalid value for 'height', height cannot be nil.")
  end

  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



419
420
421
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 419

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



425
426
427
428
429
430
431
432
433
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 425

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



413
414
415
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 413

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



318
319
320
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 318

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/groupdocs_signature_cloud/models/text_form_field_signature.rb', line 239

def valid?
  return false if @signature_type.nil?
  signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
  return false unless signature_type_validator.valid?(@signature_type)
  return false if @is_signature.nil?
  return false if @created_on.nil?
  return false if @modified_on.nil?
  return false if @top.nil?
  return false if @left.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["Text", "Checkbox", "Combobox", "DigitalSignature", "Radio", "None"])
  return false unless type_validator.valid?(@type)
  return true
end