Class: GroupDocsSignatureCloud::StampLine

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

Overview

Specify Stamp line properties

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StampLine

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/stamp_line.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?(:'Height')
    self.height = attributes[:'Height']
  end

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

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

  if attributes.key?(:'Font')
    self.font = attributes[:'Font']
  end

  if attributes.key?(:'TextColor')
    self.text_color = attributes[:'TextColor']
  end

  if attributes.key?(:'TextBottomIntent')
    self.text_bottom_intent = attributes[:'TextBottomIntent']
  end

  if attributes.key?(:'TextRepeatType')
    self.text_repeat_type = attributes[:'TextRepeatType']
  end

  if attributes.key?(:'OuterBorder')
    self.outer_border = attributes[:'OuterBorder']
  end

  if attributes.key?(:'InnerBorder')
    self.inner_border = attributes[:'InnerBorder']
  end

  if attributes.key?(:'Visible')
    self.visible = attributes[:'Visible']
  end

end

Instance Attribute Details

#background_color ⇒ Object

Gets or sets the background color of signature



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

def background_color
  @background_color
end

#font ⇒ Object

Get or set Font of Stamp Line text



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

def font
  @font
end

#height ⇒ Object

Gets or sets the line height on Stamp



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

def height
  @height
end

#inner_border ⇒ Object

Setup Internal Border



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

def inner_border
  @inner_border
end

#outer_border ⇒ Object

Setup Outer Border



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

def outer_border
  @outer_border
end

#text ⇒ Object

Gets or sets the text of stamp line



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

def text
  @text
end

#text_bottom_intent ⇒ Object

Gets or sets the bottom intent of text



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

def text_bottom_intent
  @text_bottom_intent
end

#text_color ⇒ Object

Gets or sets the text color of signature



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

def text_color
  @text_color
end

#text_repeat_type ⇒ Object

Gets or sets text repeat type



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

def text_repeat_type
  @text_repeat_type
end

#visible ⇒ Object

Get and set visibility of Stamp Line



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

def visible
  @visible
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/stamp_line.rb', line 86

def self.attribute_map
  {
    :'height' => :'Height',
    :'background_color' => :'BackgroundColor',
    :'text' => :'Text',
    :'font' => :'Font',
    :'text_color' => :'TextColor',
    :'text_bottom_intent' => :'TextBottomIntent',
    :'text_repeat_type' => :'TextRepeatType',
    :'outer_border' => :'OuterBorder',
    :'inner_border' => :'InnerBorder',
    :'visible' => :'Visible'
  }
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/stamp_line.rb', line 102

def self.swagger_types
  {
    :'height' => :'Integer',
    :'background_color' => :'Color',
    :'text' => :'String',
    :'font' => :'SignatureFont',
    :'text_color' => :'Color',
    :'text_bottom_intent' => :'Integer',
    :'text_repeat_type' => :'String',
    :'outer_border' => :'BorderLine',
    :'inner_border' => :'BorderLine',
    :'visible' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 218

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      height == other.height &&
      background_color == other.background_color &&
      text == other.text &&
      font == other.font &&
      text_color == other.text_color &&
      text_bottom_intent == other.text_bottom_intent &&
      text_repeat_type == other.text_repeat_type &&
      outer_border == other.outer_border &&
      inner_border == other.inner_border &&
      visible == other.visible
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



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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 278

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 368

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 254

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


235
236
237
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 235

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 241

def hash
  [height, background_color, text, font, text_color, text_bottom_intent, text_repeat_type, outer_border, inner_border, visible].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
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 169

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

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

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

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



348
349
350
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 348

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



354
355
356
357
358
359
360
361
362
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 354

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



342
343
344
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 342

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



247
248
249
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 247

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



192
193
194
195
196
197
198
199
200
 
# File 'lib/groupdocs_signature_cloud/models/stamp_line.rb', line 192

def valid?
  return false if @height.nil?
  return false if @text_bottom_intent.nil?
  return false if @text_repeat_type.nil?
  text_repeat_type_validator = EnumAttributeValidator.new('String', ["None", "FullTextRepeat", "RepeatWithTruncation"])
  return false unless text_repeat_type_validator.valid?(@text_repeat_type)
  return false if @visible.nil?
  return true
end