Class: AsposeSlidesCloud::HeaderFooter

Inherits:
ResourceBase show all
Defined in:
lib/aspose_slides_cloud/models/header_footer.rb

Overview

Represents header/footer info of slide

Instance Attribute Summary collapse

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeaderFooter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 67

def initialize(attributes = {})
  super

  if attributes.has_key?(:'IsDateTimeVisible')
    self.is_date_time_visible = attributes[:'IsDateTimeVisible']
  end

  if attributes.has_key?(:'DateTimeText')
    self.date_time_text = attributes[:'DateTimeText']
  end

  if attributes.has_key?(:'IsFooterVisible')
    self.is_footer_visible = attributes[:'IsFooterVisible']
  end

  if attributes.has_key?(:'FooterText')
    self.footer_text = attributes[:'FooterText']
  end

  if attributes.has_key?(:'IsSlideNumberVisible')
    self.is_slide_number_visible = attributes[:'IsSlideNumberVisible']
  end
end

Instance Attribute Details

#date_time_text ⇒ Object

Text to be displayed as date in the footer



32
33
34
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 32

def date_time_text
  @date_time_text
end

#footer_text ⇒ Object

Text to be displayed in the footer



38
39
40
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 38

def footer_text
  @footer_text
end

#is_date_time_visible ⇒ Object

True if date is displayed in the footer



29
30
31
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 29

def is_date_time_visible
  @is_date_time_visible
end

#is_footer_visible ⇒ Object

True if footer is displayed



35
36
37
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 35

def is_footer_visible
  @is_footer_visible
end

#is_slide_number_visible ⇒ Object

True if slide number is displayed in the footer



41
42
43
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 41

def is_slide_number_visible
  @is_slide_number_visible
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 44

def self.attribute_map
  super.merge({
    :'is_date_time_visible' => :'IsDateTimeVisible',
    :'date_time_text' => :'DateTimeText',
    :'is_footer_visible' => :'IsFooterVisible',
    :'footer_text' => :'FooterText',
    :'is_slide_number_visible' => :'IsSlideNumberVisible',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 55

def self.swagger_types
  super.merge({
    :'is_date_time_visible' => :'BOOLEAN',
    :'date_time_text' => :'String',
    :'is_footer_visible' => :'BOOLEAN',
    :'footer_text' => :'String',
    :'is_slide_number_visible' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      is_date_time_visible == o.is_date_time_visible &&
      date_time_text == o.date_time_text &&
      is_footer_visible == o.is_footer_visible &&
      footer_text == o.footer_text &&
      is_slide_number_visible == o.is_slide_number_visible
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



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 167

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 241

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 134

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


121
122
123
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 127

def hash
  [self_uri, alternate_links, is_date_time_visible, date_time_text, is_footer_visible, footer_text, is_slide_number_visible].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



93
94
95
96
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 93

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



221
222
223
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 221

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



227
228
229
230
231
232
233
234
235
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 227

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



215
216
217
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 215

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



100
101
102
103
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 100

def valid?
  return false if !super
  true
end