class AsposeWordsCloud::HeaderFooter
DTO container with a section element.
Attributes
Gets or sets the child nodes.
Gets or sets the link to DrawingObjects resource.
Gets or sets the link to the document.
Gets or sets the link to Paragraphs resource.
Gets or sets the paragraph’s text.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 70 def self.attribute_map { :'link' => :'Link', :'type' => :'Type', :'child_nodes' => :'ChildNodes', :'paragraphs' => :'Paragraphs', :'drawing_objects' => :'DrawingObjects' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/aspose_words_cloud/models/header_footer.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.key?(:'Link') self.link = attributes[:'Link'] end if attributes.key?(:'Type') self.type = attributes[:'Type'] end if attributes.key?(:'ChildNodes') if (value = attributes[:'ChildNodes']).is_a?(Array) self.child_nodes = value end end if attributes.key?(:'Paragraphs') self.paragraphs = attributes[:'Paragraphs'] end if attributes.key?(:'DrawingObjects') self.drawing_objects = attributes[:'DrawingObjects'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 81 def self.swagger_types { :'link' => :'WordsApiLink', :'type' => :'String', :'child_nodes' => :'Array<NodeLink>', :'paragraphs' => :'LinkElement', :'drawing_objects' => :'LinkElement' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 148 def ==(other) return true if self.equal?(other) self.class == other.class && link == other.link && type == other.type && child_nodes == other.child_nodes && paragraphs == other.paragraphs && drawing_objects == other.drawing_objects end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 195 def _deserialize(type, value) case type.to_sym when :DateTime Time.at(/\d/.match(value)[0].to_f).to_datetime when :Date Time.at(/\d/.match(value)[0].to_f).to_date 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 if value[:'$type'] type = value[:'$type'][0..-4] end temp_model = AsposeWordsCloud.const_get(type).new temp_model.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 266 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
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
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 173 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 280 def collectFilesContent(resultFilesContent) end
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 160 def eql?(other) self == other end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 166 def hash [link, type, child_nodes, paragraphs, drawing_objects].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 252 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 240 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 133 def type=(type) validator = EnumAttributeValidator.new('String', ["HeaderEven", "HeaderPrimary", "FooterEven", "FooterPrimary", "HeaderFirst", "FooterFirst"]) if type.to_i == 0 unless validator.valid?(type) raise ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}." end @type = type else @type = validator.allowable_values[type.to_i] end end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 124 def valid? type_validator = EnumAttributeValidator.new('String', ["HeaderEven", "HeaderPrimary", "FooterEven", "FooterPrimary", "HeaderFirst", "FooterFirst"]) return false unless type_validator.valid?(@type) return true end
Check to see if the all the properties in the model are valid @return true if the model is valid
Source
# File lib/aspose_words_cloud/models/header_footer.rb, line 283 def validate() raise ArgumentError, 'Property type in HeaderFooter is required.' if self.type.nil? unless self.link.nil? self.link.validate end unless self.child_nodes.nil? for elementChildNodes in self.child_nodes unless elementChildNodes.nil? elementChildNodes.validate end end end unless self.paragraphs.nil? self.paragraphs.validate end unless self.drawing_objects.nil? self.drawing_objects.validate end end