Class: AsposePdfCloud::DisplayProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/display_properties.rb

Overview

Provides link to DisplayProperties.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DisplayProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 93

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?(:'Links')
    if (value = attributes[:'Links']).is_a?(Array)
      self.links = value
    end
  end

  if attributes.has_key?(:'CenterWindow')
    self.center_window = attributes[:'CenterWindow']
  end

  if attributes.has_key?(:'Direction')
    self.direction = attributes[:'Direction']
  end

  if attributes.has_key?(:'DisplayDocTitle')
    self.display_doc_title = attributes[:'DisplayDocTitle']
  end

  if attributes.has_key?(:'HideMenuBar')
    self.hide_menu_bar = attributes[:'HideMenuBar']
  end

  if attributes.has_key?(:'HideToolBar')
    self.hide_tool_bar = attributes[:'HideToolBar']
  end

  if attributes.has_key?(:'HideWindowUI')
    self.hide_window_ui = attributes[:'HideWindowUI']
  end

  if attributes.has_key?(:'NonFullScreenPageMode')
    self.non_full_screen_page_mode = attributes[:'NonFullScreenPageMode']
  end

  if attributes.has_key?(:'PageLayout')
    self.page_layout = attributes[:'PageLayout']
  end

  if attributes.has_key?(:'PageMode')
    self.page_mode = attributes[:'PageMode']
  end

end

Instance Attribute Details

#center_window ⇒ Object

Gets or sets flag specifying whether position of the document’s window will be centerd on the screen.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 32

def center_window
  @center_window
end

#direction ⇒ Object

Gets or sets reading order of text: L2R (left to right) or R2L (right to left).



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 35

def direction
  @direction
end

#display_doc_title ⇒ Object

Gets or sets flag specifying whether document’s window title bar should display document title.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 38

def display_doc_title
  @display_doc_title
end

#hide_menu_bar ⇒ Object

Gets or sets flag specifying whether menu bar should be hidden when document is active.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 41

def hide_menu_bar
  @hide_menu_bar
end

#hide_tool_bar ⇒ Object

Gets or sets flag specifying whether toolbar should be hidden when document is active.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 44

def hide_tool_bar
  @hide_tool_bar
end

#hide_window_ui ⇒ Object

Gets or sets flag specifying whether user interface elements should be hidden when document is active.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 47

def hide_window_ui
  @hide_window_ui
end

#links ⇒ Object

Link to the document.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 29

def links
  @links
end

#non_full_screen_page_mode ⇒ Object

Gets or sets page mode, specifying how to display the document on exiting full-screen mode.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 50

def non_full_screen_page_mode
  @non_full_screen_page_mode
end

#page_layout ⇒ Object

Gets or sets page layout which shall be used when the document is opened.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 53

def page_layout
  @page_layout
end

#page_mode ⇒ Object

Gets or sets page mode, specifying how document should be displayed when opened.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 56

def page_mode
  @page_mode
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 60

def self.attribute_map
  {
    :'links' => :'Links',
    :'center_window' => :'CenterWindow',
    :'direction' => :'Direction',
    :'display_doc_title' => :'DisplayDocTitle',
    :'hide_menu_bar' => :'HideMenuBar',
    :'hide_tool_bar' => :'HideToolBar',
    :'hide_window_ui' => :'HideWindowUI',
    :'non_full_screen_page_mode' => :'NonFullScreenPageMode',
    :'page_layout' => :'PageLayout',
    :'page_mode' => :'PageMode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 76

def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'center_window' => :'BOOLEAN',
    :'direction' => :'Direction',
    :'display_doc_title' => :'BOOLEAN',
    :'hide_menu_bar' => :'BOOLEAN',
    :'hide_tool_bar' => :'BOOLEAN',
    :'hide_window_ui' => :'BOOLEAN',
    :'non_full_screen_page_mode' => :'PageMode',
    :'page_layout' => :'PageLayout',
    :'page_mode' => :'PageMode'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      center_window == o.center_window &&
      direction == o.direction &&
      display_doc_title == o.display_doc_title &&
      hide_menu_bar == o.hide_menu_bar &&
      hide_tool_bar == o.hide_tool_bar &&
      hide_window_ui == o.hide_window_ui &&
      non_full_screen_page_mode == o.non_full_screen_page_mode &&
      page_layout == o.page_layout &&
      page_mode == o.page_mode
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



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
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 209

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 275

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 188

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


175
176
177
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 181

def hash
  [links, center_window, direction, display_doc_title, hide_menu_bar, hide_tool_bar, hide_window_ui, non_full_screen_page_mode, page_layout, page_mode].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



145
146
147
148
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  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



255
256
257
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 255

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



261
262
263
264
265
266
267
268
269
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 261

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



249
250
251
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 249

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



152
153
154
 
# File 'lib/aspose_pdf_cloud/models/display_properties.rb', line 152

def valid?
  return true
end