sections.html
14.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Sections — PHPRtfLite v1.x documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.x',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="PHPRtfLite v1.x documentation" href="index.html" />
<link rel="next" title="Formatting" href="formatting.html" />
<link rel="prev" title="Document settings" href="document-settings.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="formatting.html" title="Formatting"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="document-settings.html" title="Document settings"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PHPRtfLite v1.x documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="sections">
<h1>Sections<a class="headerlink" href="#sections" title="Permalink to this headline">¶</a></h1>
<p>Sections margins and paper width and height can be specified in the same way like for the RTF document. Sections margin and paper width/height will overwrite RTF document margins and paper width/heigth.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">See <em>Document settings</em> > <a class="reference internal" href="document-settings.html#doc-settings-page-margins"><em>Page margins</em></a> and <em>Document settings</em> > <a class="reference internal" href="document-settings.html#doc-settings-page-size"><em>Page size</em></a>.</p>
</div>
<div class="section" id="section-columns">
<h2>Section columns<a class="headerlink" href="#section-columns" title="Permalink to this headline">¶</a></h2>
<p>Section text can be spreaded over columns (all having the same width):</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="c1">// text will spreaded over 3 columns</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setNumberOfColumns</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span>
</pre></div>
</div>
<p>Another way to define section columns with particular column widths:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="c1">// text will spreaded over 3 columns (widths are: 1cm, 2cm, and 3cm)</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setColumnWidths</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">));</span>
</pre></div>
</div>
<p>Separate your section columns with a line, if you like to:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="c1">// text will spreaded over 3 columns (widths are: 1cm, 2cm, and 3cm)</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setColumnWidths</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">));</span>
<span class="c1">// line between section columns</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setLineBetweenColumns</span><span class="p">();</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Lorem ipsum'</span><span class="p">);</span>
</pre></div>
</div>
<p>There is also the posibility to add space between the columns:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="c1">// text will spreaded over 3 columns (widths are: 1cm, 2cm, and 3cm)</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setColumnWidths</span><span class="p">(</span><span class="k">array</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">));</span>
<span class="c1">// 0.2cm of space between section columns</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setSpaceBetweenColumns</span><span class="p">(</span><span class="mf">0.2</span><span class="p">);</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Lorem ipsum'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="page-breaks">
<h2>Page breaks<a class="headerlink" href="#page-breaks" title="Permalink to this headline">¶</a></h2>
<p>Explizit page break:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Lorem ipsum'</span><span class="p">);</span>
<span class="c1">// insert a page break</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">insertPageBreak</span><span class="p">();</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Text on the next page'</span><span class="p">);</span>
</pre></div>
</div>
<p>To prevent a page break, if possible, you can do the following:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Lorem ipsum'</span><span class="p">);</span>
<span class="c1">// prevent page break</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setNoBreak</span><span class="p">();</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Text on the next page'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="hyperlinks">
<h2>Hyperlinks<a class="headerlink" href="#hyperlinks" title="Permalink to this headline">¶</a></h2>
<p>To add a hyperlink:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeText</span><span class="p">(</span><span class="s1">'Lorem ipsum: '</span><span class="p">);</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">writeHyperLink</span><span class="p">(</span><span class="s1">'http://lipsum.lipsum.com/'</span><span class="p">,</span> <span class="s1">'Lorem ipsum'</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="borders">
<h2>Borders<a class="headerlink" href="#borders" title="Permalink to this headline">¶</a></h2>
<div class="highlight-php"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="c1">// some bootstraping here</span>
<span class="nv">$border</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PHPRtfLite_Border</span><span class="p">(</span>
<span class="nv">$rtf</span><span class="p">,</span> <span class="c1">// PHPRtfLite instance</span>
<span class="k">new</span> <span class="nx">PHPRtfLite_Border_Format</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="s1">'#00FF00'</span><span class="p">),</span> <span class="c1">// left border: 2pt, green color</span>
<span class="k">new</span> <span class="nx">PHPRtfLite_Border_Format</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s1">'#FFFF00'</span><span class="p">),</span> <span class="c1">// top border: 1pt, yellow color</span>
<span class="k">new</span> <span class="nx">PHPRtfLite_Border_Format</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="s1">'#FF0000'</span><span class="p">),</span> <span class="c1">// right border: 2pt, red color</span>
<span class="k">new</span> <span class="nx">PHPRtfLite_Border_Format</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s1">'#0000FF'</span><span class="p">)</span> <span class="c1">// bottom border: 1pt, blue color</span>
<span class="p">);</span>
<span class="nv">$section</span> <span class="o">=</span> <span class="nv">$rtf</span><span class="o">-></span><span class="na">addSection</span><span class="p">();</span>
<span class="c1">// set section border</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setBorder</span><span class="p">(</span><span class="nv">$border</span><span class="p">);</span>
<span class="c1">// set one border format for top, left, right, and bottom</span>
<span class="nv">$section</span><span class="o">-></span><span class="na">setBorders</span><span class="p">(</span><span class="k">new</span> <span class="nx">PHPRtfLite_Border_Format</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="s1">'#00FF00'</span><span class="p">));</span>
</pre></div>
</div>
<p>Read more about creating borders here: <a class="reference internal" href="formatting.html#borders"><em>Borders</em></a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Sections</a><ul>
<li><a class="reference internal" href="#section-columns">Section columns</a></li>
<li><a class="reference internal" href="#page-breaks">Page breaks</a></li>
<li><a class="reference internal" href="#hyperlinks">Hyperlinks</a></li>
<li><a class="reference internal" href="#borders">Borders</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="document-settings.html"
title="previous chapter">Document settings</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="formatting.html"
title="next chapter">Formatting</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/sections.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="formatting.html" title="Formatting"
>next</a> |</li>
<li class="right" >
<a href="document-settings.html" title="Document settings"
>previous</a> |</li>
<li><a href="index.html">PHPRtfLite v1.x documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, sigmaz.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>