Module: PDF::Core::Text

Included in:
Prawn::Text
Defined in:
lib/pdf/core/text.rb

Overview

:nodoc:

Constant Summary collapse

VALID_OPTIONS =

These should be used as a base. Extensions may build on this list

[:kerning, :size, :style]
MODES = 
{ :fill => 0, :stroke => 1, :fill_stroke => 2, :invisible => 3,
:fill_clip => 4, :stroke_clip => 5, :fill_stroke_clip => 6,
:clip => 7 }

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#skip_encoding ⇒ Object (readonly)

Returns the value of attribute skip_encoding.



20
21
22
 
# File 'lib/pdf/core/text.rb', line 20

def skip_encoding
  @skip_encoding
end

Instance Method Details

#character_spacing(amount = nil) ⇒ Object

Increases or decreases the space between characters. For horizontal text, a positive value will increase the space. For veritical text, a positive value will decrease the space.



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/pdf/core/text.rb', line 216

def character_spacing(amount=nil)
  return defined?(@character_spacing) && @character_spacing || 0 if amount.nil?
  original_character_spacing = character_spacing
  if original_character_spacing == amount
    yield
  else
    @character_spacing = amount
    add_content "\n%.3f Tc" % amount
    yield
    add_content "\n%.3f Tc" % original_character_spacing
    @character_spacing = original_character_spacing
  end
end

#default_kerning(boolean) ⇒ Object Also known as: default_kerning=

Call with a boolean to set the document-wide kerning setting. This can be overridden using the :kerning text option when drawing text or a text box.

pdf.default_kerning = false
pdf.text("hello world")                   # text is not kerned
pdf.text("hello world", :kerning => true) # text is kerned



64
65
66
 
# File 'lib/pdf/core/text.rb', line 64

def default_kerning(boolean)
  @default_kerning = boolean
end

#default_kerning? ⇒ Boolean

Retrieve the current default kerning setting.

Defaults to true

Returns:

  • (Boolean) 


51
52
53
54
 
# File 'lib/pdf/core/text.rb', line 51

def default_kerning?
  return true if !defined?(@default_kerning)
  @default_kerning
end

#default_leading(number = nil) ⇒ Object Also known as: default_leading=

Call with no argument to retrieve the current default leading.

Call with a number to set the document-wide text leading. This can be overridden using the :leading text option when drawing text or a text box.

pdf.default_leading = 7
pdf.text("hello world")                # a leading of 7 is used
pdf.text("hello world", :leading => 0) # a leading of 0 is used

Defaults to 0



82
83
84
85
86
87
88
 
# File 'lib/pdf/core/text.rb', line 82

def default_leading(number=nil)
  if number.nil?
    defined?(@default_leading) && @default_leading || 0
  else
    @default_leading = number
  end
end

#draw_text!(text, options) ⇒ Object

Low level text placement method. All font and size alterations should already be set



25
26
27
28
 
# File 'lib/pdf/core/text.rb', line 25

def draw_text!(text, options)
  x,y = map_to_absolute(options[:at])
  add_text_content(text,x,y,options)
end

#fallback_fonts(fallback_fonts = nil) ⇒ Object Also known as: fallback_fonts=

Call with no argument to retrieve the current fallback fonts.

Call with an array of font names. Each name must be the name of an AFM font or the name that was used to register a family of TTF fonts (see Prawn::Document#font_families). If present, then each glyph will be rendered using the first font that includes the glyph, starting with the current font and then moving through :fallback_fonts from left to right.

Call with an empty array to turn off fallback fonts

file = “#Prawn::DATADIR/fonts/gkai00mp.ttf” font_families = {

:normal => { :file => file, :font => "Kai" }

} file = “#Prawn::DATADIR/fonts/Action Man.dfont” font_families[“Action Man”] = {

:normal      => { :file => file, :font => "ActionMan" },

} fallback_fonts [“Times-Roman”, “Kai”] font “Action Man” text “hello ƒ 你好” > hello prints in Action Man > ƒ prints in Times-Roman > 你好 prints in Kai

fallback_fonts [] # clears document-wide fallback fonts

