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:



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/prawn/font.rb', line 223

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

#family ⇒ Object (readonly)

The current font family



205
206
207
 
# File 'lib/prawn/font.rb', line 205

def family
  @family
end

#name ⇒ Object (readonly)

The current font name



202
203
204
 
# File 'lib/prawn/font.rb', line 202

def name
  @name
end

#options ⇒ Object (readonly)

The options hash used to initialize the font



208
209
210
 
# File 'lib/prawn/font.rb', line 208

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



214
215
216
217
218
219
220
221
 
# File 'lib/prawn/font.rb', line 214

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.



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

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

#ascender ⇒ Object

The size of the font ascender in PDF points



237
238
239
 
# File 'lib/prawn/font.rb', line 237

def ascender
  @ascender / 1000.0 * size
end

#descender ⇒ Object

The size of the font descender in PDF points



243
244
245
 
# File 'lib/prawn/font.rb', line 243

def descender
  -@descender / 1000.0 * size
end

#height ⇒ Object

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



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

def height
  height_at(size)
end

#height_at(size) ⇒ Object

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



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

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

#identifier_for(subset) ⇒ Object

:nodoc:



290
291
292
 
# File 'lib/prawn/font.rb', line 290

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

#inspect ⇒ Object

:nodoc:



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

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



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

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) 


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

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.



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

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