Class: AsposeDiagramCloud::PdfSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/AsposeDiagramCloud/models/pdf_save_options.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 126

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

  if attributes.has_key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.has_key?(:'Area')
    self.area = attributes[:'Area']
  end

  if attributes.has_key?(:'ExportGuideShapes')
    self.export_guide_shapes = attributes[:'ExportGuideShapes']
  end

  if attributes.has_key?(:'PageSize')
    self.page_size = attributes[:'PageSize']
  end

  if attributes.has_key?(:'IsExportComments')
    self.is_export_comments = attributes[:'IsExportComments']
  end

  if attributes.has_key?(:'HorizontalResolution')
    self.horizontal_resolution = attributes[:'HorizontalResolution']
  end

  if attributes.has_key?(:'VerticalResolution')
    self.vertical_resolution = attributes[:'VerticalResolution']
  end

  if attributes.has_key?(:'PageCount')
    self.page_count = attributes[:'PageCount']
  end

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

  if attributes.has_key?(:'ExportHiddenPage')
    self.export_hidden_page = attributes[:'ExportHiddenPage']
  end

  if attributes.has_key?(:'PageIndex')
    self.page_index = attributes[:'PageIndex']
  end

  if attributes.has_key?(:'SaveForegroundPagesOnly')
    self.save_foreground_pages_only = attributes[:'SaveForegroundPagesOnly']
  end

  if attributes.has_key?(:'Compliance')
    self.compliance = attributes[:'Compliance']
  end

  if attributes.has_key?(:'EncryptionDetails')
    self.encryption_details = attributes[:'EncryptionDetails']
  end

  if attributes.has_key?(:'TextCompression')
    self.text_compression = attributes[:'TextCompression']
  end

  if attributes.has_key?(:'SplitMultiPages')
    self.split_multi_pages = attributes[:'SplitMultiPages']
  end

  if attributes.has_key?(:'DigitalSignatureDetails')
    self.digital_signature_details = attributes[:'DigitalSignatureDetails']
  end

end

Instance Attribute Details

#area ⇒ Object

Returns the value of attribute area.



22
23
24
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 22

def area
  @area
end

#compliance ⇒ Object

Returns the value of attribute compliance.



44
45
46
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 44

def compliance
  @compliance
end

#default_font ⇒ Object

Returns the value of attribute default_font.



20
21
22
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 20

def default_font
  @default_font
end

#digital_signature_details ⇒ Object

Returns the value of attribute digital_signature_details.



52
53
54
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 52

def digital_signature_details
  @digital_signature_details
end

#encryption_details ⇒ Object

Returns the value of attribute encryption_details.



46
47
48
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 46

def encryption_details
  @encryption_details
end

#export_guide_shapes ⇒ Object

Returns the value of attribute export_guide_shapes.



24
25
26
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 24

def export_guide_shapes
  @export_guide_shapes
end

#export_hidden_page ⇒ Object

Returns the value of attribute export_hidden_page.



38
39
40
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 38

def export_hidden_page
  @export_hidden_page
end

#horizontal_resolution ⇒ Object

Returns the value of attribute horizontal_resolution.



30
31
32
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 30

def horizontal_resolution
  @horizontal_resolution
end

#is_export_comments ⇒ Object

Returns the value of attribute is_export_comments.



28
29
30
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 28

def is_export_comments
  @is_export_comments
end

#jpeg_quality ⇒ Object

Returns the value of attribute jpeg_quality.



36
37
38
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 36

def jpeg_quality
  @jpeg_quality
end

#page_count ⇒ Object

Returns the value of attribute page_count.



34
35
36
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 34

def page_count
  @page_count
end

#page_index ⇒ Object

Returns the value of attribute page_index.



40
41
42
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 40

def page_index
  @page_index
end

#page_size ⇒ Object

Returns the value of attribute page_size.



26
27
28
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 26

def page_size
  @page_size
end

#save_foreground_pages_only ⇒ Object

Returns the value of attribute save_foreground_pages_only.



42
43
44
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 42

def save_foreground_pages_only
  @save_foreground_pages_only
end

#save_format ⇒ Object

Returns the value of attribute save_format.



18
19
20
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 18

def save_format
  @save_format
end

#split_multi_pages ⇒ Object

Returns the value of attribute split_multi_pages.



50
51
52
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 50

def split_multi_pages
  @split_multi_pages
end

#text_compression ⇒ Object

