davebenvenuti-prawn 0.11.1.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (291) hide show
  1. data/COPYING +340 -0
  2. data/HACKING +50 -0
  3. data/LICENSE +56 -0
  4. data/README +141 -0
  5. data/Rakefile +52 -0
  6. data/data/encodings/win_ansi.txt +29 -0
  7. data/data/fonts/Action Man.dfont +0 -0
  8. data/data/fonts/Activa.ttf +0 -0
  9. data/data/fonts/Chalkboard.ttf +0 -0
  10. data/data/fonts/Courier-Bold.afm +342 -0
  11. data/data/fonts/Courier-BoldOblique.afm +342 -0
  12. data/data/fonts/Courier-Oblique.afm +342 -0
  13. data/data/fonts/Courier.afm +342 -0
  14. data/data/fonts/DejaVuSans.ttf +0 -0
  15. data/data/fonts/Dustismo_Roman.ttf +0 -0
  16. data/data/fonts/Helvetica-Bold.afm +2827 -0
  17. data/data/fonts/Helvetica-BoldOblique.afm +2827 -0
  18. data/data/fonts/Helvetica-Oblique.afm +3051 -0
  19. data/data/fonts/Helvetica.afm +3051 -0
  20. data/data/fonts/MustRead.html +19 -0
  21. data/data/fonts/Symbol.afm +213 -0
  22. data/data/fonts/Times-Bold.afm +2588 -0
  23. data/data/fonts/Times-BoldItalic.afm +2384 -0
  24. data/data/fonts/Times-Italic.afm +2667 -0
  25. data/data/fonts/Times-Roman.afm +2419 -0
  26. data/data/fonts/ZapfDingbats.afm +225 -0
  27. data/data/fonts/comicsans.ttf +0 -0
  28. data/data/fonts/gkai00mp.ttf +0 -0
  29. data/data/images/16bit.alpha +0 -0
  30. data/data/images/16bit.dat +0 -0
  31. data/data/images/16bit.png +0 -0
  32. data/data/images/arrow.png +0 -0
  33. data/data/images/arrow2.png +0 -0
  34. data/data/images/barcode_issue.png +0 -0
  35. data/data/images/dice.alpha +0 -0
  36. data/data/images/dice.dat +0 -0
  37. data/data/images/dice.png +0 -0
  38. data/data/images/dice_interlaced.png +0 -0
  39. data/data/images/fractal.jpg +0 -0
  40. data/data/images/letterhead.jpg +0 -0
  41. data/data/images/page_white_text.alpha +0 -0
  42. data/data/images/page_white_text.dat +0 -0
  43. data/data/images/page_white_text.png +0 -0
  44. data/data/images/pigs.jpg +0 -0
  45. data/data/images/rails.dat +0 -0
  46. data/data/images/rails.png +0 -0
  47. data/data/images/ruport.png +0 -0
  48. data/data/images/ruport_data.dat +0 -0
  49. data/data/images/ruport_transparent.png +0 -0
  50. data/data/images/ruport_type0.png +0 -0
  51. data/data/images/stef.jpg +0 -0
  52. data/data/images/tru256.bmp +0 -0
  53. data/data/images/web-links.dat +1 -0
  54. data/data/images/web-links.png +0 -0
  55. data/data/pdfs/complex_template.pdf +0 -0
  56. data/data/pdfs/contains_ttf_font.pdf +0 -0
  57. data/data/pdfs/encrypted.pdf +0 -0
  58. data/data/pdfs/hexagon.pdf +61 -0
  59. data/data/pdfs/indirect_reference.pdf +86 -0
  60. data/data/pdfs/nested_pages.pdf +118 -0
  61. data/data/pdfs/page_without_mediabox.pdf +193 -0
  62. data/data/pdfs/resources_as_indirect_object.pdf +83 -0
  63. data/data/pdfs/two_hexagons.pdf +90 -0
  64. data/data/pdfs/version_1_6.pdf +61 -0
  65. data/data/shift_jis_text.txt +1 -0
  66. data/examples/bounding_box/bounding_boxes.rb +44 -0
  67. data/examples/bounding_box/indentation.rb +35 -0
  68. data/examples/bounding_box/russian_boxes.rb +37 -0
  69. data/examples/bounding_box/stretched_nesting.rb +68 -0
  70. data/examples/example_helper.rb +8 -0
  71. data/examples/general/background.rb +24 -0
  72. data/examples/general/canvas.rb +16 -0
  73. data/examples/general/context_sensitive_headers.rb +38 -0
  74. data/examples/general/float.rb +12 -0
  75. data/examples/general/margin.rb +37 -0
  76. data/examples/general/measurement_units.rb +52 -0
  77. data/examples/general/metadata-info.rb +17 -0
  78. data/examples/general/multi_page_layout.rb +19 -0
  79. data/examples/general/outlines.rb +67 -0
  80. data/examples/general/page_geometry.rb +32 -0
  81. data/examples/general/page_numbering.rb +16 -0
  82. data/examples/general/repeaters.rb +48 -0
  83. data/examples/general/stamp.rb +42 -0
  84. data/examples/general/templates.rb +14 -0
  85. data/examples/graphics/basic_images.rb +24 -0
  86. data/examples/graphics/cmyk.rb +13 -0
  87. data/examples/graphics/curves.rb +12 -0
  88. data/examples/graphics/hexagon.rb +14 -0
  89. data/examples/graphics/image_fit.rb +16 -0
  90. data/examples/graphics/image_flow.rb +38 -0
  91. data/examples/graphics/image_position.rb +18 -0
  92. data/examples/graphics/line.rb +33 -0
  93. data/examples/graphics/png_types.rb +23 -0
  94. data/examples/graphics/polygons.rb +17 -0
  95. data/examples/graphics/remote_images.rb +13 -0
  96. data/examples/graphics/rounded_polygons.rb +20 -0
  97. data/examples/graphics/rounded_rectangle.rb +21 -0
  98. data/examples/graphics/ruport_style_helpers.rb +20 -0
  99. data/examples/graphics/stroke_bounds.rb +21 -0
  100. data/examples/graphics/stroke_cap_and_join.rb +46 -0
  101. data/examples/graphics/stroke_dash.rb +43 -0
  102. data/examples/graphics/transformations.rb +53 -0
  103. data/examples/graphics/transparency.rb +27 -0
  104. data/examples/grid/bounding_boxes.rb +22 -0
  105. data/examples/grid/column_gutter_grid.rb +21 -0
  106. data/examples/grid/multi_boxes.rb +52 -0
  107. data/examples/grid/show_grid.rb +14 -0
  108. data/examples/grid/simple_grid.rb +21 -0
  109. data/examples/m17n/chinese_text_wrapping.rb +18 -0
  110. data/examples/m17n/euro.rb +16 -0
  111. data/examples/m17n/sjis.rb +29 -0
  112. data/examples/m17n/utf8.rb +14 -0
  113. data/examples/m17n/win_ansi_charset.rb +55 -0
  114. data/examples/security/hello_foo.rb +9 -0
  115. data/examples/table/bill.rb +54 -0
  116. data/examples/table/cell.rb +13 -0
  117. data/examples/table/checkerboard.rb +23 -0
  118. data/examples/table/header.rb +15 -0
  119. data/examples/table/inline_format_table.rb +13 -0
  120. data/examples/table/multi_page_table.rb +10 -0
  121. data/examples/table/simple_table.rb +25 -0
  122. data/examples/table/subtable.rb +13 -0
  123. data/examples/table/widths.rb +21 -0
  124. data/examples/text/alignment.rb +19 -0
  125. data/examples/text/character_spacing.rb +13 -0
  126. data/examples/text/dfont.rb +49 -0
  127. data/examples/text/family_based_styling.rb +25 -0
  128. data/examples/text/font_calculations.rb +92 -0
  129. data/examples/text/font_size.rb +34 -0
  130. data/examples/text/hyphenation.rb +46 -0
  131. data/examples/text/indent_paragraphs.rb +23 -0
  132. data/examples/text/inline_format.rb +104 -0
  133. data/examples/text/kerning.rb +31 -0
  134. data/examples/text/rotated.rb +99 -0
  135. data/examples/text/shaped_text_box.rb +32 -0
  136. data/examples/text/simple_text.rb +18 -0
  137. data/examples/text/simple_text_ttf.rb +18 -0
  138. data/examples/text/span.rb +30 -0
  139. data/examples/text/text_box.rb +89 -0
  140. data/examples/text/text_box_returning_excess.rb +52 -0
  141. data/examples/text/text_flow.rb +68 -0
  142. data/lib/prawn.rb +26 -0
  143. data/lib/prawn/compatibility.rb +51 -0
  144. data/lib/prawn/core.rb +85 -0
  145. data/lib/prawn/core/annotations.rb +61 -0
  146. data/lib/prawn/core/byte_string.rb +9 -0
  147. data/lib/prawn/core/destinations.rb +90 -0
  148. data/lib/prawn/core/document_state.rb +78 -0
  149. data/lib/prawn/core/literal_string.rb +16 -0
  150. data/lib/prawn/core/name_tree.rb +165 -0
  151. data/lib/prawn/core/object_store.rb +236 -0
  152. data/lib/prawn/core/page.rb +199 -0
  153. data/lib/prawn/core/pdf_object.rb +108 -0
  154. data/lib/prawn/core/reference.rb +112 -0
  155. data/lib/prawn/core/text.rb +140 -0
  156. data/lib/prawn/core/text/formatted/arranger.rb +266 -0
  157. data/lib/prawn/core/text/formatted/line_wrap.rb +127 -0
  158. data/lib/prawn/core/text/formatted/wrap.rb +112 -0
  159. data/lib/prawn/core/text/line_wrap.rb +211 -0
  160. data/lib/prawn/core/text/wrap.rb +82 -0
  161. data/lib/prawn/document.rb +575 -0
  162. data/lib/prawn/document/bounding_box.rb +428 -0
  163. data/lib/prawn/document/graphics_state.rb +48 -0
  164. data/lib/prawn/document/internals.rb +170 -0
  165. data/lib/prawn/document/page_geometry.rb +136 -0
  166. data/lib/prawn/document/snapshot.rb +87 -0
  167. data/lib/prawn/document/span.rb +55 -0
  168. data/lib/prawn/encoding.rb +121 -0
  169. data/lib/prawn/errors.rb +86 -0
  170. data/lib/prawn/font.rb +368 -0
  171. data/lib/prawn/font/afm.rb +225 -0
  172. data/lib/prawn/font/dfont.rb +42 -0
  173. data/lib/prawn/font/ttf.rb +350 -0
  174. data/lib/prawn/graphics.rb +325 -0
  175. data/lib/prawn/graphics/cap_style.rb +38 -0
  176. data/lib/prawn/graphics/color.rb +205 -0
  177. data/lib/prawn/graphics/dash.rb +71 -0
  178. data/lib/prawn/graphics/join_style.rb +38 -0
  179. data/lib/prawn/graphics/transformation.rb +156 -0
  180. data/lib/prawn/graphics/transparency.rb +99 -0
  181. data/lib/prawn/images.rb +217 -0
  182. data/lib/prawn/images/jpg.rb +85 -0
  183. data/lib/prawn/images/png.rb +356 -0
  184. data/lib/prawn/layout.rb +20 -0
  185. data/lib/prawn/layout/grid.rb +259 -0
  186. data/lib/prawn/measurement_extensions.rb +46 -0
  187. data/lib/prawn/measurements.rb +71 -0
  188. data/lib/prawn/outline.rb +326 -0
  189. data/lib/prawn/repeater.rb +129 -0
  190. data/lib/prawn/security.rb +262 -0
  191. data/lib/prawn/security/arcfour.rb +51 -0
  192. data/lib/prawn/stamp.rb +126 -0
  193. data/lib/prawn/table.rb +451 -0
  194. data/lib/prawn/table/cell.rb +395 -0
  195. data/lib/prawn/table/cell/in_table.rb +27 -0
  196. data/lib/prawn/table/cell/subtable.rb +65 -0
  197. data/lib/prawn/table/cell/text.rb +135 -0
  198. data/lib/prawn/table/cells.rb +206 -0
  199. data/lib/prawn/text.rb +449 -0
  200. data/lib/prawn/text/box.rb +397 -0
  201. data/lib/prawn/text/formatted.rb +4 -0
  202. data/lib/prawn/text/formatted/box.rb +222 -0
  203. data/lib/prawn/text/formatted/fragment.rb +181 -0
  204. data/lib/prawn/text/formatted/parser.rb +213 -0
  205. data/prawn.gemspec +28 -0
  206. data/spec/annotations_spec.rb +90 -0
  207. data/spec/bounding_box_spec.rb +190 -0
  208. data/spec/cell_spec.rb +430 -0
  209. data/spec/destinations_spec.rb +15 -0
  210. data/spec/document_spec.rb +476 -0
  211. data/spec/extensions/mocha.rb +32 -0
  212. data/spec/font_spec.rb +324 -0
  213. data/spec/formatted_text_arranger_spec.rb +426 -0
  214. data/spec/formatted_text_box_spec.rb +756 -0
  215. data/spec/formatted_text_fragment_spec.rb +211 -0
  216. data/spec/graphics_spec.rb +446 -0
  217. data/spec/grid_spec.rb +85 -0
  218. data/spec/images_spec.rb +119 -0
  219. data/spec/inline_formatted_text_parser_spec.rb +502 -0
  220. data/spec/jpg_spec.rb +25 -0
  221. data/spec/line_wrap_spec.rb +341 -0
  222. data/spec/measurement_units_spec.rb +23 -0
  223. data/spec/name_tree_spec.rb +112 -0
  224. data/spec/object_store_spec.rb +160 -0
  225. data/spec/outline_spec.rb +404 -0
  226. data/spec/pdf_object_spec.rb +170 -0
  227. data/spec/png_spec.rb +237 -0
  228. data/spec/reference_spec.rb +82 -0
  229. data/spec/repeater_spec.rb +96 -0
  230. data/spec/security_spec.rb +120 -0
  231. data/spec/snapshot_spec.rb +154 -0
  232. data/spec/span_spec.rb +49 -0
  233. data/spec/spec_helper.rb +34 -0
  234. data/spec/stamp_spec.rb +108 -0
  235. data/spec/stroke_styles_spec.rb +163 -0
  236. data/spec/table_spec.rb +687 -0
  237. data/spec/template_spec.rb +165 -0
  238. data/spec/text_at_spec.rb +125 -0
  239. data/spec/text_box_spec.rb +777 -0
  240. data/spec/text_spacing_spec.rb +75 -0
  241. data/spec/text_spec.rb +349 -0
  242. data/spec/text_with_inline_formatting_spec.rb +193 -0
  243. data/spec/transparency_spec.rb +89 -0
  244. data/vendor/pdf-inspector/README +18 -0
  245. data/vendor/pdf-inspector/lib/pdf/inspector.rb +26 -0
  246. data/vendor/pdf-inspector/lib/pdf/inspector/extgstate.rb +18 -0
  247. data/vendor/pdf-inspector/lib/pdf/inspector/graphics.rb +131 -0
  248. data/vendor/pdf-inspector/lib/pdf/inspector/page.rb +25 -0
  249. data/vendor/pdf-inspector/lib/pdf/inspector/text.rb +46 -0
  250. data/vendor/pdf-inspector/lib/pdf/inspector/xobject.rb +19 -0
  251. data/vendor/ttfunk/data/fonts/DejaVuSans.ttf +0 -0
  252. data/vendor/ttfunk/data/fonts/comicsans.ttf +0 -0
  253. data/vendor/ttfunk/example.rb +45 -0
  254. data/vendor/ttfunk/lib/ttfunk.rb +102 -0
  255. data/vendor/ttfunk/lib/ttfunk/directory.rb +17 -0
  256. data/vendor/ttfunk/lib/ttfunk/encoding/mac_roman.rb +88 -0
  257. data/vendor/ttfunk/lib/ttfunk/encoding/windows_1252.rb +69 -0
  258. data/vendor/ttfunk/lib/ttfunk/reader.rb +44 -0
  259. data/vendor/ttfunk/lib/ttfunk/resource_file.rb +78 -0
  260. data/vendor/ttfunk/lib/ttfunk/subset.rb +18 -0
  261. data/vendor/ttfunk/lib/ttfunk/subset/base.rb +141 -0
  262. data/vendor/ttfunk/lib/ttfunk/subset/mac_roman.rb +50 -0
  263. data/vendor/ttfunk/lib/ttfunk/subset/unicode.rb +48 -0
  264. data/vendor/ttfunk/lib/ttfunk/subset/unicode_8bit.rb +63 -0
  265. data/vendor/ttfunk/lib/ttfunk/subset/windows_1252.rb +55 -0
  266. data/vendor/ttfunk/lib/ttfunk/subset_collection.rb +72 -0
  267. data/vendor/ttfunk/lib/ttfunk/table.rb +46 -0
  268. data/vendor/ttfunk/lib/ttfunk/table/cmap.rb +34 -0
  269. data/vendor/ttfunk/lib/ttfunk/table/cmap/format00.rb +54 -0
  270. data/vendor/ttfunk/lib/ttfunk/table/cmap/format04.rb +126 -0
  271. data/vendor/ttfunk/lib/ttfunk/table/cmap/subtable.rb +79 -0
  272. data/vendor/ttfunk/lib/ttfunk/table/glyf.rb +64 -0
  273. data/vendor/ttfunk/lib/ttfunk/table/glyf/compound.rb +81 -0
  274. data/vendor/ttfunk/lib/ttfunk/table/glyf/simple.rb +37 -0
  275. data/vendor/ttfunk/lib/ttfunk/table/head.rb +44 -0
  276. data/vendor/ttfunk/lib/ttfunk/table/hhea.rb +41 -0
  277. data/vendor/ttfunk/lib/ttfunk/table/hmtx.rb +47 -0
  278. data/vendor/ttfunk/lib/ttfunk/table/kern.rb +79 -0
  279. data/vendor/ttfunk/lib/ttfunk/table/kern/format0.rb +62 -0
  280. data/vendor/ttfunk/lib/ttfunk/table/loca.rb +43 -0
  281. data/vendor/ttfunk/lib/ttfunk/table/maxp.rb +40 -0
  282. data/vendor/ttfunk/lib/ttfunk/table/name.rb +125 -0
  283. data/vendor/ttfunk/lib/ttfunk/table/os2.rb +78 -0
  284. data/vendor/ttfunk/lib/ttfunk/table/post.rb +91 -0
  285. data/vendor/ttfunk/lib/ttfunk/table/post/format10.rb +43 -0
  286. data/vendor/ttfunk/lib/ttfunk/table/post/format20.rb +35 -0
  287. data/vendor/ttfunk/lib/ttfunk/table/post/format25.rb +23 -0
  288. data/vendor/ttfunk/lib/ttfunk/table/post/format30.rb +17 -0
  289. data/vendor/ttfunk/lib/ttfunk/table/post/format40.rb +17 -0
  290. data/vendor/ttfunk/lib/ttfunk/table/simple.rb +14 -0
  291. metadata +379 -0
