Class: AsposePdfCloud::SignatureCustomAppearance

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/signature_custom_appearance.rb

Overview

An abstract class which represents signature custom appearance object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureCustomAppearance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 128

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

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

  if attributes.has_key?(:'Rotation')
    self.rotation = attributes[:'Rotation']
  end

  if attributes.has_key?(:'ShowContactInfo')
    self.show_contact_info = attributes[:'ShowContactInfo']
  end

  if attributes.has_key?(:'ShowReason')
    self.show_reason = attributes[:'ShowReason']
  end

  if attributes.has_key?(:'ShowLocation')
    self.show_location = attributes[:'ShowLocation']
  end

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

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

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

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

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

  if attributes.has_key?(:'DateTimeLocalFormat')
    self.date_time_local_format = attributes[:'DateTimeLocalFormat']
  end

  if attributes.has_key?(:'DateTimeFormat')
    self.date_time_format = attributes[:'DateTimeFormat']
  end

  if attributes.has_key?(:'BackgroundColor')
    self.background_color = attributes[:'BackgroundColor']
  end

  if attributes.has_key?(:'ForegroundColor')
    self.foreground_color = attributes[:'ForegroundColor']
  end

  if attributes.has_key?(:'UseDigitalSubjectFormat')
    self.use_digital_subject_format = attributes[:'UseDigitalSubjectFormat']
  end

  if attributes.has_key?(:'DigitalSubjectFormat')
    if (value = attributes[:'DigitalSubjectFormat']).is_a?(Array)
      self.digital_subject_format = value
    end
  end

end

Instance Attribute Details

#background_color ⇒ Object

Gets/sets background color.



68
69
70
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 68

def background_color
  @background_color
end

#contact_info_label ⇒ Object

Gets/sets contact info label. Default value: "Contact".



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 47

def contact_info_label
  @contact_info_label
end

#date_signed_at_label ⇒ Object

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



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 59

def date_signed_at_label
  @date_signed_at_label
end

#date_time_format ⇒ Object

Gets/sets datetime format. Default value: "yyyy.MM.dd HH:mm:ss".



65
66
67
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 65

def date_time_format
  @date_time_format
end

#date_time_local_format ⇒ Object

Gets/sets datetime local format. Default value: "yyyy.MM.dd HH:mm:ss zzz".



62
63
64
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 62

def date_time_local_format
  @date_time_local_format
end

#digital_signed_label ⇒ Object

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



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 56

def digital_signed_label
  @digital_signed_label
end

#digital_subject_format ⇒ Object

Gets/sets subject format.



77
78
79
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 77

def digital_subject_format
  @digital_subject_format
end

#font_family_name ⇒ Object

Gets/sets font family name. It should be existed in the document. Default value: Arial.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 29

def font_family_name
  @font_family_name
end

#font_size ⇒ Object

Gets/sets font size. Default value: 10.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 32

def font_size
  @font_size
end

#foreground_color ⇒ Object

Gets/sets foreground color.



71
72
73
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 71

def foreground_color
  @foreground_color
end

#location_label ⇒ Object

Gets/sets location label. Default value: "Location".



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 53

def location_label
  @location_label
end

#reason_label ⇒ Object

Gets/sets reason label. Default value: "Reason".



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 50

def reason_label
  @reason_label
end

#rotation ⇒ Object

Gets or sets signature rotation.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 35

def rotation
  @rotation
end

#show_contact_info ⇒ Object

Gets/sets contact info visibility. Default value: true.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 38

def show_contact_info
  @show_contact_info
end

#show_location ⇒ Object

Gets/sets location visibility. Default value: true.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 44

def show_location
  @show_location
end

#show_reason ⇒ Object

Gets/sets reason visibility. Default value: true.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 41

def show_reason
  @show_reason
end

#use_digital_subject_format ⇒ Object

Gets/sets subject format usage.



74
75
76
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 74

def use_digital_subject_format
  @use_digital_subject_format
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 81

def self.attribute_map
  {
    :'font_family_name' => :'FontFamilyName',
    :'font_size' => :'FontSize',
    :'rotation' => :'Rotation',
    :'show_contact_info' => :'ShowContactInfo',
    :'show_reason' => :'ShowReason',
    :'show_location' => :'ShowLocation',
    :'contact_info_label' => :'ContactInfoLabel',
    :'reason_label' => :'ReasonLabel',
    :'location_label' => :'LocationLabel',
    :'digital_signed_label' => :'DigitalSignedLabel',
    :'date_signed_at_label' => :'DateSignedAtLabel',
    :'date_time_local_format' => :'DateTimeLocalFormat',
    :'date_time_format' => :'DateTimeFormat',
    :'background_color' => :'BackgroundColor',
    :'foreground_color' => :'ForegroundColor',
    :'use_digital_subject_format' => :'UseDigitalSubjectFormat',
    :'digital_subject_format' => :'DigitalSubjectFormat'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 104

def self.swagger_types
  {
    :'font_family_name' => :'String',
    :'font_size' => :'Float',
    :'rotation' => :'Rotation',
    :'show_contact_info' => :'BOOLEAN',
    :'show_reason' => :'BOOLEAN',
    :'show_location' => :'BOOLEAN',
    :'contact_info_label' => :'String',
    :'reason_label' => :'String',
    :'location_label' => :'String',
    :'digital_signed_label' => :'String',
    :'date_signed_at_label' => :'String',
    :'date_time_local_format' => :'String',
    :'date_time_format' => :'String',
    :'background_color' => :'Color',
    :'foreground_color' => :'Color',
    :'use_digital_subject_format' => :'BOOLEAN',
    :'digital_subject_format' => :'Array<SignatureSubjectNameElements>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      font_family_name == o.font_family_name &&
      font_size == o.font_size &&
      rotation == o.rotation &&
      show_contact_info == o.show_contact_info &&
      show_reason == o.show_reason &&
      show_location == o.show_location &&
      contact_info_label == o.contact_info_label &&
      reason_label == o.reason_label &&
      location_label == o.location_label &&
      digital_signed_label == o.digital_signed_label &&
      date_signed_at_label == o.date_signed_at_label &&
      date_time_local_format == o.date_time_local_format &&
      date_time_format == o.date_time_format &&
      background_color == o.background_color &&
      foreground_color == o.foreground_color &&
      use_digital_subject_format == o.use_digital_subject_format &&
      digital_subject_format == o.digital_subject_format
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



304
305
306
307
308
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
337
338
339
340
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 304

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = AsposePdfCloud.const_get(type).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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 370

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 283

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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 attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



276
277
278
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 276

def hash
  [font_family_name, font_size, rotation, show_contact_info, show_reason, show_location, contact_info_label, reason_label, location_label, digital_signed_label, date_signed_at_label, date_time_local_format, date_time_format, background_color, foreground_color, use_digital_subject_format, digital_subject_format].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 208

def list_invalid_properties
  invalid_properties = Array.new
  if @rotation.nil?
    invalid_properties.push("invalid value for 'rotation', rotation cannot be nil.")
  end

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

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

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

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



350
351
352
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 350

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



356
357
358
359
360
361
362
363
364
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 356

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



344
345
346
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 344

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



235
236
237
238
239
240
241
242
 
# File 'lib/aspose_pdf_cloud/models/signature_custom_appearance.rb', line 235

def valid?
  return false if @rotation.nil?
  return false if @show_contact_info.nil?
  return false if @show_reason.nil?
  return false if @show_location.nil?
  return false if @use_digital_subject_format.nil?
  return true
end