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:



278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/prawn/font.rb', line 278

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

  @family     = options[:family]

  @identifier = generate_unique_id

  @references = {}
end

Instance Attribute Details

#family ⇒ Object (readonly)

The current font family



260
261
262
 
# File 'lib/prawn/font.rb', line 260

def family
  @family
end

#name ⇒ Object (readonly)

The current font name



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

def name
  @name
end

#options ⇒ Object (readonly)

The options hash used to initialize the font



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

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()



269
270
271
272
273
274
275
276
 
# File 'lib/prawn/font.rb', line 269

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

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.



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

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

#ascender ⇒ Object

The size of the font ascender in PDF points



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

def ascender
  @ascender / 1000.0 * size
end

#descender ⇒ Object

The size of the font descender in PDF points



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

def descender
  -@descender / 1000.0 * size
end

#eql?(other) ⇒ Boolean

Compliments the #hash implementation above

Returns:

  • (Boolean) 


364
365
366
367
 
# File 'lib/prawn/font.rb', line 364

def eql?( other ) #:nodoc:
  self.class == other.class && self.name == other.name &&
    self.family == other.family && size == other.send(:size)
end

#hash ⇒ Object

Return a hash (as in Object#hash) for the font based on the output of #inspect. This is required since font objects are used as keys in hashes that cache certain values (See Prawn::Table::Text#styled_with_of_single_character)



358
359
360
 
# File 'lib/prawn/font.rb', line 358

def hash #:nodoc:
  [ self.class, self.name, self.family, size ].hash
end

#height ⇒ Object

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



332
333
334
 
# File 'lib/prawn/font.rb', line 332

def height
  height_at(size)
end

#height_at(size) ⇒ Object

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



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

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

#identifier_for(subset) ⇒ Object

:nodoc:



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

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

#inspect ⇒ Object

:nodoc:



349
350
351
 
# File 'lib/prawn/font.rb', line 349

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

#line_gap ⇒ Object

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



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

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) 


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

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.



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

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