Class: Prawn::Font
- Inherits:
-
Object
- Object
- Prawn::Font
- 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.
Defined Under Namespace
Instance Attribute Summary collapse
-
#family ⇒ Object
readonly
The current font family.
-
#name ⇒ Object
readonly
The current font name.
-
#options ⇒ Object
readonly
The options hash used to initialize the font.
Class Method Summary collapse
Instance Method Summary collapse
-
#add_to_current_page(subset) ⇒ Object
Registers the given subset of the current font with the current PDF page.
- #ascender ⇒ Object
- #descender ⇒ Object
-
#height ⇒ Object
Gets height of current font in PDF points at current font size.
- #height_at(size) ⇒ Object
- #identifier_for(subset) ⇒ Object
-
#initialize(document, name, options = {}) ⇒ Font
constructor
:nodoc:.
- #inspect ⇒ Object
- #line_gap ⇒ Object
-
#normalize_encoding(string) ⇒ Object
Normalizes the encoding of the string to an encoding supported by the font.
-
#normalize_encoding!(str) ⇒ Object
Destructive version of normalize_encoding; normalizes the encoding of a string in place.
Constructor Details
#initialize(document, name, options = {}) ⇒ Font
:nodoc:
222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/prawn/font.rb', line 222 def initialize(document,name,={}) #:nodoc: @document = document @name = name @options = @family = [:family] @identifier = :"F#{@document.font_registry.size + 1}" @references = {} end |
Instance Attribute Details
#family ⇒ Object (readonly)
The current font family
208 209 210 |
# File 'lib/prawn/font.rb', line 208 def family @family end |
#name ⇒ Object (readonly)
The current font name
205 206 207 |
# File 'lib/prawn/font.rb', line 205 def name @name end |
#options ⇒ Object (readonly)
The options hash used to initialize the font
211 212 213 |
# File 'lib/prawn/font.rb', line 211 def @options end |
Class Method Details
.load(document, name, options = {}) ⇒ Object
213 214 215 216 217 218 219 220 |
# File 'lib/prawn/font.rb', line 213 def self.load(document,name,={}) case name when /\.ttf$/ then TTF.new(document, name, ) when /\.dfont$/ then DFont.new(document, name, ) when /\.afm$/ then AFM.new(document, name, ) else AFM.new(document, name, ) 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.
283 284 285 286 |
# File 'lib/prawn/font.rb', line 283 def add_to_current_page(subset) @references[subset] ||= register(subset) @document.page_fonts.merge!(identifier_for(subset) => @references[subset]) end |
#ascender ⇒ Object
234 235 236 |
# File 'lib/prawn/font.rb', line 234 def ascender @ascender / 1000.0 * size end |
#descender ⇒ Object
238 239 240 |
# File 'lib/prawn/font.rb', line 238 def descender @descender / 1000.0 * size end |
#height ⇒ Object
Gets height of current font in PDF points at current font size
275 276 277 |
# File 'lib/prawn/font.rb', line 275 def height height_at(size) end |
#height_at(size) ⇒ Object
268 269 270 271 |
# File 'lib/prawn/font.rb', line 268 def height_at(size) @normalized_height ||= (@ascender - @descender + @line_gap) / 1000.0 @normalized_height * size end |
#identifier_for(subset) ⇒ Object
246 247 248 |
# File 'lib/prawn/font.rb', line 246 def identifier_for(subset) "#{@identifier}.#{subset}" end |
#inspect ⇒ Object
250 251 252 |
# File 'lib/prawn/font.rb', line 250 def inspect "#{self.class.name}< #{name}: #{size} >" end |
#line_gap ⇒ Object
242 243 244 |
# File 'lib/prawn/font.rb', line 242 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!.
258 259 260 |
# File 'lib/prawn/font.rb', line 258 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 |