# ------------------------------------------------------------------------------------
#
# Copyright (c) 2023 Aspose.Words for Cloud
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# ------------------------------------------------------------------------------------
require 'date'
module AsposeWordsCloud
# Represents a border of an object.
# Borders can be applied to various document elements including paragraph, run of text inside a paragraph or a table cell.
class Border
# Gets or sets the link to the document.
attr_accessor :link
# Gets or sets the border type.
attr_accessor :border_type
# Gets or sets the border color.
attr_accessor :color
# Gets or sets the distance of the border from text or from the page edge in points.
# Has no effect and will be automatically reset to zero for borders of table cells.
attr_accessor :distance_from_text
# Gets or sets the border style.
# If you set line style to none, then line width is automatically changed to zero.
attr_accessor :line_style
# Gets or sets the border width in points.
# If you set line width greater than zero when line style is none, the line style is automatically changed to single line.
attr_accessor :line_width
# Gets or sets a value indicating whether the border has a shadow.
# In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.
attr_accessor :shadow
class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
def initialize(datatype, allowable_values)
@allowable_values = allowable_values.map do |value|
case datatype.to_s
when /Integer/i
value.to_i
when /Float/i
value.to_f
else
value
end
end
end
def valid?(value)
!value || allowable_values.include?(value)
end
end
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'link' => :'Link',
:'border_type' => :'BorderType',
:'color' => :'Color',
:'distance_from_text' => :'DistanceFromText',
:'line_style' => :'LineStyle',
:'line_width' => :'LineWidth',
:'shadow' => :'Shadow'
}
end
# Attribute type mapping.
def self.swagger_types
{
:'link' => :'WordsApiLink',
:'border_type' => :'String',
:'color' => :'XmlColor',
:'distance_from_text' => :'Float',
:'line_style' => :'String',
:'line_width' => :'Float',
:'shadow' => :'BOOLEAN'
}
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
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?(:'BorderType')
self.border_type = attributes[:'BorderType']
end
if attributes.key?(:'Color')
self.color = attributes[:'Color']
end
if attributes.key?(:'DistanceFromText')
self.distance_from_text = attributes[:'DistanceFromText']
end
if attributes.key?(:'LineStyle')
self.line_style = attributes[:'LineStyle']
end
if attributes.key?(:'LineWidth')
self.line_width = attributes[:'LineWidth']
end
if attributes.key?(:'Shadow')
self.shadow = attributes[:'Shadow']
end
end
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properies with the reasons
def list_invalid_properties
invalid_properties = []
return invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
border_type_validator = EnumAttributeValidator.new('String', ["Bottom", "Left", "Right", "Top", "Horizontal", "Vertical", "DiagonalDown", "DiagonalUp", "None"])
return false unless border_type_validator.valid?(@border_type)
line_style_validator = EnumAttributeValidator.new('String', ["None", "Single", "Thick", "Double", "Hairline", "Dot", "DashLargeGap", "DotDash", "DotDotDash", "Triple", "ThinThickSmallGap", "ThickThinSmallGap", "ThinThickThinSmallGap", "ThinThickMediumGap", "ThickThinMediumGap", "ThinThickThinMediumGap", "ThinThickLargeGap", "ThickThinLargeGap", "ThinThickThinLargeGap", "Wave", "DoubleWave", "DashSmallGap", "DashDotStroker", "Emboss3D", "Engrave3D", "Outset", "Inset"])
return false unless line_style_validator.valid?(@line_style)
return true
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] border_type Object to be assigned
def border_type=(border_type)
validator = EnumAttributeValidator.new('String', ["Bottom", "Left", "Right", "Top", "Horizontal", "Vertical", "DiagonalDown", "DiagonalUp", "None"])
if border_type.to_i == 0
unless validator.valid?(border_type)
raise ArgumentError, "invalid value for 'border_type', must be one of #{validator.allowable_values}."
end
@border_type = border_type
else
@border_type = validator.allowable_values[border_type.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] line_style Object to be assigned
def line_style=(line_style)
validator = EnumAttributeValidator.new('String', ["None", "Single", "Thick", "Double", "Hairline", "Dot", "DashLargeGap", "DotDash", "DotDotDash", "Triple", "ThinThickSmallGap", "ThickThinSmallGap", "ThinThickThinSmallGap", "ThinThickMediumGap", "ThickThinMediumGap", "ThinThickThinMediumGap", "ThinThickLargeGap", "ThickThinLargeGap", "ThinThickThinLargeGap", "Wave", "DoubleWave", "DashSmallGap", "DashDotStroker", "Emboss3D", "Engrave3D", "Outset", "Inset"])
if line_style.to_i == 0
unless validator.valid?(line_style)
raise ArgumentError, "invalid value for 'line_style', must be one of #{validator.allowable_values}."
end
@line_style = line_style
else
@line_style = validator.allowable_values[line_style.to_i]
end
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(other)
return true if self.equal?(other)
self.class == other.class &&
link == other.link &&
border_type == other.border_type &&
color == other.color &&
distance_from_text == other.distance_from_text &&
line_style == other.line_style &&
line_width == other.line_width &&
shadow == other.shadow
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(other)
self == other
end
# Calculates hash code according to all attributes.
# @return [Fixnum] Hash code
def hash
[link, border_type, color, distance_from_text, line_style, line_width, shadow].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\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
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# 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
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
def collectFilesContent(resultFilesContent)
end
end
end