Class: DynamicPDFApi::MsiBarcodeElement

Inherits:
TextBarcodeElement show all
Defined in:
lib/ruby_client/Elements/MsiBarcodeElement.rb

Overview

Represents a MSI Barcode element (also known as Modified Plessey).

Instance Attribute Summary collapse

Attributes inherited from TextBarcodeElement

#_font_name, #_resource, #_text_font, #font_size, #show_text, #text_color

Attributes inherited from BarcodeElement

#_color_name, #value, #x_dimension

Attributes inherited from Element

#_input_value, #_resource, #_text_font, #even_pages, #odd_pages, #placement, #x_offset, #y_offset

Instance Method Summary collapse

Methods inherited from TextBarcodeElement

#font, #get_font

Methods inherited from BarcodeElement

#color=

Constructor Details

#initialize(value, height, placement = ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0) ⇒ MsiBarcodeElement

Initializes a new instance of the MsiBarcodeElement class.

Parameters:

  • value (String) —

    The value of the barcode.

  • placement (String) (defaults to: ElementPlacement::TOP_LEFT) —

    The placement of the barcode on the page.

  • height (float) —

    The height of the barcode.

  • x_offset (float) (defaults to: 0) —

    The X coordinate of the barcode.

  • y_offset (float) (defaults to: 0) —

    The Y coordinate of the barcode.



18
19
20
21
22
23
 
# File 'lib/ruby_client/Elements/MsiBarcodeElement.rb', line 18

def initialize(value,  height, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
  @append_check_digit = nil
  @height = height
  super(value, placement, x_offset, y_offset)
  @_type = ElementType::MSI_BARCODE
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



25
26
27
 
# File 'lib/ruby_client/Elements/MsiBarcodeElement.rb', line 25

def _type
  @_type
end

#append_check_digit ⇒ Object

Gets or sets a value specifying if the check digit should calculated.



30
31
32
 
# File 'lib/ruby_client/Elements/MsiBarcodeElement.rb', line 30

def append_check_digit
  @append_check_digit
end

#height ⇒ Object

Gets or sets the height of the barcode.



34
35
36
 
# File 'lib/ruby_client/Elements/MsiBarcodeElement.rb', line 34

def height
  @height
end

Instance Method Details

#to_json(_options = {}) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/ruby_client/Elements/MsiBarcodeElement.rb', line 36

def to_json(_options = {})
  json_array = {}

  json_array['type'] = 'msiBarcode'

  json_array['appendCheckDigit'] = @append_check_digit unless @append_check_digit.nil?

  json_array['height'] = @height unless @height.nil?

  #----------------TextBarcodeElement---------------------------------
  json_array['font'] = @_font_name unless @_font_name.nil?

  json_array['textColor'] = @text_color._color_string if !@text_color.nil? && !@text_color._color_string.nil?

  json_array['fontSize'] = @font_size unless @font_size.nil?

  json_array['showText'] = @show_text unless @show_text.nil?

  #----------------barcodeElement--------------------------------

  json_array['color'] = @color._color_string if !@color.nil? && !@color._color_string.nil?

  json_array['xDimension'] = @x_dimension unless @x_dimension.nil?

  json_array['value'] = @value unless @value.nil?

  # ------------element---------------------

  json_array['placement'] = @placement unless @placement.nil?

  json_array['xOffset'] = @x_offset unless @x_offset.nil?

  json_array['yOffset'] = @y_offset unless @y_offset.nil?

  json_array["evenPages"] = @even_pages unless @even_pages.nil?

  json_array["oddPages"] = @odd_pages unless @odd_pages.nil?

  JSON.pretty_generate(json_array)
end