Class: GroupDocsSignatureCloud::SignImageOptions

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

Overview

Represents the Image sign options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignImageOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
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
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 164

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?(:'Page')
    self.page = attributes[:'Page']
  end

  if attributes.key?(:'AllPages')
    self.all_pages = attributes[:'AllPages']
  end

  if attributes.key?(:'PagesSetup')
    self.pages_setup = attributes[:'PagesSetup']
  end

  if attributes.key?(:'Appearance')
    self.appearance = attributes[:'Appearance']
  end

  if attributes.key?(:'ImageFilePath')
    self.image_file_path = attributes[:'ImageFilePath']
  end

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

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

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

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

  if attributes.key?(:'LocationMeasureType')
    self.location_measure_type = attributes[:'LocationMeasureType']
  end

  if attributes.key?(:'SizeMeasureType')
    self.size_measure_type = attributes[:'SizeMeasureType']
  end

  if attributes.key?(:'RotationAngle')
    self.rotation_angle = attributes[:'RotationAngle']
  end

  if attributes.key?(:'HorizontalAlignment')
    self.horizontal_alignment = attributes[:'HorizontalAlignment']
  end

  if attributes.key?(:'VerticalAlignment')
    self.vertical_alignment = attributes[:'VerticalAlignment']
  end

  if attributes.key?(:'Margin')
    self.margin = attributes[:'Margin']
  end

  if attributes.key?(:'MarginMeasureType')
    self.margin_measure_type = attributes[:'MarginMeasureType']
  end

  if attributes.key?(:'Transparency')
    self.transparency = attributes[:'Transparency']
  end

  if attributes.key?(:'Border')
    self.border = attributes[:'Border']
  end

end

Instance Attribute Details

#all_pages ⇒ Object

Process all document pages. Type of processing depends on SignatureType For Images Document Type it can be used only for multi-frames images like .tiff



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

def all_pages
  @all_pages
end

#appearance ⇒ Object

Specifies Appearance with additional properties for this options instance



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

def appearance
  @appearance
end

#border ⇒ Object

Gets or sets the signature border properties



89
90
91
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 89

def border
  @border
end

#height ⇒ Object

Height of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType)



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

def height
  @height
end

#horizontal_alignment ⇒ Object

Horizontal alignment of signature on document page



74
75
76
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 74

def horizontal_alignment
  @horizontal_alignment
end

#image_file_path ⇒ Object

Gets or sets the signature image file name. This property is used only if ImageStream is not specified



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

def image_file_path
  @image_file_path
end

#left ⇒ Object

Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (works if horizontal alignment is not specified). For Spreadsheet documents this property is mutually exclusive with Column property. If Left property is set ColumnNumber will be reset to 0



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

def left
  @left
end

#location_measure_type ⇒ Object

Measure type (pixels or percent) for Left and Top properties



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

def location_measure_type
  @location_measure_type
end

#margin ⇒ Object

Gets or sets the space between Sign and Document edges (works ONLY if horizontal or vertical alignment are specified)



80
81
82
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 80

def margin
  @margin
end

#margin_measure_type ⇒ Object

Gets or sets the measure type (pixels or percent) for Margin



83
84
85
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 83

def margin_measure_type
  @margin_measure_type
end

#page ⇒ Object

Gets or sets a document page number for processing. Value is optional



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

def page
  @page
end

#pages_setup ⇒ Object

Options to specify pages for processing



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

def pages_setup
  @pages_setup
end

#rotation_angle ⇒ Object

Rotation angle of signature on document page (clockwise)



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

def rotation_angle
  @rotation_angle
end

#signature_type ⇒ Object

Specifies the signature type of processing



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

def signature_type
  @signature_type
end

#size_measure_type ⇒ Object

Measure type (pixels or percent) for Width and Height properties



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

def size_measure_type
  @size_measure_type
end

#top ⇒ Object

Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (works if vertical alignment is not specified). For Spreadsheet documents this property is mutually exclusive with Row property. If Top property is set RowNumber will be reset to 0



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

def top
  @top
end

#transparency ⇒ Object

Gets or sets the signature transparency(value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).



86
87
88
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 86

def transparency
  @transparency
end

#vertical_alignment ⇒ Object

