Class: AsposeWordsCloud::PageNumber

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/page_number.rb

Overview

Class is used for insert page number request building.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PageNumber

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 70

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

  if attributes.key?(:'IsTop')
    self.is_top = attributes[:'IsTop']
  end

  if attributes.key?(:'PageStartingNumber')
    self.page_starting_number = attributes[:'PageStartingNumber']
  end

  if attributes.key?(:'SetPageNumberOnFirstPage')
    self.set_page_number_on_first_page = attributes[:'SetPageNumberOnFirstPage']
  end
end

Instance Attribute Details

#alignment ⇒ Object

Gets or sets text alignment, possible values are left, right, center or justify.



33
34
35
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 33

def alignment
  @alignment
end

#format ⇒ Object

Gets or sets the page number format, e.g. “PAGE of NUMPAGES”.



36
37
38
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 36

def format
  @format
end

#is_top ⇒ Object

Gets or sets a value indicating whether if true the page number is added at the top of the page, else at the bottom.



39
40
41
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 39

def is_top
  @is_top
end

#page_starting_number ⇒ Object

Gets or sets the starting page number of the document.



42
43
44
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 42

def page_starting_number
  @page_starting_number
end

#set_page_number_on_first_page ⇒ Object

Gets or sets a value indicating whether if true the page number is added on first page too.



45
46
47
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 45

def set_page_number_on_first_page
  @set_page_number_on_first_page
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 47

def self.attribute_map
  {
    :'alignment' => :'Alignment',
    :'format' => :'Format',
    :'is_top' => :'IsTop',
    :'page_starting_number' => :'PageStartingNumber',
    :'set_page_number_on_first_page' => :'SetPageNumberOnFirstPage'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 58

def self.swagger_types
  {
    :'alignment' => :'String',
    :'format' => :'String',
    :'is_top' => :'BOOLEAN',
    :'page_starting_number' => :'Integer',
    :'set_page_number_on_first_page' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



105
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 105

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      alignment == other.alignment &&
      format == other.format &&
      is_top == other.is_top &&
      page_starting_number == other.page_starting_number &&
      set_page_number_on_first_page == other.set_page_number_on_first_page
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 152

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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 223

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 130

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

#collectFilesContent(resultFilesContent) ⇒ Object 



237
238
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 237

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 123

def hash
  [alignment, format, is_top, page_starting_number, set_page_number_on_first_page].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 203

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 209

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



197
198
199
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 197

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



99
100
101
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 99

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


240
241
242
243
 
# File 'lib/aspose_words_cloud/models/page_number.rb', line 240

def validate()
  raise ArgumentError, 'Property is_top in PageNumber is required.' if self.is_top.nil?
  raise ArgumentError, 'Property set_page_number_on_first_page in PageNumber is required.' if self.set_page_number_on_first_page.nil?
end