Class: Prawn::Font

Inherits:

Object

• Object
• Prawn::Font

show all

Defined in:

lib/prawn/font.rb,
lib/prawn/font/afm.rb,
lib/prawn/font/ttf.rb,
lib/prawn/font/dfont.rb

Overview

Defined Under Namespace

Classes: AFM, DFont, TTF

Instance Attribute Summary (collapse)

• - (Object) family readonly

  The current font family.

• - (Object) name readonly

  The current font name.

• - (Object) options readonly

  The options hash used to initialize the font.

Class Method Summary (collapse)

• + (Object) load(document, name, options = {})

  Shortcut interface for constructing a font object.

Instance Method Summary (collapse)

• - (Object) add_to_current_page(subset)

  Registers the given subset of the current font with the current PDF page.

• - (Object) ascender

  The size of the font ascender in PDF points.

• - (Object) descender

  The size of the font descender in PDF points.

• - (Object) height

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

• - (Object) height_at(size)

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

• - (Object) identifier_for(subset)

  :nodoc:.

• - (Font) initialize(document, name, options = {}) constructor

  :nodoc:.

• - (Object) inspect

  :nodoc:.

• - (Object) line_gap

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

• - (Object) normalize_encoding(string)

  Normalizes the encoding of the string to an encoding supported by the font.

• - (Object) normalize_encoding!(str)

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

268
269
270
271
272
273
274
275
276
277
278

# File 'lib/prawn/font.rb', line 268

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

  @family     = options[:family]

  @identifier = generate_unique_id

  @references = {}
end

250
251
252

# File 'lib/prawn/font.rb', line 250

def family
  @family
end

247
248
249

# File 'lib/prawn/font.rb', line 247

def name
  @name
end

253
254
255

# File 'lib/prawn/font.rb', line 253

def options
  @options
end

259
260
261
262
263
264
265
266

# File 'lib/prawn/font.rb', line 259

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

338
339
340
341

# File 'lib/prawn/font.rb', line 338

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

282
283
284

# File 'lib/prawn/font.rb', line 282

def ascender
  @ascender / 1000.0 * size
end

288
289
290

# File 'lib/prawn/font.rb', line 288

def descender
  -@descender / 1000.0 * size
end

330
331
332

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

def height
  height_at(size)
end

323
324
325
326

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

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

343
344
345

# File 'lib/prawn/font.rb', line 343

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

347
348
349

# File 'lib/prawn/font.rb', line 347

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

294
295
296

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

def line_gap
  @line_gap / 1000.0 * size
end

310
311
312

# File 'lib/prawn/font.rb', line 310

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

317
318
319

# File 'lib/prawn/font.rb', line 317

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