Vertical alignment of signature on document page



77
78
79
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 77

def vertical_alignment
  @vertical_alignment
end

#width ⇒ Object

Width of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType)



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

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 113

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'page' => :'Page',
    :'all_pages' => :'AllPages',
    :'pages_setup' => :'PagesSetup',
    :'appearance' => :'Appearance',
    :'image_file_path' => :'ImageFilePath',
    :'left' => :'Left',
    :'top' => :'Top',
    :'width' => :'Width',
    :'height' => :'Height',
    :'location_measure_type' => :'LocationMeasureType',
    :'size_measure_type' => :'SizeMeasureType',
    :'rotation_angle' => :'RotationAngle',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'margin' => :'Margin',
    :'margin_measure_type' => :'MarginMeasureType',
    :'transparency' => :'Transparency',
    :'border' => :'Border'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 138

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'page' => :'Integer',
    :'all_pages' => :'BOOLEAN',
    :'pages_setup' => :'PagesSetup',
    :'appearance' => :'SignatureAppearance',
    :'image_file_path' => :'String',
    :'left' => :'Integer',
    :'top' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'location_measure_type' => :'String',
    :'size_measure_type' => :'String',
    :'rotation_angle' => :'Integer',
    :'horizontal_alignment' => :'String',
    :'vertical_alignment' => :'String',
    :'margin' => :'Padding',
    :'margin_measure_type' => :'String',
    :'transparency' => :'Float',
    :'border' => :'BorderLine'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 424

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      signature_type == other.signature_type &&
      page == other.page &&
      all_pages == other.all_pages &&
      pages_setup == other.pages_setup &&
      appearance == other.appearance &&
      image_file_path == other.image_file_path &&
      left == other.left &&
      top == other.top &&
      width == other.width &&
      height == other.height &&
      location_measure_type == other.location_measure_type &&
      size_measure_type == other.size_measure_type &&
      rotation_angle == other.rotation_angle &&
      horizontal_alignment == other.horizontal_alignment &&
      vertical_alignment == other.vertical_alignment &&
      margin == other.margin &&
      margin_measure_type == other.margin_measure_type &&
      transparency == other.transparency &&
      border == other.border
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



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 493

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



583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 583

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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 469

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


450
451
452
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 450

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



456
457
458
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 456

def hash
  [signature_type, page, all_pages, pages_setup, appearance, image_file_path, left, top, width, height, location_measure_type, size_measure_type, rotation_angle, horizontal_alignment, vertical_alignment, margin, margin_measure_type, transparency, border].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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 250

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 @all_pages.nil?
    invalid_properties.push("invalid value for 'all_pages', all_pages cannot be nil.")
  end

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

  if @top.nil?
    invalid_properties.push("invalid value for 'top', top 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 @location_measure_type.nil?
    invalid_properties.push("invalid value for 'location_measure_type', location_measure_type cannot be nil.")
  end

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

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

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

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

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

  if @transparency.nil?
    invalid_properties.push("invalid value for 'transparency', transparency 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



563
564
565
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 563

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



569
570
571
572
573
574
575
576
577
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 569

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



557
558
559
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 557

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



462
463
464
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 462

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/groupdocs_signature_cloud/models/sign_image_options.rb', line 309

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 @all_pages.nil?
  return false if @left.nil?
  return false if @top.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @location_measure_type.nil?
  location_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
  return false unless location_measure_type_validator.valid?(@location_measure_type)
  return false if @size_measure_type.nil?
  size_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
  return false unless size_measure_type_validator.valid?(@size_measure_type)
  return false if @rotation_angle.nil?
  return false if @horizontal_alignment.nil?
  horizontal_alignment_validator = EnumAttributeValidator.new('String', ["None", "Left", "Center", "Right"])
  return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
  return false if @vertical_alignment.nil?
  vertical_alignment_validator = EnumAttributeValidator.new('String', ["None", "Top", "Center", "Bottom"])
  return false unless vertical_alignment_validator.valid?(@vertical_alignment)
  return false if @margin_measure_type.nil?
  margin_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
  return false unless margin_measure_type_validator.valid?(@margin_measure_type)
  return false if @transparency.nil?
  return true
end