Class: GroupDocsSignatureCloud::PdfDigitalSignatureAppearance

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

Overview

Describes appearance of Digital Signature are on PDF documents.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfDigitalSignatureAppearance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 119

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

  if attributes.key?(:'Background')
    self.background = attributes[:'Background']
  end

  if attributes.key?(:'Foreground')
    self.foreground = attributes[:'Foreground']
  end

  if attributes.key?(:'ContactInfoLabel')
    self.contact_info_label = attributes[:'ContactInfoLabel']
  end

  if attributes.key?(:'DateSignedAtLabel')
    self.date_signed_at_label = attributes[:'DateSignedAtLabel']
  end

  if attributes.key?(:'DigitalSignedLabel')
    self.digital_signed_label = attributes[:'DigitalSignedLabel']
  end

  if attributes.key?(:'FontFamilyName')
    self.font_family_name = attributes[:'FontFamilyName']
  end

  if attributes.key?(:'FontSize')
    self.font_size = attributes[:'FontSize']
  end

  if attributes.key?(:'LocationLabel')
    self.location_label = attributes[:'LocationLabel']
  end

  if attributes.key?(:'ReasonLabel')
    self.reason_label = attributes[:'ReasonLabel']
  end

end

Instance Attribute Details

#appearance_type ⇒ Object

Specifies the type of appearance



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

def appearance_type
  @appearance_type
end

#background ⇒ Object

Get or set background color of signature appearance.



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

def background
  @background
end

#contact_info_label ⇒ Object

Gets or sets contact info label. Default value: "Contact". if this value is empty then no contact label will appear on digital signature area.



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

def contact_info_label
  @contact_info_label
end

#date_signed_at_label ⇒ Object

Gets or sets date signed label. Default value: "Date".



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

def date_signed_at_label
  @date_signed_at_label
end

#digital_signed_label ⇒ Object

Gets or sets digital signed label. Default value: "Digitally signed by".



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

def digital_signed_label
  @digital_signed_label
end

#font_family_name ⇒ Object

Gets or sets the Font family name to display the labels. Default value is "Arial".



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

def font_family_name
  @font_family_name
end

#font_size ⇒ Object

Gets or sets the Font size to display the labels. Default value is 10.



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

def font_size
  @font_size
end

#foreground ⇒ Object

Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255)



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

def foreground
  @foreground
end

#location_label ⇒ Object

Gets or sets location label. Default value: "Location". if this value is empty then no location label will appear on digital signature area.



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

def location_label
  @location_label
end

#reason_label ⇒ Object

Gets or sets reason label. Default value: "Reason". if this value is empty then no reason label will appear on digital signature area.



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

def reason_label
  @reason_label
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 86

def self.attribute_map
  {
    :'appearance_type' => :'AppearanceType',
    :'background' => :'Background',
    :'foreground' => :'Foreground',
    :'contact_info_label' => :'ContactInfoLabel',
    :'date_signed_at_label' => :'DateSignedAtLabel',
    :'digital_signed_label' => :'DigitalSignedLabel',
    :'font_family_name' => :'FontFamilyName',
    :'font_size' => :'FontSize',
    :'location_label' => :'LocationLabel',
    :'reason_label' => :'ReasonLabel'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 102

def self.swagger_types
  {
    :'appearance_type' => :'String',
    :'background' => :'Color',
    :'foreground' => :'Color',
    :'contact_info_label' => :'String',
    :'date_signed_at_label' => :'String',
    :'digital_signed_label' => :'String',
    :'font_family_name' => :'String',
    :'font_size' => :'Float',
    :'location_label' => :'String',
    :'reason_label' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 203

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      appearance_type == other.appearance_type &&
      background == other.background &&
      foreground == other.foreground &&
      contact_info_label == other.contact_info_label &&
      date_signed_at_label == other.date_signed_at_label &&
      digital_signed_label == other.digital_signed_label &&
      font_family_name == other.font_family_name &&
      font_size == other.font_size &&
      location_label == other.location_label &&
      reason_label == other.reason_label
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



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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 263

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 353

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



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

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


220
221
222
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 220

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 226

def hash
  [appearance_type, background, foreground, contact_info_label, date_signed_at_label, digital_signed_label, font_family_name, font_size, location_label, reason_label].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



169
170
171
172
173
174
175
176
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 169

def list_invalid_properties
  invalid_properties = []
  if @appearance_type.nil?
    invalid_properties.push("invalid value for 'appearance_type', appearance_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



333
334
335
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 339

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



327
328
329
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 327

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



232
233
234
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 232

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



180
181
182
183
184
185
 
# File 'lib/groupdocs_signature_cloud/models/pdf_digital_signature_appearance.rb', line 180

def valid?
  return false if @appearance_type.nil?
  appearance_type_validator = EnumAttributeValidator.new('String', ["Undefined", "PdfTextAnnotation", "PdfTextSticker", "Image", "DigitalSignature", "PdfDigitalSignature"])
  return false unless appearance_type_validator.valid?(@appearance_type)
  return true
end