Class: Prawn::Font

Inherits:
Object
  • Object
show all
Defined in:
lib/prawn/font.rb,
lib/prawn/font/afm.rb,
lib/prawn/font/ttf.rb,
lib/prawn/font/dfont.rb

Overview

Provides font information and helper functions.

Direct Known Subclasses

AFM, TTF

Defined Under Namespace

Classes: AFM, DFont, TTF

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, name, options = {}) ⇒ Font

:nodoc:


250
251
252
253
254
255
256
257
258
259
260
# File 'lib/prawn/font.rb', line 250

def initialize(document,name,options={}) #:nodoc:
  @document   = document
  @name       = name
  @options    = options

  @family     = options[:family]

  @identifier = :"F#{@document.font_registry.size + 1}"

  @references = {}
end

Instance Attribute Details

#familyObject (readonly)

The current font family


232
233
234
# File 'lib/prawn/font.rb', line 232

def family
  @family
end

#nameObject (readonly)

The current font name


229
230
231
# File 'lib/prawn/font.rb', line 229

def name
  @name
end

#optionsObject (readonly)

The options hash used to initialize the font


235
236
237
# File 'lib/prawn/font.rb', line 235

def options
  @options
end

Class Method Details

.load(document, name, options = {}) ⇒ Object

Shortcut interface for constructing a font object. Filenames of the form *.ttf will call Font::TTF.new, *.dfont Font::DFont.new, and anything else will be passed through to Font::AFM.new()


241
242
243
244
245
246
247
248
# File 'lib/prawn/font.rb', line 241

def self.load(document,name,options={})
  case name
  when /\.ttf$/   then TTF.new(document, name, options)
  when /\.dfont$/ then DFont.new(document, name, options)
  when /\.afm$/   then AFM.new(document, name, options)
  else                 AFM.new(document, name, options)
  end
end

Instance Method Details

#add_to_current_page(subset) ⇒ Object

Registers the given subset of the current font with the current PDF page. This is safe to call multiple times for a given font and subset, as it will only add the font the first time it is called.


320
321
322
323
# File 'lib/prawn/font.rb', line 320

def add_to_current_page(subset)
  @references[subset] ||= register(subset)
  @document.state.page.fonts.merge!(identifier_for(subset) => @references[subset])
end

#ascenderObject

The size of the font ascender in PDF points


264
265
266
# File 'lib/prawn/font.rb', line 264

def ascender
  @ascender / 1000.0 * size
end

#descenderObject

The size of the font descender in PDF points


270
271
272
# File 'lib/prawn/font.rb', line 270

def descender
  -@descender / 1000.0 * size
end

#heightObject

Gets height of current font in PDF points at current font size


312
313
314
# File 'lib/prawn/font.rb', line 312

def height
  height_at(size)
end

#height_at(size) ⇒ Object

Gets height of current font in PDF points at the given font size


305
306
307
308
# File 'lib/prawn/font.rb', line 305

def height_at(size)
  @normalized_height ||= (@ascender - @descender + @line_gap) / 1000.0
  @normalized_height * size
end

#identifier_for(subset) ⇒ Object

:nodoc:


325
326
327
# File 'lib/prawn/font.rb', line 325

def identifier_for(subset)
  "#{@identifier}.#{subset}".to_sym
end

#inspectObject

:nodoc:


329
330
331
# File 'lib/prawn/font.rb', line 329

def inspect
  "#{self.class.name}< #{name}: #{size} >"
end

#line_gapObject

The size of the recommended gap between lines of text in PDF points


276
277
278
# File 'lib/prawn/font.rb', line 276

def line_gap
  @line_gap / 1000.0 * size
end

#normalize_encoding(string) ⇒ Object

Normalizes the encoding of the string to an encoding supported by the font. The string is expected to be UTF-8 going in. It will be re-encoded and the new string will be returned. For an in-place (destructive) version, see normalize_encoding!.

Raises:

  • (NotImplementedError)

292
293
294
# File 'lib/prawn/font.rb', line 292

def normalize_encoding(string)
  raise NotImplementedError, "subclasses of Prawn::Font must implement #normalize_encoding"
end

#normalize_encoding!(str) ⇒ Object

Destructive version of normalize_encoding; normalizes the encoding of a string in place.


299
300
301
# File 'lib/prawn/font.rb', line 299

def normalize_encoding!(str)
  str.replace(normalize_encoding(str))
end