Class: AsposeSlidesCloud::SwfExportOptions

Inherits:
ExportOptions show all
Defined in:
lib/aspose_slides_cloud/models/swf_export_options.rb

Overview

Provides options that control how a presentation is saved in SWF format.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ExportOptions

#default_regular_font, #format

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SwfExportOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  super

  if attributes.has_key?(:'ShowHiddenSlides')
    self.show_hidden_slides = attributes[:'ShowHiddenSlides']
  end

  if attributes.has_key?(:'Compressed')
    self.compressed = attributes[:'Compressed']
  end

  if attributes.has_key?(:'ViewerIncluded')
    self.viewer_included = attributes[:'ViewerIncluded']
  end

  if attributes.has_key?(:'ShowPageBorder')
    self.show_page_border = attributes[:'ShowPageBorder']
  end

  if attributes.has_key?(:'ShowFullScreen')
    self.show_full_screen = attributes[:'ShowFullScreen']
  end

  if attributes.has_key?(:'ShowPageStepper')
    self.show_page_stepper = attributes[:'ShowPageStepper']
  end

  if attributes.has_key?(:'ShowSearch')
    self.show_search = attributes[:'ShowSearch']
  end

  if attributes.has_key?(:'ShowTopPane')
    self.show_top_pane = attributes[:'ShowTopPane']
  end

  if attributes.has_key?(:'ShowBottomPane')
    self.show_bottom_pane = attributes[:'ShowBottomPane']
  end

  if attributes.has_key?(:'ShowLeftPane')
    self.show_left_pane = attributes[:'ShowLeftPane']
  end

  if attributes.has_key?(:'StartOpenLeftPane')
    self.start_open_left_pane = attributes[:'StartOpenLeftPane']
  end

  if attributes.has_key?(:'EnableContextMenu')
    self.enable_context_menu = attributes[:'EnableContextMenu']
  end

  if attributes.has_key?(:'LogoImage')
    self.logo_image = attributes[:'LogoImage']
  end

  if attributes.has_key?(:'LogoLink')
    self.logo_link = attributes[:'LogoLink']
  end

  if attributes.has_key?(:'JpegQuality')
    self.jpeg_quality = attributes[:'JpegQuality']
  end

  if attributes.has_key?(:'NotesPosition')
    self.notes_position = attributes[:'NotesPosition']
  end

  if attributes.has_key?(:'CommentsPosition')
    self.comments_position = attributes[:'CommentsPosition']
  end

  if attributes.has_key?(:'CommentsAreaWidth')
    self.comments_area_width = attributes[:'CommentsAreaWidth']
  end

  if attributes.has_key?(:'CommentsAreaColor')
    self.comments_area_color = attributes[:'CommentsAreaColor']
  end

  if attributes.has_key?(:'ShowCommentsByNoAuthor')
    self.show_comments_by_no_author = attributes[:'ShowCommentsByNoAuthor']
  end
  self.format = "swf"
end

Instance Attribute Details

#comments_area_color ⇒ Object

Gets or sets the color of comments area (Applies only if comments are displayed on the right).



83
84
85
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 83

def comments_area_color
  @comments_area_color
end

#comments_area_width ⇒ Object

Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).



80
81
82
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 80

def comments_area_width
  @comments_area_width
end

#comments_position ⇒ Object

Gets or sets the position of the comments on the page.



77
78
79
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 77

def comments_position
  @comments_position
end

#compressed ⇒ Object

Specifies whether the generated SWF document should be compressed or not. Default is true.



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

def compressed
  @compressed
end

#enable_context_menu ⇒ Object

Enable/disable context menu. Default is true.



62
63
64
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 62

def enable_context_menu
  @enable_context_menu
end

#jpeg_quality ⇒ Object

Specifies the quality of JPEG images. Default is 95.



71
72
73
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 71

def jpeg_quality
  @jpeg_quality
end

#logo_image ⇒ Object

Image that will be displayed as logo in the top right corner of the viewer. The image data is a base 64 string. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly.



65
66
67
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 65

def logo_image
  @logo_image
end

#logo_link ⇒ Object

Gets or sets the full hyperlink address for a logo. Has an effect only if a LogoImage is specified.



68
69
70
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 68

def logo_link
  @logo_link
end

#notes_position ⇒ Object

Gets or sets the position of the notes on the page.



