Class: GroupDocsSignatureCloud::SignatureFont

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

Overview

Create instance of SignatureFont class to specify Font properties

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureFont

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 73

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

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

  if attributes.key?(:'Bold')
    self.bold = attributes[:'Bold']
  end

  if attributes.key?(:'Italic')
    self.italic = attributes[:'Italic']
  end

  if attributes.key?(:'Underline')
    self.underline = attributes[:'Underline']
  end

end

Instance Attribute Details

#bold ⇒ Object

Apply Font Bold Style



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

def bold
  @bold
end

#font_family ⇒ Object

Font Family Name



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

def font_family
  @font_family
end

#font_size ⇒ Object

Font Size



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

def font_size
  @font_size
end

#italic ⇒ Object

Apply Font Italic Style



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

def italic
  @italic
end

#underline ⇒ Object

Apply Underline Style



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

def underline
  @underline
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 50

def self.attribute_map
  {
    :'font_family' => :'FontFamily',
    :'font_size' => :'FontSize',
    :'bold' => :'Bold',
    :'italic' => :'Italic',
    :'underline' => :'Underline'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 61

def self.swagger_types
  {
    :'font_family' => :'String',
    :'font_size' => :'Float',
    :'bold' => :'BOOLEAN',
    :'italic' => :'BOOLEAN',
    :'underline' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 136

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      font_family == other.font_family &&
      font_size == other.font_size &&
      bold == other.bold &&
      italic == other.italic &&
      underline == other.underline
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



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
247
248
249
250
251
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 191

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 281

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 167

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


148
149
150
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 154

def hash
  [font_family, font_size, bold, italic, underline].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



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

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

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

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

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



261
262
263
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 261

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



267
268
269
270
271
272
273
274
275
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 267

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



255
256
257
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 255

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



160
161
162
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 160

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



126
127
128
129
130
131
132
 
# File 'lib/groupdocs_signature_cloud/models/signature_font.rb', line 126

def valid?
  return false if @font_size.nil?
  return false if @bold.nil?
  return false if @italic.nil?
  return false if @underline.nil?
  return true
end