class DocuSign_eSign::DocumentHtmlDisplaySettings
Attributes
This object defines the appearance and function of a collapsible section or item.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object
to be compared
# File lib/docusign_esign/models/document_html_display_settings.rb, line 179 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/document_html_display_settings.rb, line 147 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docusign_esign/models/document_html_display_settings.rb, line 253 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docusign_esign/models/document_html_display_settings.rb, line 154 def valid? true end