74
75
76
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 74

def notes_position
  @notes_position
end

#show_bottom_pane ⇒ Object

Show/hide bottom pane. Can be overridden in flashvars. Default is true.



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

def show_bottom_pane
  @show_bottom_pane
end

#show_comments_by_no_author ⇒ Object

True if comments that have no author are displayed. (Applies only if comments are displayed).



86
87
88
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 86

def show_comments_by_no_author
  @show_comments_by_no_author
end

#show_full_screen ⇒ Object

Show/hide fullscreen button. Can be overridden in flashvars. Default is true.



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

def show_full_screen
  @show_full_screen
end

#show_hidden_slides ⇒ Object

Specifies whether the generated document should include hidden slides or not. Default is false.



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

def show_hidden_slides
  @show_hidden_slides
end

#show_left_pane ⇒ Object

Show/hide left pane. Can be overridden in flashvars. Default is true.



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

def show_left_pane
  @show_left_pane
end

#show_page_border ⇒ Object

Specifies whether border around pages should be shown. Default is true.



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

def show_page_border
  @show_page_border
end

#show_page_stepper ⇒ Object

Show/hide page stepper. Can be overridden in flashvars. Default is true.



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

def show_page_stepper
  @show_page_stepper
end

#show_search ⇒ Object

Show/hide search section. Can be overridden in flashvars. Default is true.



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

def show_search
  @show_search
end

#show_top_pane ⇒ Object

Show/hide whole top pane. Can be overridden in flashvars. Default is true.



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

def show_top_pane
  @show_top_pane
end

#start_open_left_pane ⇒ Object

Start with opened left pane. Can be overridden in flashvars. Default is false.



59
60
61
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 59

def start_open_left_pane
  @start_open_left_pane
end

#viewer_included ⇒ Object

Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.



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

def viewer_included
  @viewer_included
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 111

