Class: AsposePdfCloud::CheckBoxField

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_cloud/models/check_box_field.rb

Overview

Provides CheckBoxField.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckBoxField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 168

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?(:'Links')
    if (value = attributes[:'Links']).is_a?(Array)
      self.links = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'Flags')
    if (value = attributes[:'Flags']).is_a?(Array)
      self.flags = value
    end
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'AllowedStates')
    if (value = attributes[:'AllowedStates']).is_a?(Array)
      self.allowed_states = value
    end
  end

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

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

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

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

end

Instance Attribute Details

#active_state ⇒ Object

Gets or sets current annotation appearance state.



95
96
97
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 95

def active_state
  @active_state
end

#allowed_states ⇒ Object

Returns list of allowed states.



89
90
91
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 89

def allowed_states
  @allowed_states
end

#border ⇒ Object

Gets or sets annotation border characteristics.



86
87
88
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 86

def border
  @border
end

#checked ⇒ Object

Gets or sets state of check box.



98
99
100
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 98

def checked
  @checked
end

#color ⇒ Object

Color of the annotation.



68
69
70
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 68

def color
  @color
end

#contents ⇒ Object

Get the field content.



71
72
73
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 71

def contents
  @contents
end

#export_value ⇒ Object

Gets or sets export value of CheckBox field.



101
102
103
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 101

def export_value
  @export_value
end

#flags ⇒ Object

Gets Flags of the field.



65
66
67
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 65

def flags
  @flags
end

#full_name ⇒ Object

Full Field name.



35
36
37
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 35

def full_name
  @full_name
end

#height ⇒ Object

Gets or sets height of the field.



47
48
49
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 47

def height
  @height
end

#highlighting ⇒ Object

Field highlighting mode.



77
78
79
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 77

def highlighting
  @highlighting
end

#horizontal_alignment ⇒ Object

Gets HorizontalAlignment of the field.



80
81
82
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 80

def horizontal_alignment
  @horizontal_alignment
end

#is_group ⇒ Object

Is group.



56
57
58
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 56

def is_group
  @is_group
end

#is_shared_field ⇒ Object

Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it’s appearance will be visible on all pages of the document. If false, separated field will be created for every document page.



62
63
64
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 62

def is_shared_field
  @is_shared_field
end

#links ⇒ Object

Link to the document.



29
30
31
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 29

def links
  @links
end

#margin ⇒ Object

Gets or sets a outer margin for paragraph (for pdf generation)



74
75
76
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 74

def margin
  @margin
end

#page_index ⇒ Object

Page index.



44
45
46
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 44

def page_index
  @page_index
end

#parent ⇒ Object

Gets field parent.



59
60
61
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 59

def parent
  @parent
end

#partial_name ⇒ Object

Field name.



32
33
34
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 32

def partial_name
  @partial_name
end

#rect ⇒ Object

Field rectangle.



38
39
40
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 38

def rect
  @rect
end

#style ⇒ Object

Gets or sets style of check box.



92
93
94
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 92

def style
  @style
end

#value ⇒ Object

Field value.



41
42
43
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 41

def value
  @value
end

#vertical_alignment ⇒ Object

Gets VerticalAlignment of the field.



83
84
85
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 83

def vertical_alignment
  @vertical_alignment
end

#width ⇒ Object

Gets or sets width of the field.



50
51
52
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 50

def width
  @width
end

#z_index ⇒ Object

Z index.



53
54
55
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 53

def z_index
  @z_index
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 105

def self.attribute_map
  {
    :'links' => :'Links',
    :'partial_name' => :'PartialName',
    :'full_name' => :'FullName',
    :'rect' => :'Rect',
    :'value' => :'Value',
    :'page_index' => :'PageIndex',
    :'height' => :'Height',
    :'width' => :'Width',
    :'z_index' => :'ZIndex',
    :'is_group' => :'IsGroup',
    :'parent' => :'Parent',
    :'is_shared_field' => :'IsSharedField',
    :'flags' => :'Flags',
    :'color' => :'Color',
    :'contents' => :'Contents',
    :'margin' => :'Margin',
    :'highlighting' => :'Highlighting',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'border' => :'Border',
    :'allowed_states' => :'AllowedStates',
    :'style' => :'Style',
    :'active_state' => :'ActiveState',
    :'checked' => :'Checked',
    :'export_value' => :'ExportValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 136

def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'partial_name' => :'String',
    :'full_name' => :'String',
    :'rect' => :'Rectangle',
    :'value' => :'String',
    :'page_index' => :'Integer',
    :'height' => :'Float',
    :'width' => :'Float',
    :'z_index' => :'Integer',
    :'is_group' => :'BOOLEAN',
    :'parent' => :'FormField',
    :'is_shared_field' => :'BOOLEAN',
    :'flags' => :'Array<AnnotationFlags>',
    :'color' => :'Color',
    :'contents' => :'String',
    :'margin' => :'MarginInfo',
    :'highlighting' => :'LinkHighlightingMode',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'border' => :'Border',
    :'allowed_states' => :'Array<String>',
    :'style' => :'BoxStyle',
    :'active_state' => :'String',
    :'checked' => :'BOOLEAN',
    :'export_value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      partial_name == o.partial_name &&
      full_name == o.full_name &&
      rect == o.rect &&
      value == o.value &&
      page_index == o.page_index &&
      height == o.height &&
      width == o.width &&
      z_index == o.z_index &&
      is_group == o.is_group &&
      parent == o.parent &&
      is_shared_field == o.is_shared_field &&
      flags == o.flags &&
      color == o.color &&
      contents == o.contents &&
      margin == o.margin &&
      highlighting == o.highlighting &&
      horizontal_alignment == o.horizontal_alignment &&
      vertical_alignment == o.vertical_alignment &&
      border == o.border &&
      allowed_states == o.allowed_states &&
      style == o.style &&
      active_state == o.active_state &&
      checked == o.checked &&
      export_value == o.export_value
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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 373

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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 439

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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 352

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


339
340
341
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 339

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



345
346
347
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 345

def hash
  [links, partial_name, full_name, rect, value, page_index, height, width, z_index, is_group, parent, is_shared_field, flags, color, contents, margin, highlighting, horizontal_alignment, vertical_alignment, border, allowed_states, style, active_state, checked, export_value].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 284

def list_invalid_properties
  invalid_properties = Array.new
  if @page_index.nil?
    invalid_properties.push("invalid value for 'page_index', page_index cannot be nil.")
  end

  if @checked.nil?
    invalid_properties.push("invalid value for 'checked', checked cannot be nil.")
  end

  return 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



419
420
421
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 419

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



425
426
427
428
429
430
431
432
433
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 425

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



413
414
415
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 413

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



299
300
301
302
303
 
# File 'lib/aspose_pdf_cloud/models/check_box_field.rb', line 299

def valid?
  return false if @page_index.nil?
  return false if @checked.nil?
  return true
end