Class: GroupDocsSignatureCloud::PdfTextAnnotationAppearance

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

Overview

Describes appearance of PDF text annotation object (Title, Subject, Content).

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfTextAnnotationAppearance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



114
115
116
117
118
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
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 114

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

  if attributes.key?(:'BorderEffect')
    self.border_effect = attributes[:'BorderEffect']
  end

  if attributes.key?(:'BorderEffectIntensity')
    self.border_effect_intensity = attributes[:'BorderEffectIntensity']
  end

  if attributes.key?(:'Contents')
    self.contents = attributes[:'Contents']
  end

  if attributes.key?(:'HCornerRadius')
    self.h_corner_radius = attributes[:'HCornerRadius']
  end

  if attributes.key?(:'Subject')
    self.subject = attributes[:'Subject']
  end

  if attributes.key?(:'Title')
    self.title = attributes[:'Title']
  end

  if attributes.key?(:'VCornerRadius')
    self.v_corner_radius = attributes[:'VCornerRadius']
  end

end

Instance Attribute Details

#appearance_type ⇒ Object

Specifies the type of appearance



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

def appearance_type
  @appearance_type
end

#border ⇒ Object

Represents border appearance



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

def border
  @border
end

#border_effect ⇒ Object

Gets or sets border effect.



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

def border_effect
  @border_effect
end

#border_effect_intensity ⇒ Object

Gets or sets border effect intensity. Valid range of value is [0..2].



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

def border_effect_intensity
  @border_effect_intensity
end

#contents ⇒ Object

Gets or sets content of annotation object.



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

def contents
  @contents
end

#h_corner_radius ⇒ Object

Gets or sets horizontal corner radius.



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

def h_corner_radius
  @h_corner_radius
end

#subject ⇒ Object

Gets or sets Subject representing description of the object.



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

def subject
  @subject
end

#title ⇒ Object

Gets or sets a Title that will be displayed in title bar of annotation object.



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

def title
  @title
end

#v_corner_radius ⇒ Object

Gets or sets vertical corner radius.



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

def v_corner_radius
  @v_corner_radius
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 83

def self.attribute_map
  {
    :'appearance_type' => :'AppearanceType',
    :'border' => :'Border',
    :'border_effect' => :'BorderEffect',
    :'border_effect_intensity' => :'BorderEffectIntensity',
    :'contents' => :'Contents',
    :'h_corner_radius' => :'HCornerRadius',
    :'subject' => :'Subject',
    :'title' => :'Title',
    :'v_corner_radius' => :'VCornerRadius'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'appearance_type' => :'String',
    :'border' => :'BorderLine',
    :'border_effect' => :'String',
    :'border_effect_intensity' => :'Integer',
    :'contents' => :'String',
    :'h_corner_radius' => :'Integer',
    :'subject' => :'String',
    :'title' => :'String',
    :'v_corner_radius' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 230

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      appearance_type == other.appearance_type &&
      border == other.border &&
      border_effect == other.border_effect &&
      border_effect_intensity == other.border_effect_intensity &&
      contents == other.contents &&
      h_corner_radius == other.h_corner_radius &&
      subject == other.subject &&
      title == other.title &&
      v_corner_radius == other.v_corner_radius
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



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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 289

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 379

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 265

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


246
247
248
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 252

def hash
  [appearance_type, border, border_effect, border_effect_intensity, contents, h_corner_radius, subject, title, v_corner_radius].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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 160

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

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

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

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

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



359
360
361
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 359

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



365
366
367
368
369
370
371
372
373
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 365

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



353
354
355
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 353

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



258
259
260
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 258

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



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/groupdocs_signature_cloud/models/pdf_text_annotation_appearance.rb', line 187

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 false if @border_effect.nil?
  border_effect_validator = EnumAttributeValidator.new('String', ["None", "Cloudy"])
  return false unless border_effect_validator.valid?(@border_effect)
  return false if @border_effect_intensity.nil?
  return false if @h_corner_radius.nil?
  return false if @v_corner_radius.nil?
  return true
end