Container.php
4.59 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
<?php
/*
PHPRtfLite
Copyright 2007-2008 Denis Slaveckij <sinedas@gmail.com>
Copyright 2010-2012 Steffen Zeidler <sigma_z@sigma-scripts.de>
This file is part of PHPRtfLite.
PHPRtfLite is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PHPRtfLite is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with PHPRtfLite. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Abstract class for creating containers like sections, footers and headers.
* @version 1.2
* @author Denis Slaveckij <sinedas@gmail.com>
* @author Steffen Zeidler <sigma_z@sigma-scripts.de>
* @copyright 2007-2008 Denis Slaveckij, 2010-2012 Steffen Zeidler
* @package PHPRtfLite
* @subpackage PHPRtfLite_Container
*/
abstract class PHPRtfLite_Container extends PHPRtfLite_Container_Base
{
/**
* adds a footnote
*
* @param string $noteText
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
*
* @return PHPRtfLite_Footnote
*/
public function addFootnote($noteText, PHPRtfLite_Font $font = null, PHPRtfLite_ParFormat $parFormat = null)
{
$footnote = new PHPRtfLite_Footnote($this->_rtf, $noteText, $font, $parFormat);
$this->_elements[] = $footnote;
return $footnote;
}
/**
* adds an endnote
*
* @param string $noteText
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
*
* @return PHPRtfLite_Endnote
*/
public function addEndnote($noteText, PHPRtfLite_Font $font = null, PHPRtfLite_ParFormat $parFormat = null)
{
$endnote = new PHPRtfLite_Endnote($this->_rtf, $noteText, $font, $parFormat);
$this->_elements[] = $endnote;
return $endnote;
}
/**
* adds list (enumeration/numbering)
*
* @param PHPRtfLite_List $list
*/
public function addList(PHPRtfLite_List $list)
{
$this->_elements[] = $list;
}
/**
* adds enumeration
*
* @param PHPRtfLite_List_Enumeration $enum
*/
public function addEnumeration(PHPRtfLite_List_Enumeration $enum)
{
$this->_elements[] = $enum;
}
/**
* adds numbering
*
* @param PHPRtfLite_List_Numbering $numList
*/
public function addNumbering(PHPRtfLite_List_Numbering $numList)
{
$this->_elements[] = $numList;
}
/**
* adds checkbox field
*
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
* @return PHPRtfLite_FormField_Checkbox
*/
public function addCheckbox(PHPRtfLite_Font $font = null, PHPRtfLite_ParFormat $parFormat = null)
{
$checkBox = new PHPRtfLite_FormField_Checkbox($this->_rtf, $font, $parFormat);
$this->_elements[] = $checkBox;
return $checkBox;
}
/**
* adds dropdown field
*
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
* @return PHPRtfLite_FormField_Dropdown
*/
public function addDropdown(PHPRtfLite_Font $font = null, PHPRtfLite_ParFormat $parFormat = null)
{
$dropdown = new PHPRtfLite_FormField_Dropdown($this->_rtf, $font, $parFormat);
$this->_elements[] = $dropdown;
return $dropdown;
}
/**
* adds text field
*
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
* @return PHPRtfLite_FormField_Text
*/
public function addTextField(PHPRtfLite_Font $font = null, PHPRtfLite_ParFormat $parFormat = null)
{
$textField = new PHPRtfLite_FormField_Text($this->_rtf, $font, $parFormat);
$this->_elements[] = $textField;
return $textField;
}
/**
* @deprecated will be removed soon, use addEmptyParagraph instead
* @see PHPRtfLite_Container::addEmptyParagraph
*
* @param PHPRtfLite_Font $font
* @param PHPRtfLite_ParFormat $parFormat
*/
public function emptyParagraph(PHPRtfLite_Font $font, PHPRtfLite_ParFormat $parFormat)
{
$this->addEmptyParagraph($font, $parFormat);
}
}