Class: AsposePdfCloud::TextState

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/text_state.rb

Overview

Represents a text state of a text

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TextState

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 93

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

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

  if attributes.has_key?(:'ForegroundColor')
    self.foreground_color = attributes[:'ForegroundColor']
  end

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

  if attributes.has_key?(:'FontStyle')
    self.font_style = attributes[:'FontStyle']
  end

  if attributes.has_key?(:'FontFile')
    self.font_file = attributes[:'FontFile']
  end

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

  if attributes.has_key?(:'StrikeOut')
    self.strike_out = attributes[:'StrikeOut']
  end

  if attributes.has_key?(:'Superscript')
    self.superscript = attributes[:'Superscript']
  end

  if attributes.has_key?(:'Subscript')
    self.subscript = attributes[:'Subscript']
  end

end

Instance Attribute Details

#background_color ⇒ Object

Sets background color of the text.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 38

def background_color
  @background_color
end

#font ⇒ Object

Gets or sets font name of the text.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 32

def font
  @font
end

#font_file ⇒ Object

Sets path of font file in storage.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 44

def font_file
  @font_file
end

#font_size ⇒ Object

Gets or sets font size of the text.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 29

def font_size
  @font_size
end

#font_style ⇒ Object

Sets font style of the text.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 41

def font_style
  @font_style
end

#foreground_color ⇒ Object

Gets or sets foreground color of the text.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 35

def foreground_color
  @foreground_color
end

#strike_out ⇒ Object

Gets or sets strikeout of the text.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 50

def strike_out
  @strike_out
end

#subscript ⇒ Object

Gets or sets subscript mode of the text.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 56

def subscript
  @subscript
end

#superscript ⇒ Object

Gets or sets superscript mode of the text.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 53

def superscript
  @superscript
end

#underline ⇒ Object

Gets or sets underline of the text.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 47

def underline
  @underline
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 60

def self.attribute_map
  {
    :'font_size' => :'FontSize',
    :'font' => :'Font',
    :'foreground_color' => :'ForegroundColor',
    :'background_color' => :'BackgroundColor',
    :'font_style' => :'FontStyle',
    :'font_file' => :'FontFile',
    :'underline' => :'Underline',
    :'strike_out' => :'StrikeOut',
    :'superscript' => :'Superscript',
    :'subscript' => :'Subscript'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 76

def self.swagger_types
  {
    :'font_size' => :'Float',
    :'font' => :'String',
    :'foreground_color' => :'Color',
    :'background_color' => :'Color',
    :'font_style' => :'FontStyles',
    :'font_file' => :'String',
    :'underline' => :'BOOLEAN',
    :'strike_out' => :'BOOLEAN',
    :'superscript' => :'BOOLEAN',
    :'subscript' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      font_size == o.font_size &&
      font == o.font &&
      foreground_color == o.foreground_color &&
      background_color == o.background_color &&
      font_style == o.font_style &&
      font_file == o.font_file &&
      underline == o.underline &&
      strike_out == o.strike_out &&
      superscript == o.superscript &&
      subscript == o.subscript
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



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
252
253
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 217

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = AsposePdfCloud.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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 196

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 189

def hash
  [font_size, font, foreground_color, background_color, font_style, font_file, underline, strike_out, superscript, subscript].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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 143

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

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



263
264
265
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 269

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



257
258
259
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 257

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



158
159
160
161
162
 
# File 'lib/aspose_pdf_cloud/models/text_state.rb', line 158

def valid?
  return false if @font_size.nil?
  return false if @font_style.nil?
  return true
end