Returns the value of attribute text_compression.



48
49
50
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 48

def text_compression
  @text_compression
end

#vertical_resolution ⇒ Object

Returns the value of attribute vertical_resolution.



32
33
34
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 32

def vertical_resolution
  @vertical_resolution
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 77

def self.attribute_map
  {
    :'save_format' => :'SaveFormat',
    :'default_font' => :'DefaultFont',
    :'area' => :'Area',
    :'export_guide_shapes' => :'ExportGuideShapes',
    :'page_size' => :'PageSize',
    :'is_export_comments' => :'IsExportComments',
    :'horizontal_resolution' => :'HorizontalResolution',
    :'vertical_resolution' => :'VerticalResolution',
    :'page_count' => :'PageCount',
    :'jpeg_quality' => :'JpegQuality',
    :'export_hidden_page' => :'ExportHiddenPage',
    :'page_index' => :'PageIndex',
    :'save_foreground_pages_only' => :'SaveForegroundPagesOnly',
    :'compliance' => :'Compliance',
    :'encryption_details' => :'EncryptionDetails',
    :'text_compression' => :'TextCompression',
    :'split_multi_pages' => :'SplitMultiPages',
    :'digital_signature_details' => :'DigitalSignatureDetails'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 101

def self.swagger_types
  {
    :'save_format' => :'String',
    :'default_font' => :'String',
    :'area' => :'RectangleF',
    :'export_guide_shapes' => :'BOOLEAN',
    :'page_size' => :'PageSize',
    :'is_export_comments' => :'BOOLEAN',
    :'horizontal_resolution' => :'Integer',
    :'vertical_resolution' => :'Integer',
    :'page_count' => :'Integer',
    :'jpeg_quality' => :'Integer',
    :'export_hidden_page' => :'BOOLEAN',
    :'page_index' => :'Integer',
    :'save_foreground_pages_only' => :'BOOLEAN',
    :'compliance' => :'String',
    :'encryption_details' => :'PdfEncryptionDetails',
    :'text_compression' => :'String',
    :'split_multi_pages' => :'BOOLEAN',
    :'digital_signature_details' => :'PdfDigitalSignatureDetails'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      save_format == o.save_format &&
      default_font == o.default_font &&
      area == o.area &&
      export_guide_shapes == o.export_guide_shapes &&
      page_size == o.page_size &&
      is_export_comments == o.is_export_comments &&
      horizontal_resolution == o.horizontal_resolution &&
      vertical_resolution == o.vertical_resolution &&
      page_count == o.page_count &&
      jpeg_quality == o.jpeg_quality &&
      export_hidden_page == o.export_hidden_page &&
      page_index == o.page_index &&
      save_foreground_pages_only == o.save_foreground_pages_only &&
      compliance == o.compliance &&
      encryption_details == o.encryption_details &&
      text_compression == o.text_compression &&
      split_multi_pages == o.split_multi_pages &&
      digital_signature_details == o.digital_signature_details
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



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
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 326

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 392

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 305

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


292
293
294
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



298
299
300
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 298

def hash
  [save_format, default_font, area, export_guide_shapes, page_size, is_export_comments, horizontal_resolution, vertical_resolution, page_count, jpeg_quality, export_hidden_page, page_index, save_foreground_pages_only, compliance, encryption_details, text_compression, split_multi_pages, digital_signature_details].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



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 208

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

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



372
373
374
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 372

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



378
379
380
381
382
383
384
385
386
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 378

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



366
367
368
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 366

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



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/AsposeDiagramCloud/models/pdf_save_options.rb', line 223

def valid?
  return false if @save_format.nil?
  save_format_validator = EnumAttributeValidator.new('String', ["VDX", "VSX", "VTX", "TIFF", "PNG", "BMP", "EMF", "JPEG", "PDF", "XPS", "GIF", "HTML", "SVG", "SWF", "XAML", "VSDX", "VSTX", "VSSX", "VSDM", "VSSM", "VSTM"])
  return false unless save_format_validator.valid?(@save_format)
  return false if @area.nil?
  compliance_validator = EnumAttributeValidator.new('String', ["Pdf15", "PdfA1a", "PdfA1b"])
  return false unless compliance_validator.valid?(@compliance)
  text_compression_validator = EnumAttributeValidator.new('String', ["None", "Flate"])
  return false unless text_compression_validator.valid?(@text_compression)
  return true
end