Class: WordsRubySdk::StringFormatData

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/models/string_format_data.rb

Overview

Allows to specify System.Drawing.StringFormat options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StringFormatData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
121
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 95

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

  if attributes.key?(:'FormatFlags')
    self.format_flags = attributes[:'FormatFlags']
  end

  if attributes.key?(:'HotkeyPrefix')
    self.hotkey_prefix = attributes[:'HotkeyPrefix']
  end

  if attributes.key?(:'LineAlignment')
    self.line_alignment = attributes[:'LineAlignment']
  end

  if attributes.key?(:'Trimming')
    self.trimming = attributes[:'Trimming']
  end

end

Instance Attribute Details

#alignment ⇒ Object

Gets or sets horizontal alignment of the string.



35
36
37
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 35

def alignment
  @alignment
end

#format_flags ⇒ Object

Gets or sets a System.Drawing.StringFormatFlags enumeration that contains formatting information.



38
39
40
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 38

def format_flags
  @format_flags
end

#hotkey_prefix ⇒ Object

Gets or sets the System.Drawing.Text.HotkeyPrefix object for this System.Drawing.StringFormat object.



41
42
43
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 41

def hotkey_prefix
  @hotkey_prefix
end

#line_alignment ⇒ Object

Gets or sets the vertical alignment of the string.



44
45
46
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 44

def line_alignment
  @line_alignment
end

#trimming ⇒ Object

Gets or sets the System.Drawing.StringTrimming enumeration for this System.Drawing.StringFormat object.



47
48
49
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 47

def trimming
  @trimming
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 72

def self.attribute_map
  {
    :'alignment' => :'Alignment',
    :'format_flags' => :'FormatFlags',
    :'hotkey_prefix' => :'HotkeyPrefix',
    :'line_alignment' => :'LineAlignment',
    :'trimming' => :'Trimming'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 83

def self.swagger_types
  {
    :'alignment' => :'String',
    :'format_flags' => :'String',
    :'hotkey_prefix' => :'String',
    :'line_alignment' => :'String',
    :'trimming' => :'String'
  }
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
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 218

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      alignment == other.alignment &&
      format_flags == other.format_flags &&
      hotkey_prefix == other.hotkey_prefix &&
      line_alignment == other.line_alignment &&
      trimming == other.trimming
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



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
294
295
296
297
298
299
300
301
302
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 265

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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 = WordsRubySdk.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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 332

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 243

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 236

def hash
  [alignment, format_flags, hotkey_prefix, line_alignment, trimming].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



125
126
127
128
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 125

def list_invalid_properties
  invalid_properties = []
  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



312
313
314
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 312

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 318

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



306
307
308
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 306

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



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/words_ruby_sdk/models/string_format_data.rb', line 132

def valid?
  alignment_validator = EnumAttributeValidator.new('String', %w["Near", "Center", "Far"])
  return false unless alignment_validator.valid?(@alignment)
  format_flags_validator = EnumAttributeValidator.new('String', %w["DirectionRightToLeft", "DirectionVertical", "FitBlackBox", "DisplayFormatControl", "NoFontFallback", "MeasureTrailingSpaces", "NoWrap", "LineLimit", "NoClip"])
  return false unless format_flags_validator.valid?(@format_flags)
  hotkey_prefix_validator = EnumAttributeValidator.new('String', %w["None", "Show", "Hide"])
  return false unless hotkey_prefix_validator.valid?(@hotkey_prefix)
  line_alignment_validator = EnumAttributeValidator.new('String', %w["Near", "Center", "Far"])
  return false unless line_alignment_validator.valid?(@line_alignment)
  trimming_validator = EnumAttributeValidator.new('String', %w["None", "Character", "Word", "EllipsisCharacter", "EllipsisWord", "EllipsisPath"])
  return false unless trimming_validator.valid?(@trimming)
  return true
end