Class: DocuSign_eSign::Radio
- Inherits:
-
Object
- Object
- DocuSign_eSign::Radio
- Defined in:
- lib/docusign_esign/models/radio.rb
Instance Attribute Summary collapse
-
#anchor_case_sensitive ⇒ Object
When set to true, the anchor string does not consider case when matching strings in the document.
-
#anchor_horizontal_alignment ⇒ Object
Specifies the alignment of anchor tabs with anchor strings.
-
#anchor_ignore_if_not_present ⇒ Object
When set to true, this tab is ignored if anchorString is not found in the document.
-
#anchor_match_whole_word ⇒ Object
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
-
#anchor_string ⇒ Object
Anchor text information for a radio button.
-
#anchor_units ⇒ Object
Specifies units of the X and Y offset.
-
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
-
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
-
#page_number ⇒ Object
Specifies the page number on which the tab is located.
-
#required ⇒ Object
When set to true, the signer is required to fill out this tab.
-
#selected ⇒ Object
When set to true, the radio button is selected.
-
#tab_id ⇒ Object
The unique identifier for the tab.
-
#tab_order ⇒ Object
Returns the value of attribute tab_order.
-
#value ⇒ Object
Specifies the value of the tab.
-
#x_position ⇒ Object
This indicates the horizontal offset of the object on the page.
-
#y_position ⇒ Object
This indicates the vertical offset of the object on the page.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Radio
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Radio
Initializes the object
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/docusign_esign/models/radio.rb', line 121 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?(:'anchorCaseSensitive') self.anchor_case_sensitive = attributes[:'anchorCaseSensitive'] end if attributes.has_key?(:'anchorHorizontalAlignment') self.anchor_horizontal_alignment = attributes[:'anchorHorizontalAlignment'] end if attributes.has_key?(:'anchorIgnoreIfNotPresent') self.anchor_ignore_if_not_present = attributes[:'anchorIgnoreIfNotPresent'] end if attributes.has_key?(:'anchorMatchWholeWord') self.anchor_match_whole_word = attributes[:'anchorMatchWholeWord'] end if attributes.has_key?(:'anchorString') self.anchor_string = attributes[:'anchorString'] end if attributes.has_key?(:'anchorUnits') self.anchor_units = attributes[:'anchorUnits'] end if attributes.has_key?(:'anchorXOffset') self.anchor_x_offset = attributes[:'anchorXOffset'] end if attributes.has_key?(:'anchorYOffset') self.anchor_y_offset = attributes[:'anchorYOffset'] end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'locked') self.locked = attributes[:'locked'] end if attributes.has_key?(:'pageNumber') self.page_number = attributes[:'pageNumber'] end if attributes.has_key?(:'required') self.required = attributes[:'required'] end if attributes.has_key?(:'selected') self.selected = attributes[:'selected'] end if attributes.has_key?(:'tabId') self.tab_id = attributes[:'tabId'] end if attributes.has_key?(:'tabOrder') self.tab_order = attributes[:'tabOrder'] end if attributes.has_key?(:'value') self.value = attributes[:'value'] end if attributes.has_key?(:'xPosition') self.x_position = attributes[:'xPosition'] end if attributes.has_key?(:'yPosition') self.y_position = attributes[:'yPosition'] end end |
Instance Attribute Details
#anchor_case_sensitive ⇒ Object
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
18 19 20 |
# File 'lib/docusign_esign/models/radio.rb', line 18 def anchor_case_sensitive @anchor_case_sensitive end |
#anchor_horizontal_alignment ⇒ Object
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
21 22 23 |
# File 'lib/docusign_esign/models/radio.rb', line 21 def anchor_horizontal_alignment @anchor_horizontal_alignment end |
#anchor_ignore_if_not_present ⇒ Object
When set to true, this tab is ignored if anchorString is not found in the document.
24 25 26 |
# File 'lib/docusign_esign/models/radio.rb', line 24 def anchor_ignore_if_not_present @anchor_ignore_if_not_present end |
#anchor_match_whole_word ⇒ Object
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
27 28 29 |
# File 'lib/docusign_esign/models/radio.rb', line 27 def anchor_match_whole_word @anchor_match_whole_word end |
#anchor_string ⇒ Object
Anchor text information for a radio button.
30 31 32 |
# File 'lib/docusign_esign/models/radio.rb', line 30 def anchor_string @anchor_string end |
#anchor_units ⇒ Object
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
33 34 35 |
# File 'lib/docusign_esign/models/radio.rb', line 33 def anchor_units @anchor_units end |
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
36 37 38 |
# File 'lib/docusign_esign/models/radio.rb', line 36 def anchor_x_offset @anchor_x_offset end |
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
39 40 41 |
# File 'lib/docusign_esign/models/radio.rb', line 39 def anchor_y_offset @anchor_y_offset end |
#error_details ⇒ Object
Returns the value of attribute error_details.
41 42 43 |
# File 'lib/docusign_esign/models/radio.rb', line 41 def error_details @error_details end |
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
44 45 46 |
# File 'lib/docusign_esign/models/radio.rb', line 44 def locked @locked end |
#page_number ⇒ Object
Specifies the page number on which the tab is located.
47 48 49 |
# File 'lib/docusign_esign/models/radio.rb', line 47 def page_number @page_number end |
#required ⇒ Object
When set to true, the signer is required to fill out this tab
50 51 52 |
# File 'lib/docusign_esign/models/radio.rb', line 50 def required @required end |
#selected ⇒ Object
When set to true, the radio button is selected.
53 54 55 |
# File 'lib/docusign_esign/models/radio.rb', line 53 def selected @selected end |
#tab_id ⇒ Object
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
56 57 58 |
# File 'lib/docusign_esign/models/radio.rb', line 56 def tab_id @tab_id end |
#tab_order ⇒ Object
Returns the value of attribute tab_order.
59 60 61 |
# File 'lib/docusign_esign/models/radio.rb', line 59 def tab_order @tab_order end |
#value ⇒ Object
Specifies the value of the tab.
62 63 64 |
# File 'lib/docusign_esign/models/radio.rb', line 62 def value @value end |
#x_position ⇒ Object
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
65 66 67 |
# File 'lib/docusign_esign/models/radio.rb', line 65 def x_position @x_position end |
#y_position ⇒ Object
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
68 69 70 |
# File 'lib/docusign_esign/models/radio.rb', line 68 def y_position @y_position end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/docusign_esign/models/radio.rb', line 72 def self.attribute_map { :'anchor_case_sensitive' => :'anchorCaseSensitive', :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment', :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent', :'anchor_match_whole_word' => :'anchorMatchWholeWord', :'anchor_string' => :'anchorString', :'anchor_units' => :'anchorUnits', :'anchor_x_offset' => :'anchorXOffset', :'anchor_y_offset' => :'anchorYOffset', :'error_details' => :'errorDetails', :'locked' => :'locked', :'page_number' => :'pageNumber', :'required' => :'required', :'selected' => :'selected', :'tab_id' => :'tabId', :'tab_order' => :'tabOrder', :'value' => :'value', :'x_position' => :'xPosition', :'y_position' => :'yPosition' } end |
.swagger_types ⇒ Object
Attribute type mapping.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/docusign_esign/models/radio.rb', line 96 def self.swagger_types { :'anchor_case_sensitive' => :'String', :'anchor_horizontal_alignment' => :'String', :'anchor_ignore_if_not_present' => :'String', :'anchor_match_whole_word' => :'String', :'anchor_string' => :'String', :'anchor_units' => :'String', :'anchor_x_offset' => :'String', :'anchor_y_offset' => :'String', :'error_details' => :'ErrorDetails', :'locked' => :'String', :'page_number' => :'String', :'required' => :'String', :'selected' => :'String', :'tab_id' => :'String', :'tab_order' => :'String', :'value' => :'String', :'x_position' => :'String', :'y_position' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/docusign_esign/models/radio.rb', line 216 def ==(o) return true if self.equal?(o) self.class == o.class && anchor_case_sensitive == o.anchor_case_sensitive && anchor_horizontal_alignment == o.anchor_horizontal_alignment && anchor_ignore_if_not_present == o.anchor_ignore_if_not_present && anchor_match_whole_word == o.anchor_match_whole_word && anchor_string == o.anchor_string && anchor_units == o.anchor_units && anchor_x_offset == o.anchor_x_offset && anchor_y_offset == o.anchor_y_offset && error_details == o.error_details && locked == o.locked && page_number == o.page_number && required == o.required && selected == o.selected && tab_id == o.tab_id && tab_order == o.tab_order && value == o.value && x_position == o.x_position && y_position == o.y_position end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/docusign_esign/models/radio.rb', line 275 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
341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/docusign_esign/models/radio.rb', line 341 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
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/docusign_esign/models/radio.rb', line 254 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
241 242 243 |
# File 'lib/docusign_esign/models/radio.rb', line 241 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
247 248 249 |
# File 'lib/docusign_esign/models/radio.rb', line 247 def hash [anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_string, anchor_units, anchor_x_offset, anchor_y_offset, error_details, locked, page_number, required, selected, tab_id, tab_order, value, x_position, y_position].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
203 204 205 206 |
# File 'lib/docusign_esign/models/radio.rb', line 203 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)
321 322 323 |
# File 'lib/docusign_esign/models/radio.rb', line 321 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
327 328 329 330 331 332 333 334 335 |
# File 'lib/docusign_esign/models/radio.rb', line 327 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
315 316 317 |
# File 'lib/docusign_esign/models/radio.rb', line 315 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
210 211 212 |
# File 'lib/docusign_esign/models/radio.rb', line 210 def valid? return true end |