Class: AsposeSlidesCloud::Hyperlink

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/hyperlink.rb

Overview

Hyperlink

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Hyperlink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 114

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

  if attributes.has_key?(:'ActionType')
    self.action_type = attributes[:'ActionType']
  end

  if attributes.has_key?(:'ExternalUrl')
    self.external_url = attributes[:'ExternalUrl']
  end

  if attributes.has_key?(:'TargetSlideIndex')
    self.target_slide_index = attributes[:'TargetSlideIndex']
  end

  if attributes.has_key?(:'TargetFrame')
    self.target_frame = attributes[:'TargetFrame']
  end

  if attributes.has_key?(:'Tooltip')
    self.tooltip = attributes[:'Tooltip']
  end

  if attributes.has_key?(:'History')
    self.history = attributes[:'History']
  end

  if attributes.has_key?(:'HighlightClick')
    self.highlight_click = attributes[:'HighlightClick']
  end

  if attributes.has_key?(:'StopSoundOnClick')
    self.stop_sound_on_click = attributes[:'StopSoundOnClick']
  end

  if attributes.has_key?(:'ColorSource')
    self.color_source = attributes[:'ColorSource']
  end
end

Instance Attribute Details

#action_type ⇒ Object

Type of HyperLink action



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

def action_type
  @action_type
end

#color_source ⇒ Object

Represents the source of hyperlink color



56
57
58
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 56

def color_source
  @color_source
end

#external_url ⇒ Object

Specifies the external URL



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

def external_url
  @external_url
end

#highlight_click ⇒ Object

Determines whether the hyperlink should be highlighted on click.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 50

def highlight_click
  @highlight_click
end

#history ⇒ Object

Makes hyperlink viewed when it is invoked.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 47

def history
  @history
end

#is_disabled ⇒ Object

If true Hypelink is not applied.



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

def is_disabled
  @is_disabled
end

#stop_sound_on_click ⇒ Object

Determines whether the sound should be stopped on hyperlink click



53
54
55
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 53

def stop_sound_on_click
  @stop_sound_on_click
end

#target_frame ⇒ Object

Target frame



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

def target_frame
  @target_frame
end

#target_slide_index ⇒ Object

Index of the target slide



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

def target_slide_index
  @target_slide_index
end

#tooltip ⇒ Object

Hyperlink tooltip



44
45
46
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 44

def tooltip
  @tooltip
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 81

def self.attribute_map
  {
    :'is_disabled' => :'IsDisabled',
    :'action_type' => :'ActionType',
    :'external_url' => :'ExternalUrl',
    :'target_slide_index' => :'TargetSlideIndex',
    :'target_frame' => :'TargetFrame',
    :'tooltip' => :'Tooltip',
    :'history' => :'History',
    :'highlight_click' => :'HighlightClick',
    :'stop_sound_on_click' => :'StopSoundOnClick',
    :'color_source' => :'ColorSource',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 97

def self.swagger_types
  {
    :'is_disabled' => :'BOOLEAN',
    :'action_type' => :'String',
    :'external_url' => :'String',
    :'target_slide_index' => :'Integer',
    :'target_frame' => :'String',
    :'tooltip' => :'String',
    :'history' => :'BOOLEAN',
    :'highlight_click' => :'BOOLEAN',
    :'stop_sound_on_click' => :'BOOLEAN',
    :'color_source' => :'String',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_disabled == o.is_disabled &&
      action_type == o.action_type &&
      external_url == o.external_url &&
      target_slide_index == o.target_slide_index &&
      target_frame == o.target_frame &&
      tooltip == o.tooltip &&
      history == o.history &&
      highlight_click == o.highlight_click &&
      stop_sound_on_click == o.stop_sound_on_click &&
      color_source == o.color_source
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



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
303
304
305
306
307
308
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 268

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
    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

#_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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 338

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



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
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 235

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


222
223
224
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 228

def hash
  [is_disabled, action_type, external_url, target_slide_index, target_frame, tooltip, history, highlight_click, stop_sound_on_click, color_source].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



163
164
165
166
167
168
169
170
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 163

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

  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



318
319
320
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 318

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



324
325
326
327
328
329
330
331
332
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 324

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



312
313
314
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 312

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



174
175
176
177
178
179
180
181
 
# File 'lib/aspose_slides_cloud/models/hyperlink.rb', line 174

def valid?
  return false if @action_type.nil?
  action_type_validator = EnumAttributeValidator.new('String', ['NoAction', 'Hyperlink', 'JumpFirstSlide', 'JumpPreviousSlide', 'JumpNextSlide', 'JumpLastSlide', 'JumpEndShow', 'JumpLastViewedSlide', 'JumpSpecificSlide', 'StartCustomSlideShow', 'OpenFile', 'OpenPresentation', 'StartStopMedia', 'StartMacro', 'StartProgram', 'Unknown'])
  return false unless action_type_validator.valid?(@action_type)
  color_source_validator = EnumAttributeValidator.new('String', ['Styles', 'PortionFormat'])
  return false unless color_source_validator.valid?(@color_source)
  true
end