Class: DocuSign_eSign::DocumentHtmlDisplaySettings

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/document_html_display_settings.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentHtmlDisplaySettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
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
142
143
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 90

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

  if attributes.has_key?(:'collapsibleSettings')
    self.collapsible_settings = attributes[:'collapsibleSettings']
  end

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

  if attributes.has_key?(:'displayLabel')
    self.display_label = attributes[:'displayLabel']
  end

  if attributes.has_key?(:'displayOrder')
    self.display_order = attributes[:'displayOrder']
  end

  if attributes.has_key?(:'displayPageNumber')
    self.display_page_number = attributes[:'displayPageNumber']
  end

  if attributes.has_key?(:'hideLabelWhenOpened')
    self.hide_label_when_opened = attributes[:'hideLabelWhenOpened']
  end

  if attributes.has_key?(:'inlineOuterStyle')
    self.inline_outer_style = attributes[:'inlineOuterStyle']
  end

  if attributes.has_key?(:'labelWhenOpened')
    self.label_when_opened = attributes[:'labelWhenOpened']
  end

  if attributes.has_key?(:'preLabel')
    self.pre_label = attributes[:'preLabel']
  end

  if attributes.has_key?(:'scrollToTopWhenOpened')
    self.scroll_to_top_when_opened = attributes[:'scrollToTopWhenOpened']
  end

  if attributes.has_key?(:'tableStyle')
    self.table_style = attributes[:'tableStyle']
  end
end

Instance Attribute Details

#cell_style ⇒ Object

Returns the value of attribute cell_style.



17
18
19
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 17

def cell_style
  @cell_style
end

#collapsible_settings ⇒ Object

This object defines the appearance and function of a collapsible section or item.



20
21
22
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 20

def collapsible_settings
  @collapsible_settings
end

#display ⇒ Object

Returns the value of attribute display.



23
24
25
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 23

def display
  @display
end

#display_label ⇒ Object

Returns the value of attribute display_label.



26
27
28
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 26

def display_label
  @display_label
end

#display_order ⇒ Object

Returns the value of attribute display_order.



29
30
31
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 29

def display_order
  @display_order
end

#display_page_number ⇒ Object

Returns the value of attribute display_page_number.



32
33
34
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 32

def display_page_number
  @display_page_number
end

#hide_label_when_opened ⇒ Object

Returns the value of attribute hide_label_when_opened.



35
36
37
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 35

def hide_label_when_opened
  @hide_label_when_opened
end

#inline_outer_style ⇒ Object

Returns the value of attribute inline_outer_style.



38
39
40
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 38

def inline_outer_style
  @inline_outer_style
end

#label_when_opened ⇒ Object

Returns the value of attribute label_when_opened.



41
42
43
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 41

def label_when_opened
  @label_when_opened
end

#pre_label ⇒ Object

Returns the value of attribute pre_label.



44
45
46
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 44

def pre_label
  @pre_label
end

#scroll_to_top_when_opened ⇒ Object

Returns the value of attribute scroll_to_top_when_opened.



47
48
49
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 47

def scroll_to_top_when_opened
  @scroll_to_top_when_opened
end

#table_style ⇒ Object

Returns the value of attribute table_style.



50
51
52
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 50

def table_style
  @table_style
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 53

def self.attribute_map
  {
    :'cell_style' => :'cellStyle',
    :'collapsible_settings' => :'collapsibleSettings',
    :'display' => :'display',
    :'display_label' => :'displayLabel',
    :'display_order' => :'displayOrder',
    :'display_page_number' => :'displayPageNumber',
    :'hide_label_when_opened' => :'hideLabelWhenOpened',
    :'inline_outer_style' => :'inlineOuterStyle',
    :'label_when_opened' => :'labelWhenOpened',
    :'pre_label' => :'preLabel',
    :'scroll_to_top_when_opened' => :'scrollToTopWhenOpened',
    :'table_style' => :'tableStyle'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 71

def self.swagger_types
  {
    :'cell_style' => :'String',
    :'collapsible_settings' => :'DocumentHtmlCollapsibleDisplaySettings',
    :'display' => :'String',
    :'display_label' => :'String',
    :'display_order' => :'Integer',
    :'display_page_number' => :'Integer',
    :'hide_label_when_opened' => :'BOOLEAN',
    :'inline_outer_style' => :'String',
    :'label_when_opened' => :'String',
    :'pre_label' => :'String',
    :'scroll_to_top_when_opened' => :'BOOLEAN',
    :'table_style' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cell_style == o.cell_style &&
      collapsible_settings == o.collapsible_settings &&
      display == o.display &&
      display_label == o.display_label &&
      display_order == o.display_order &&
      display_page_number == o.display_page_number &&
      hide_label_when_opened == o.hide_label_when_opened &&
      inline_outer_style == o.inline_outer_style &&
      label_when_opened == o.label_when_opened &&
      pre_label == o.pre_label &&
      scroll_to_top_when_opened == o.scroll_to_top_when_opened &&
      table_style == o.table_style
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



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
248
249
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 213

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 279

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 192

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


179
180
181
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 185

def hash
  [cell_style, collapsible_settings, display, display_label, display_order, display_page_number, hide_label_when_opened, inline_outer_style, label_when_opened, pre_label, scroll_to_top_when_opened, table_style].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



147
148
149
150
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 147

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



259
260
261
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 259

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



265
266
267
268
269
270
271
272
273
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 265

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



253
254
255
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 253

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



154
155
156
 
# File 'lib/docusign_esign/models/document_html_display_settings.rb', line 154

def valid?
  true
end