Class: Ilovepdf::Tool::Watermark

Inherits:
Ilovepdf::Task show all
Defined in:
lib/ilovepdf/tool/watermark.rb

Constant Summary collapse

API_PARAMS = 
[
  :mode, :text, :image, :pages, :vertical_position, :horizontal_position,
  :vertical_position_adjustment, :horizontal_position_adjustment, :mosaic,
  :rotate, :font_family, :font_style, :font_size, :font_color, :transparency,
  :layer, :elements
]
MODE_VALUES = 
['image', 'text', 'multi']

Constants inherited from Ilovepdf::Task

Ilovepdf::Task::DOWNLOAD_INFO

Constants included from Ilovepdf

VERSION

Instance Attribute Summary

Attributes inherited from Ilovepdf::Task

#ignore_errors, #ignore_password, #output_filename, #packaged_filename, #result, #task_id, #tool, #try_pdf_repair

Instance Method Summary collapse

Methods inherited from Ilovepdf::Task

#add_file, #add_file_from_url, #assign_meta_value, #blob, #chained_task?, #delete!, #delete_file, #download, #download_info, #enable_file_encryption, #execute, #files, #next, #status

Methods included from Ilovepdf

root

Constructor Details

#initialize(public_key, secret_key, make_start = true) ⇒ Watermark

Returns a new instance of Watermark.



15
16
17
18
 
# File 'lib/ilovepdf/tool/watermark.rb', line 15

def initialize(public_key, secret_key, make_start=true)
  self.tool = :watermark
  super(public_key, secret_key, make_start)
end

Instance Method Details

#add_element(element) ⇒ Object

Raises:



20
21
22
23
 
# File 'lib/ilovepdf/tool/watermark.rb', line 20

def add_element(element)
  raise Errors::ArgumentError.new("Element must be of type 'Ilovepdf::Element'") unless element.instance_of?(::Ilovepdf::Element)
  elements << element
end

#elements ⇒ Object 



25
26
27
 
# File 'lib/ilovepdf/tool/watermark.rb', line 25

def elements
  @elements ||= []
end

#font_family=(new_val) ⇒ Object

Raises:



44
45
46
47
 
# File 'lib/ilovepdf/tool/watermark.rb', line 44

def font_family=(new_val)
  raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::FONT_FAMILY_VALUES) unless ::Ilovepdf::Element::FONT_FAMILY_VALUES.include? new_val
  @font_family = new_val
end

#horizontal_position=(new_val) ⇒ Object

Raises:



39
40
41
42
 
# File 'lib/ilovepdf/tool/watermark.rb', line 39

def horizontal_position=(new_val)
  raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::HORIZONTAL_POSITION_VALUES) unless ::Ilovepdf::Element::HORIZONTAL_POSITION_VALUES.include? new_val
  @horizontal_position = new_val
end

#layer=(new_val) ⇒ Object

Raises:



49
50
51
52
 
# File 'lib/ilovepdf/tool/watermark.rb', line 49

def layer=(new_val)
  raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::LAYER_VALUES) unless ::Ilovepdf::Element::LAYER_VALUES.include? new_val
  @layer = new_val
end

#mode=(new_val) ⇒ Object

Raises:



29
30
31
32
 
# File 'lib/ilovepdf/tool/watermark.rb', line 29

def mode=(new_val)
  raise Errors::ArgumentEnumError.new(MODE_VALUES) unless MODE_VALUES.include? new_val
  @mode = new_val
end

#vertical_position=(new_val) ⇒ Object

Raises:



34
35
36
37
 
# File 'lib/ilovepdf/tool/watermark.rb', line 34

def vertical_position=(new_val)
  raise Errors::ArgumentEnumError.new(::Ilovepdf::Element::VERTICAL_POSITION_VALUES) unless ::Ilovepdf::Element::VERTICAL_POSITION_VALUES.include? new_val
  @vertical_position = new_val
end