Side effects:

  • Increased overhead when fallback fonts are declared as each glyph is checked to see whether it exists in the current font



154
155
156
157
158
159
160
 
# File 'lib/pdf/core/text.rb', line 154

def fallback_fonts(fallback_fonts=nil)
  if fallback_fonts.nil?
    defined?(@fallback_fonts) && @fallback_fonts || []
  else
    @fallback_fonts = fallback_fonts
  end
end

#forget_text_rendering_mode! ⇒ Object 



208
209
210
 
# File 'lib/pdf/core/text.rb', line 208

def forget_text_rendering_mode!
  @text_rendering_mode = :unknown
end

#process_text_options(options) ⇒ Object

Low level call to set the current font style and extract text options from an options hash. Should be called from within a save_font block



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/pdf/core/text.rb', line 33

def process_text_options(options)
  if options[:style]
    raise "Bad font family" unless font.family
    font(font.family, :style => options[:style])
  end

  # must compare against false to keep kerning on as default
  unless options[:kerning] == false
    options[:kerning] = font.has_kerning_data?
  end

  options[:size] ||= font_size
end

#text_direction(direction = nil) ⇒ Object Also known as: text_direction=

Call with no argument to retrieve the current text direction.

Call with a symbol to set the document-wide text direction. This can be overridden using the :direction text option when drawing text or a text box.

pdf.text_direction = :rtl
pdf.text("hello world")                     # prints "dlrow olleh"
pdf.text("hello world", :direction => :ltr) # prints "hello world"

Valid directions are:

  • :ltr - left-to-right (default)

  • :rtl - right-to-left

Side effects:

  • When printing left-to-right, the default text alignment is :left

  • When printing right-to-left, the default text alignment is :right



112
113
114
115
116
117
118
 
# File 'lib/pdf/core/text.rb', line 112

def text_direction(direction=nil)
  if direction.nil?
    defined?(@text_direction) && @text_direction || :ltr
  else
    @text_direction = direction
  end
end

#text_rendering_mode(mode = nil) ⇒ Object

Call with no argument to retrieve the current text rendering mode.

Call with a symbol and block to temporarily change the current text rendering mode.

pdf.text_rendering_mode(:stroke) do
  pdf.text("Outlined Text")
end

Valid modes are:

  • :fill - fill text (default)

  • :stroke - stroke text

  • :fill_stroke - fill, then stroke text

  • :invisible - invisible text

  • :fill_clip - fill text then add to path for clipping

  • :stroke_clip - stroke text then add to path for clipping

  • :fill_stroke_clip - fill then stroke text, then add to path for clipping

  • :clip - add text to path for clipping

There’s the special mode :unknown which only occurs when we’re working with templates. If left in :unknown, the first text command will force an assertion to :fill.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/pdf/core/text.rb', line 187

def text_rendering_mode(mode=nil)
  return (defined?(@text_rendering_mode) && @text_rendering_mode || :fill) if mode.nil?
  unless MODES.key?(mode)
    raise ArgumentError, "mode must be between one of #{MODES.keys.join(', ')} (#{mode})"
  end
  original_mode = self.text_rendering_mode
  if original_mode == :unknown
    original_mode = :fill
    add_content "\n#{MODES[:fill]} Tr"
  end
  if original_mode == mode
    yield
  else
    @text_rendering_mode = mode
    add_content "\n#{MODES[mode]} Tr"
    yield
    add_content "\n#{MODES[original_mode]} Tr"
    @text_rendering_mode = original_mode
  end
end

#word_spacing(amount = nil) ⇒ Object

Increases or decreases the space between words. For horizontal text, a positive value will increase the space. For veritical text, a positive value will decrease the space.



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/pdf/core/text.rb', line 234

def word_spacing(amount=nil)
  return defined?(@word_spacing) && @word_spacing || 0 if amount.nil?
  original_word_spacing = word_spacing
  if original_word_spacing == amount
    yield
  else
    @word_spacing = amount
    add_content "\n%.3f Tw" % amount
    yield
    add_content "\n%.3f Tw" % original_word_spacing
    @word_spacing = original_word_spacing
  end
end