@@ -0,0 +1,428 @@
1
+ # encoding: utf-8
2
+
3
+ # bounding_box.rb : Implements a mechanism for shifting the coordinate space
4
+ #
5
+ # Copyright May 2008, Gregory Brown. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+
9
+ module Prawn
10
+ class Document
11
+
12
+ # :call-seq:
13
+ # bounding_box(point, options={}, &block)
14
+ #
15
+ # A bounding box serves two important purposes:
16
+ # * Provide bounds for flowing text, starting at a given point
17
+ # * Translate the origin (0,0) for graphics primitives
18
+ #
19
+ # A point and :width must be provided. :height is optional.
20
+ # (See stretchyness below)
21
+ #
22
+ # ==Positioning
23
+ #
24
+ # Bounding boxes are positioned relative to their top left corner and
25
+ # the width measurement is towards the right and height measurement is
26
+ # downwards.
27
+ #
28
+ # Usage:
29
+ #
30
+ # * Bounding box 100pt x 100pt in the absolute bottom left of the
31
+ # containing box:
32
+ #
33
+ # pdf.bounding_box([0,100], :width => 100, :height => 100)
34
+ # stroke_bounds
35
+ # end
36
+ #
37
+ # * Bounding box 200pt x 400pt high in the center of the page:
38
+ #
39
+ # x_pos = ((bounds.width / 2) - 150)
40
+ # y_pos = ((bounds.height / 2) + 200)
41
+ # pdf.bounding_box([x_pos, y_pos], :width => 300, :height => 400) do
42
+ # stroke_bounds
43
+ # end
44
+ #
45
+ # ==Flowing Text
46
+ #
47
+ # When flowing text, the usage of a bounding box is simple. Text will
48
+ # begin at the point specified, flowing the width of the bounding box.
49
+ # After the block exits, the cursor position will be moved to
50
+ # the bottom of the bounding box (y - height). If flowing text exceeds
51
+ # the height of the bounding box, the text will be continued on the next
52
+ # page, starting again at the top-left corner of the bounding box.
53
+ #
54
+ # Usage:
55
+ #
56
+ # pdf.bounding_box([100,500], :width => 100, :height => 300) do
57
+ # pdf.text "This text will flow in a very narrow box starting" +
58
+ # "from [100,500]. The pointer will then be moved to [100,200]" +
59
+ # "and return to the margin_box"
60
+ # end
61
+ #
62
+ # Note, this is a low level tool and is designed primarily for building
63
+ # other abstractions. If you just need to flow text on the page, you
64
+ # will want to look at span() and text_box() instead
65
+ #
66
+ # ==Translating Coordinates
67
+ #
68
+ # When translating coordinates, the idea is to allow the user to draw
69
+ # relative to the origin, and then translate their drawing to a specified
70
+ # area of the document, rather than adjust all their drawing coordinates
71
+ # to match this new region.
72
+ #
73
+ # Take for example two triangles which share one point, drawn from the
74
+ # origin:
75
+ #
76
+ # pdf.polygon [0,250], [0,0], [150,100]
77
+ # pdf.polygon [100,0], [150,100], [200,0]
78
+ #
79
+ # It would be easy enough to translate these triangles to another point,
80
+ # e.g [200,200]
81
+ #
82
+ # pdf.polygon [200,450], [200,200], [350,300]
83
+ # pdf.polygon [300,200], [350,300], [400,200]
84
+ #
85
+ # However, each time you want to move the drawing, you'd need to alter
86
+ # every point in the drawing calls, which as you might imagine, can become
87
+ # tedious.
88
+ #
89
+ # If instead, we think of the drawing as being bounded by a box, we can
90
+ # see that the image is 200 points wide by 250 points tall.
91
+ #
92
+ # To translate it to a new origin, we simply select a point at (x,y+height)
93
+ #
94
+ # Using the [200,200] example:
95
+ #
96
+ # pdf.bounding_box([200,450], :width => 200, :height => 250) do
97
+ # pdf.stroke do
98
+ # pdf.polygon [0,250], [0,0], [150,100]
99
+ # pdf.polygon [100,0], [150,100], [200,0]
100
+ # end
101
+ # end
102
+ #
103
+ # Notice that the drawing is still relative to the origin. If we want to
104
+ # move this drawing around the document, we simply need to recalculate the
105
+ # top-left corner of the rectangular bounding-box, and all of our graphics
106
+ # calls remain unmodified.
107
+ #
108
+ # ==Nesting Bounding Boxes
109
+ #
110
+ # At the top level, bounding boxes are specified relative to the document's
111
+ # margin_box (which is itself a bounding box). You can also nest bounding
112
+ # boxes, allowing you to build components which are relative to each other
113
+ #
114
+ # Usage:
115
+ #
116
+ # pdf.bounding_box([200,450], :width => 200, :height => 250) do
117
+ # pdf.stroke_bounds # Show the containing bounding box
118
+ # pdf.bounding_box([50,200], :width => 50, :height => 50) do
119
+ # # a 50x50 bounding box that starts 50 pixels left and 50 pixels down
120
+ # # the parent bounding box.
121
+ # pdf.stroke_bounds
122
+ # end
123
+ # end
124
+ #
125
+ # ==Stretchyness
126
+ #
127
+ # If you do not specify a height to a bounding box, it will become stretchy
128
+ # and its height will be calculated automatically as you stretch the box
129
+ # downwards.
130
+ #
131
+ # pdf.bounding_box([100,400], :width => 400) do
132
+ # pdf.text("The height of this box is #{pdf.bounds.height}")
133
+ # pdf.text('this is some text')
134
+ # pdf.text('this is some more text')
135
+ # pdf.text('and finally a bit more')
136
+ # pdf.text("Now the height of this box is #{pdf.bounds.height}")
137
+ # end
138
+ #
139
+ # ==Absolute Positioning
140
+ #
141
+ # If you wish to position the bounding boxes at absolute coordinates rather
142
+ # than relative to the margins or other bounding boxes, you can use canvas()
143
+ #
144
+ # pdf.bounding_box([50,500], :width => 200, :height => 300) do
145
+ # pdf.stroke_bounds
146
+ # pdf.canvas do
147
+ # Positioned outside the containing box at the 'real' (300,450)
148
+ # pdf.bounding_box([300,450], :width => 200, :height => 200) do
149
+ # pdf.stroke_bounds
150
+ # end
151
+ # end
152
+ # end
153
+ #
154
+ # Of course, if you use canvas, you will be responsible for ensuring that
155
+ # you remain within the printable area of your document.
156
+ #
157
+ def bounding_box(*args, &block)
158
+ init_bounding_box(block) do |parent_box|
159
+ map_to_absolute!(args[0])
160
+ @bounding_box = BoundingBox.new(self, parent_box, *args)
161
+ end
162
+ end
163
+
164
+ # A shortcut to produce a bounding box which is mapped to the document's
165
+ # absolute coordinates, regardless of how things are nested or margin sizes.
166
+ #
167
+ # pdf.canvas do
168
+ # pdf.line pdf.bounds.bottom_left, pdf.bounds.top_right
169
+ # end
170
+ #
171
+ def canvas(&block)
172
+ init_bounding_box(block, :hold_position => true) do |_|
173
+ # Canvas bbox acts like margin_box in that its parent bounds are unset.
174
+ @bounding_box = BoundingBox.new(self, nil, [0,page.dimensions[3]],
175
+ :width => page.dimensions[2],
176
+ :height => page.dimensions[3]
177
+ )
178
+ end
179
+ end
180
+
181
+ private
182
+
183
+ def init_bounding_box(user_block, options={}, &init_block)
184
+ parent_box = @bounding_box
185
+
186
+ init_block.call(parent_box)
187
+
188
+ self.y = @bounding_box.absolute_top
189
+ user_block.call
190
+ self.y = @bounding_box.absolute_bottom unless options[:hold_position]
191
+
192
+ created_box, @bounding_box = @bounding_box, parent_box
193
+
194
+ return created_box
195
+ end
196
+
197
+ # Low level layout helper that simplifies coordinate math.
198
+ #
199
+ # See Prawn::Document#bounding_box for a description of what this class
200
+ # is used for.
201
+ #
202
+ class BoundingBox
203
+
204
+ def initialize(document, parent, point, options={}) #:nodoc:
205
+ unless options[:width]
206
+ raise ArgumentError, "BoundingBox needs the :width option to be set"
207
+ end
208
+
209
+ @document = document
210
+ @parent = parent
211
+ @x, @y = point
212
+ @width, @height = options[:width], options[:height]
213
+ @stretched_height = nil
214
+ end
215
+
216
+ attr_reader :document, :parent
217
+
218
+ # The translated origin (x,y-height) which describes the location
219
+ # of the bottom left corner of the bounding box
220
+ #
221
+ def anchor
222
+ [@x, @y - height]
223
+ end
224
+
225
+ # Relative left x-coordinate of the bounding box. (Always 0)
226
+ #
227
+ # Example, position some text 3 pts from the left of the containing box:
228
+ #
229
+ # draw_text('hello', :at => [(bounds.left + 3), 0])
230
+ #
231
+ def left
232
+ 0
233
+ end
234
+
235
+
236
+ # Temporarily adjust the @x coordinate to allow for left_padding
237
+ #
238
+ # Example:
239
+ #
240
+ # indent 20 do
241
+ # text "20 points in"
242
+ # indent 30 do
243
+ # text "50 points in"
244
+ # end
245
+ # end
246
+ #
247
+ def indent(left_padding, &block)
248
+ @x += left_padding
249
+ @width -= left_padding
250
+ yield
251
+ ensure
252
+ @x -= left_padding
253
+ @width += left_padding
254
+ end
255
+
256
+ # Relative right x-coordinate of the bounding box. (Equal to the box width)
257
+ #
258
+ # Example, position some text 3 pts from the right of the containing box:
259
+ #
260
+ # draw_text('hello', :at => [(bounds.right - 3), 0])
261
+ #
262
+ def right
263
+ @width
264
+ end
265
+
266
+ # Relative top y-coordinate of the bounding box. (Equal to the box height)
267
+ #
268
+ # Example, position some text 3 pts from the top of the containing box:
269
+ #
270
+ # draw_text('hello', :at => [0, (bounds.top - 3)])
271
+ #
272
+ def top
273
+ height
274
+ end
275
+
276
+ # Relative bottom y-coordinate of the bounding box (Always 0)
277
+ #
278
+ # Example, position some text 3 pts from the bottom of the containing box:
279
+ #
280
+ # draw_text('hello', :at => [0, (bounds.bottom + 3)])
281
+ #
282
+ def bottom
283
+ 0
284
+ end
285
+
286
+ # Relative top-left point of the bounding_box
287
+ #
288
+ # Example, draw a line from the top left of the box diagonally to the
289
+ # bottom right:
290
+ #
291
+ # stroke do
292
+ # line(bounds.top_left, bounds.bottom_right)
293
+ # end
294
+ #
295
+ def top_left
296
+ [left,top]
297
+ end
298
+
299
+ # Relative top-right point of the bounding box
300
+ #
301
+ # Example, draw a line from the top_right of the box diagonally to the
302
+ # bottom left:
303
+ #
304
+ # stroke do
305
+ # line(bounds.top_right, bounds.bottom_left)
306
+ # end
307
+ #
308
+ def top_right
309
+ [right,top]
310
+ end
311
+
312
+ # Relative bottom-right point of the bounding box
313
+ #
314
+ # Example, draw a line along the right hand side of the page:
315
+ #
316
+ # stroke do
317
+ # line(bounds.bottom_right, bounds.top_right)
318
+ # end
319
+ #
320
+ def bottom_right
321
+ [right,bottom]
322
+ end
323
+
324
+ # Relative bottom-left point of the bounding box
325
+ #
326
+ # Example, draw a line along the left hand side of the page:
327
+ #
328
+ # stroke do
329
+ # line(bounds.bottom_left, bounds.top_left)
330
+ # end
331
+ #
332
+ def bottom_left
333
+ [left,bottom]
334
+ end
335
+
336
+ # Absolute left x-coordinate of the bounding box
337
+ #
338
+ def absolute_left
339
+ @x
340
+ end
341
+
342
+ # Absolute right x-coordinate of the bounding box
343
+ #
344
+ def absolute_right
345
+ @x + width
346
+ end
347
+
348
+ # Absolute top y-coordinate of the bounding box
349
+ #
350
+ def absolute_top
351
+ @y
352
+ end
353
+
354
+ # Absolute bottom y-coordinate of the bottom box
355
+ #
356
+ def absolute_bottom
357
+ @y - height
358
+ end
359
+
360
+ # Absolute top-left point of the bounding box
361
+ #
362
+ def absolute_top_left
363
+ [absolute_left, absolute_top]
364
+ end
365
+
366
+ # Absolute top-right point of the bounding box
367
+ #
368
+ def absolute_top_right
369
+ [absolute_right, absolute_top]
370
+ end
371
+
372
+ # Absolute bottom-left point of the bounding box
373
+ #
374
+ def absolute_bottom_left
375
+ [absolute_left, absolute_bottom]
376
+ end
377
+
378
+ # Absolute bottom-left point of the bounding box
379
+ #
380
+ def absolute_bottom_right
381
+ [absolute_right, absolute_bottom]
382
+ end
383
+
384
+ # Width of the bounding box
385
+ #
386
+ def width
387
+ @width
388
+ end
389
+
390
+ # Height of the bounding box. If the box is 'stretchy' (unspecified
391
+ # height attribute), height is calculated as the distance from the top of
392
+ # the box to the current drawing position.
393
+ #
394
+ def height
395
+ return @height if @height
396
+ @stretched_height = [(absolute_top - @document.y),
397
+ @stretched_height.to_f].max
398
+ end
399
+
400
+ # an alias for absolute_left
401
+ def left_side
402
+ absolute_left
403
+ end
404
+
405
+ # an alias for absolute_right
406
+ def right_side
407
+ absolute_right
408
+ end
409
+
410
+ # starts a new page
411
+ def move_past_bottom
412
+ @document.start_new_page
413
+ end
414
+
415
+
416
+ alias_method :update_height, :height
417
+
418
+ # Returns +false+ when the box has a defined height, +true+ when the height
419
+ # is being calculated on the fly based on the current vertical position.
420
+ #
421
+ def stretchy?
422
+ !@height
423
+ end
424
+
425
+ end
426
+
427
+ end
428
+ end
@@ -0,0 +1,48 @@
1
+ # encoding: utf-8
2
+ #
3
+ # graphics_state.rb: Implements graphics state saving and restoring
4
+ #
5
+ # Copyright January 2010, Michael Witrant. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+
10
+ module Prawn
11
+ class Document
12
+ module GraphicsState
13
+
14
+ # Pushes the current graphics state on to the graphics state stack so we
15
+ # can restore it when finished with a change we want to isolate (such as
16
+ # modifying the transformation matrix). Used in pairs with
17
+ # restore_graphics_state or passed a block
18
+ #
19
+ # Example without a block:
20
+ #
21
+ # save_graphics_state
22
+ # rotate 30
23
+ # text "rotated text"
24
+ # restore_graphics_state
25
+ #
26
+ # Example with a block:
27
+ #
28
+ # save_graphics_state do
29
+ # rotate 30
30
+ # text "rotated text"
31
+ # end
32
+ #
33
+ def save_graphics_state
34
+ add_content "q"
35
+ if block_given?
36
+ yield
37
+ restore_graphics_state
38
+ end
39
+ end
40
+
41
+ # Pops the last saved graphics state off the graphics state stack and
42
+ # restores the state to those values
43
+ def restore_graphics_state
44
+ add_content "Q"
45
+ end
46
+ end
47
+ end
48
+ end