Class: GroupDocsSignatureCloud::ImageAppearance

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

Overview

Describes extended appearance features for Image Signature.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImageAppearance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 94

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

  if attributes.key?(:'Contrast')
    self.contrast = attributes[:'Contrast']
  end

  if attributes.key?(:'GammaCorrection')
    self.gamma_correction = attributes[:'GammaCorrection']
  end

  if attributes.key?(:'Grayscale')
    self.grayscale = attributes[:'Grayscale']
  end

end

Instance Attribute Details

#appearance_type ⇒ Object

Specifies the type of appearance



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

def appearance_type
  @appearance_type
end

#brightness ⇒ Object

Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image.



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

def brightness
  @brightness
end

#contrast ⇒ Object

Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image.



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

def contrast
  @contrast
end

#gamma_correction ⇒ Object

Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image.



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

def gamma_correction
  @gamma_correction
end

#grayscale ⇒ Object

Setup this flag to true if gray-scale filter is required.



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

def grayscale
  @grayscale
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 71

def self.attribute_map
  {
    :'appearance_type' => :'AppearanceType',
    :'brightness' => :'Brightness',
    :'contrast' => :'Contrast',
    :'gamma_correction' => :'GammaCorrection',
    :'grayscale' => :'Grayscale'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 82

def self.swagger_types
  {
    :'appearance_type' => :'String',
    :'brightness' => :'Float',
    :'contrast' => :'Float',
    :'gamma_correction' => :'Float',
    :'grayscale' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 178

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      appearance_type == other.appearance_type &&
      brightness == other.brightness &&
      contrast == other.contrast &&
      gamma_correction == other.gamma_correction &&
      grayscale == other.grayscale
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
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
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 233

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 323

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 209

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


190
191
192
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 196

def hash
  [appearance_type, brightness, contrast, gamma_correction, grayscale].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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 124

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 @brightness.nil?
    invalid_properties.push("invalid value for 'brightness', brightness cannot be nil.")
  end

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

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

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



303
304
305
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 303

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 309

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



297
298
299
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 297

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



202
203
204
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 202

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



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/groupdocs_signature_cloud/models/image_appearance.rb', line 151

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 @brightness.nil?
  return false if @contrast.nil?
  return false if @gamma_correction.nil?
  return false if @grayscale.nil?
  return true
end