Class: AsposePdfCloud::RedactionAnnotation

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

Overview

Provides RedactionAnnotation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RedactionAnnotation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 133

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?(:'Color')
    self.color = attributes[:'Color']
  end

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

  if attributes.has_key?(:'Modified')
    self.modified = attributes[:'Modified']
  end

  if attributes.has_key?(:'Id')
    self.id = attributes[:'Id']
  end

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

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

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

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

  if attributes.has_key?(:'ZIndex')
    self.z_index = attributes[:'ZIndex']
  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?(:'QuadPoint')
    if (value = attributes[:'QuadPoint']).is_a?(Array)
      self.quad_point = value
    end
  end

  if attributes.has_key?(:'FillColor')
    self.fill_color = attributes[:'FillColor']
  end

  if attributes.has_key?(:'BorderColor')
    self.border_color = attributes[:'BorderColor']
  end

  if attributes.has_key?(:'OverlayText')
    self.overlay_text = attributes[:'OverlayText']
  end

  if attributes.has_key?(:'Repeat')
    self.repeat = attributes[:'Repeat']
  end

  if attributes.has_key?(:'TextAlignment')
    self.text_alignment = attributes[:'TextAlignment']
  end

end

Instance Attribute Details

#border_color ⇒ Object

Gets or sets color of border which is drawn when redaction is not active.



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

def border_color
  @border_color
end

#color ⇒ Object

Color of the annotation.



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

def color
  @color
end

#contents ⇒ Object

Get the annotation content.



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

def contents
  @contents
end

#fill_color ⇒ Object

Gets or sets color to fill annotation.



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

def fill_color
  @fill_color
end

#flags ⇒ Object

Gets Flags of the annotation.



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

def flags
  @flags
end

#horizontal_alignment ⇒ Object

Gets HorizontalAlignment of the annotation.



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

def horizontal_alignment
  @horizontal_alignment
end

#id ⇒ Object

Gets ID of the annotation.



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

def id
  @id
end

#links ⇒ Object

Link to the document.



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

def links
  @links
end

#modified ⇒ Object

The date and time when the annotation was last modified.



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

def modified
  @modified
end

#name ⇒ Object

Gets Name of the annotation.



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

def name
  @name
end

#overlay_text ⇒ Object

Text to print on redact annotation.



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

def overlay_text
  @overlay_text
end

#page_index ⇒ Object

Gets PageIndex of the annotation.



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

def page_index
  @page_index
end

#quad_point ⇒ Object

An array of 8xN numbers specifying the coordinates of content region that is intended to be removed.



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

def quad_point
  @quad_point
end

#rect ⇒ Object

Gets Rect of the annotation.



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

def rect
  @rect
end

#repeat ⇒ Object

If true overlay text will be repeated on the annotation.



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

def repeat
  @repeat
end

#text_alignment ⇒ Object

Gets or sets. Alignment of Overlay Text.



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

def text_alignment
  @text_alignment
end

#vertical_alignment ⇒ Object

Gets VerticalAlignment of the annotation.



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

def vertical_alignment
  @vertical_alignment
end

#z_index ⇒ Object

Gets ZIndex of the annotation.



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

def z_index
  @z_index
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 84

def self.attribute_map
  {
    :'links' => :'Links',
    :'color' => :'Color',
    :'contents' => :'Contents',
    :'modified' => :'Modified',
    :'id' => :'Id',
    :'flags' => :'Flags',
    :'name' => :'Name',
    :'rect' => :'Rect',
    :'page_index' => :'PageIndex',
    :'z_index' => :'ZIndex',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'quad_point' => :'QuadPoint',
    :'fill_color' => :'FillColor',
    :'border_color' => :'BorderColor',
    :'overlay_text' => :'OverlayText',
    :'repeat' => :'Repeat',
    :'text_alignment' => :'TextAlignment'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 108

def self.swagger_types
  {
    :'links' => :'Array<Link>',
    :'color' => :'Color',
    :'contents' => :'String',
    :'modified' => :'String',
    :'id' => :'String',
    :'flags' => :'Array<AnnotationFlags>',
    :'name' => :'String',
    :'rect' => :'Rectangle',
    :'page_index' => :'Integer',
    :'z_index' => :'Integer',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'quad_point' => :'Array<Point>',
    :'fill_color' => :'Color',
    :'border_color' => :'Color',
    :'overlay_text' => :'String',
    :'repeat' => :'BOOLEAN',
    :'text_alignment' => :'HorizontalAlignment'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      links == o.links &&
      color == o.color &&
      contents == o.contents &&
      modified == o.modified &&
      id == o.id &&
      flags == o.flags &&
      name == o.name &&
      rect == o.rect &&
      page_index == o.page_index &&
      z_index == o.z_index &&
      horizontal_alignment == o.horizontal_alignment &&
      vertical_alignment == o.vertical_alignment &&
      quad_point == o.quad_point &&
      fill_color == o.fill_color &&
      border_color == o.border_color &&
      overlay_text == o.overlay_text &&
      repeat == o.repeat &&
      text_alignment == o.text_alignment
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



298
299
300
301
302
303
304
305
306
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
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 298

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 364

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 277

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


264
265
266
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 270

def hash
  [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, quad_point, fill_color, border_color, overlay_text, repeat, text_alignment].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



221
222
223
224
225
226
227
228
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 221

def list_invalid_properties
  invalid_properties = Array.new
  if @rect.nil?
    invalid_properties.push("invalid value for 'rect', rect 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



344
345
346
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 344

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



350
351
352
353
354
355
356
357
358
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 350

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



338
339
340
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 338

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



232
233
234
235
 
# File 'lib/aspose_pdf_cloud/models/redaction_annotation.rb', line 232

def valid?
  return false if @rect.nil?
  return true
end