Class: AsposePdfCloud::Stamp

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

Overview

Represents Pdf stamps.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Stamp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.has_key?(:'Background')
    self.background = attributes[:'Background']
  end

  if attributes.has_key?(:'BottomMargin')
    self.bottom_margin = attributes[:'BottomMargin']
  end

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

  if attributes.has_key?(:'LeftMargin')
    self.left_margin = attributes[:'LeftMargin']
  end

  if attributes.has_key?(:'Opacity')
    self.opacity = attributes[:'Opacity']
  end

  if attributes.has_key?(:'RightMargin')
    self.right_margin = attributes[:'RightMargin']
  end

  if attributes.has_key?(:'Rotate')
    self.rotate = attributes[:'Rotate']
  end

  if attributes.has_key?(:'RotateAngle')
    self.rotate_angle = attributes[:'RotateAngle']
  end

  if attributes.has_key?(:'TopMargin')
    self.top_margin = attributes[:'TopMargin']
  end

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

  if attributes.has_key?(:'XIndent')
    self.x_indent = attributes[:'XIndent']
  end

  if attributes.has_key?(:'YIndent')
    self.y_indent = attributes[:'YIndent']
  end

  if attributes.has_key?(:'Zoom')
    self.zoom = attributes[:'Zoom']
  end

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

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

  if attributes.has_key?(:'TextState')
    self.text_state = attributes[:'TextState']
  end

  if attributes.has_key?(:'FileName')
    self.file_name = attributes[:'FileName']
  end

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

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

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

  if attributes.has_key?(:'StartingNumber')
    self.starting_number = attributes[:'StartingNumber']
  end

end

Instance Attribute Details

#background ⇒ Object

Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.



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

def background
  @background
end

#bottom_margin ⇒ Object

Gets or sets bottom margin of stamp.



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

def bottom_margin
  @bottom_margin
end

#file_name ⇒ Object

Gets or sets the file name.



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

def file_name
  @file_name
end

#height ⇒ Object

Gets or sets image height. Setting this image allows to scale image vertically.



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

def height
  @height
end

#horizontal_alignment ⇒ Object

Gets or sets Horizontal alignment of stamp on the page.



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

def horizontal_alignment
  @horizontal_alignment
end

#left_margin ⇒ Object

Gets or sets left margin of stamp.



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

def left_margin
  @left_margin
end

#opacity ⇒ Object

Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.



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

def opacity
  @opacity
end

#page_index ⇒ Object

Gets or sets the index of the page.



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

def page_index
  @page_index
end

#right_margin ⇒ Object

Gets or sets right margin of stamp.



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

def right_margin
  @right_margin
end

#rotate ⇒ Object

Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.



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

def rotate
  @rotate
end

#rotate_angle ⇒ Object

Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.



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

def rotate_angle
  @rotate_angle
end

#starting_number ⇒ Object

Gets or sets value of the number of starting page. Other pages will be numbered starting from this value.



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

def starting_number
  @starting_number
end

#text_alignment ⇒ Object

Alignment of the text inside the stamp.



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

def text_alignment
  @text_alignment
end

#text_state ⇒ Object

Gets text properties of the stamp. See TextState for details.



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

def text_state
  @text_state
end

#top_margin ⇒ Object

Gets or sets top margin of stamp.



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

def top_margin
  @top_margin
end

#type ⇒ Object

Gets the stamp type.



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

def type
  @type
end

#value ⇒ Object

Gets or sets string value which is used as stamp on the page.



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

def value
  @value
end

#vertical_alignment ⇒ Object

Gets or sets vertical alignment of stamp on page.



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

def vertical_alignment
  @vertical_alignment
end

#width ⇒ Object

Gets or sets image width. Setting this property allos to scal image horizontally.



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

def width
  @width
end

#x_indent ⇒ Object

Horizontal stamp coordinate, starting from the left.



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

def x_indent
  @x_indent
end

#y_indent ⇒ Object

Vertical stamp coordinate, starting from the bottom.



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

def y_indent
  @y_indent
end

#zoom ⇒ Object

Zooming factor of the stamp. Allows to scale stamp.



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

def zoom
  @zoom
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 96

def self.attribute_map
  {
    :'type' => :'Type',
    :'background' => :'Background',
    :'bottom_margin' => :'BottomMargin',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'left_margin' => :'LeftMargin',
    :'opacity' => :'Opacity',
    :'right_margin' => :'RightMargin',
    :'rotate' => :'Rotate',
    :'rotate_angle' => :'RotateAngle',
    :'top_margin' => :'TopMargin',
    :'vertical_alignment' => :'VerticalAlignment',
    :'x_indent' => :'XIndent',
    :'y_indent' => :'YIndent',
    :'zoom' => :'Zoom',
    :'text_alignment' => :'TextAlignment',
    :'value' => :'Value',
    :'text_state' => :'TextState',
    :'file_name' => :'FileName',
    :'width' => :'Width',
    :'height' => :'Height',
    :'page_index' => :'PageIndex',
    :'starting_number' => :'StartingNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'type' => :'StampType',
    :'background' => :'BOOLEAN',
    :'bottom_margin' => :'Float',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'left_margin' => :'Float',
    :'opacity' => :'Float',
    :'right_margin' => :'Float',
    :'rotate' => :'Rotation',
    :'rotate_angle' => :'Float',
    :'top_margin' => :'Float',
    :'vertical_alignment' => :'VerticalAlignment',
    :'x_indent' => :'Float',
    :'y_indent' => :'Float',
    :'zoom' => :'Float',
    :'text_alignment' => :'HorizontalAlignment',
    :'value' => :'String',
    :'text_state' => :'TextState',
    :'file_name' => :'String',
    :'width' => :'Float',
    :'height' => :'Float',
    :'page_index' => :'Integer',
    :'starting_number' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      background == o.background &&
      bottom_margin == o.bottom_margin &&
      horizontal_alignment == o.horizontal_alignment &&
      left_margin == o.left_margin &&
      opacity == o.opacity &&
      right_margin == o.right_margin &&
      rotate == o.rotate &&
      rotate_angle == o.rotate_angle &&
      top_margin == o.top_margin &&
      vertical_alignment == o.vertical_alignment &&
      x_indent == o.x_indent &&
      y_indent == o.y_indent &&
      zoom == o.zoom &&
      text_alignment == o.text_alignment &&
      value == o.value &&
      text_state == o.text_state &&
      file_name == o.file_name &&
      width == o.width &&
      height == o.height &&
      page_index == o.page_index &&
      starting_number == o.starting_number
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 332

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 398

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 311

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


298
299
300
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



304
305
306
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 304

def hash
  [type, background, bottom_margin, horizontal_alignment, left_margin, opacity, right_margin, rotate, rotate_angle, top_margin, vertical_alignment, x_indent, y_indent, zoom, text_alignment, value, text_state, file_name, width, height, page_index, starting_number].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



251
252
253
254
255
256
257
258
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 251

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



378
379
380
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 378

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



384
385
386
387
388
389
390
391
392
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 384

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



372
373
374
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 372

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



262
263
264
265
 
# File 'lib/aspose_pdf_cloud/models/stamp.rb', line 262

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