def self.attribute_map
  super.merge({
    :'show_hidden_slides' => :'ShowHiddenSlides',
    :'compressed' => :'Compressed',
    :'viewer_included' => :'ViewerIncluded',
    :'show_page_border' => :'ShowPageBorder',
    :'show_full_screen' => :'ShowFullScreen',
    :'show_page_stepper' => :'ShowPageStepper',
    :'show_search' => :'ShowSearch',
    :'show_top_pane' => :'ShowTopPane',
    :'show_bottom_pane' => :'ShowBottomPane',
    :'show_left_pane' => :'ShowLeftPane',
    :'start_open_left_pane' => :'StartOpenLeftPane',
    :'enable_context_menu' => :'EnableContextMenu',
    :'logo_image' => :'LogoImage',
    :'logo_link' => :'LogoLink',
    :'jpeg_quality' => :'JpegQuality',
    :'notes_position' => :'NotesPosition',
    :'comments_position' => :'CommentsPosition',
    :'comments_area_width' => :'CommentsAreaWidth',
    :'comments_area_color' => :'CommentsAreaColor',
    :'show_comments_by_no_author' => :'ShowCommentsByNoAuthor',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  super.merge({
    :'show_hidden_slides' => :'BOOLEAN',
    :'compressed' => :'BOOLEAN',
    :'viewer_included' => :'BOOLEAN',
    :'show_page_border' => :'BOOLEAN',
    :'show_full_screen' => :'BOOLEAN',
    :'show_page_stepper' => :'BOOLEAN',
    :'show_search' => :'BOOLEAN',
    :'show_top_pane' => :'BOOLEAN',
    :'show_bottom_pane' => :'BOOLEAN',
    :'show_left_pane' => :'BOOLEAN',
    :'start_open_left_pane' => :'BOOLEAN',
    :'enable_context_menu' => :'BOOLEAN',
    :'logo_image' => :'String',
    :'logo_link' => :'String',
    :'jpeg_quality' => :'Integer',
    :'notes_position' => :'String',
    :'comments_position' => :'String',
    :'comments_area_width' => :'Integer',
    :'comments_area_color' => :'String',
    :'show_comments_by_no_author' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 374

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_regular_font == o.default_regular_font &&
      format == o.format &&
      show_hidden_slides == o.show_hidden_slides &&
      compressed == o.compressed &&
      viewer_included == o.viewer_included &&
      show_page_border == o.show_page_border &&
      show_full_screen == o.show_full_screen &&
      show_page_stepper == o.show_page_stepper &&
      show_search == o.show_search &&
      show_top_pane == o.show_top_pane &&
      show_bottom_pane == o.show_bottom_pane &&
      show_left_pane == o.show_left_pane &&
      start_open_left_pane == o.start_open_left_pane &&
      enable_context_menu == o.enable_context_menu &&
      logo_image == o.logo_image &&
      logo_link == o.logo_link &&
      jpeg_quality == o.jpeg_quality &&
      notes_position == o.notes_position &&
      comments_position == o.comments_position &&
      comments_area_width == o.comments_area_width &&
      comments_area_color == o.comments_area_color &&
      show_comments_by_no_author == o.show_comments_by_no_author
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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 449

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



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 515

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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 416

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


403
404
405
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 403

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



409
410
411
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 409

def hash
  [default_regular_font, format, show_hidden_slides, compressed, viewer_included, show_page_border, show_full_screen, show_page_stepper, show_search, show_top_pane, show_bottom_pane, show_left_pane, start_open_left_pane, enable_context_menu, logo_image, logo_link, jpeg_quality, notes_position, comments_position, comments_area_width, comments_area_color, show_comments_by_no_author].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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 251

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

  if @compressed.nil?
    invalid_properties.push('invalid value for "compressed", compressed cannot be nil.')
  end

  if @viewer_included.nil?
    invalid_properties.push('invalid value for "viewer_included", viewer_included cannot be nil.')
  end

  if @show_page_border.nil?
    invalid_properties.push('invalid value for "show_page_border", show_page_border cannot be nil.')
  end

  if @show_full_screen.nil?
    invalid_properties.push('invalid value for "show_full_screen", show_full_screen cannot be nil.')
  end

  if @show_page_stepper.nil?
    invalid_properties.push('invalid value for "show_page_stepper", show_page_stepper cannot be nil.')
  end

  if @show_search.nil?
    invalid_properties.push('invalid value for "show_search", show_search cannot be nil.')
  end

  if @show_top_pane.nil?
    invalid_properties.push('invalid value for "show_top_pane", show_top_pane cannot be nil.')
  end

  if @show_bottom_pane.nil?
    invalid_properties.push('invalid value for "show_bottom_pane", show_bottom_pane cannot be nil.')
  end

  if @show_left_pane.nil?
    invalid_properties.push('invalid value for "show_left_pane", show_left_pane cannot be nil.')
  end

  if @start_open_left_pane.nil?
    invalid_properties.push('invalid value for "start_open_left_pane", start_open_left_pane cannot be nil.')
  end

  if @enable_context_menu.nil?
    invalid_properties.push('invalid value for "enable_context_menu", enable_context_menu cannot be nil.')
  end

  if @jpeg_quality.nil?
    invalid_properties.push('invalid value for "jpeg_quality", jpeg_quality cannot be nil.')
  end

  if @notes_position.nil?
    invalid_properties.push('invalid value for "notes_position", notes_position cannot be nil.')
  end

  if @comments_position.nil?
    invalid_properties.push('invalid value for "comments_position", comments_position cannot be nil.')
  end

  if @comments_area_width.nil?
    invalid_properties.push('invalid value for "comments_area_width", comments_area_width cannot be nil.')
  end

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



495
496
497
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 495

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



501
502
503
504
505
506
507
508
509
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 501

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



489
490
491
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 489

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/aspose_slides_cloud/models/swf_export_options.rb', line 326

def valid?
  return false if !super
  return false if @show_hidden_slides.nil?
  return false if @compressed.nil?
  return false if @viewer_included.nil?
  return false if @show_page_border.nil?
  return false if @show_full_screen.nil?
  return false if @show_page_stepper.nil?
  return false if @show_search.nil?
  return false if @show_top_pane.nil?
  return false if @show_bottom_pane.nil?
  return false if @show_left_pane.nil?
  return false if @start_open_left_pane.nil?
  return false if @enable_context_menu.nil?
  return false if @jpeg_quality.nil?
  return false if @notes_position.nil?
  notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated'])
  return false unless notes_position_validator.valid?(@notes_position)
  return false if @comments_position.nil?
  comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right'])
  return false unless comments_position_validator.valid?(@comments_position)
  return false if @comments_area_width.nil?
  return false if @show_comments_by_no_author.nil?
  true
end