Zend_Pdf-InteractiveFeatures.xml 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 17275 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.pdf.interactive-features">
  5. <title>Interaktive Features</title>
  6. <sect2 id="zend.pdf.pages.interactive-features.destinations">
  7. <title>Ziele</title>
  8. <para>
  9. Ein Ziel definiert eine spezielle Sicht eines Dokuments, bestehend aus den folgenden
  10. Elementen:
  11. </para>
  12. <itemizedlist>
  13. <listitem>
  14. <para>Die Seite des Dokuments das angezeigt werden soll.</para>
  15. </listitem>
  16. <listitem>
  17. <para>Der Ort des Dokumenten Fensters auf dieser Seite.</para>
  18. </listitem>
  19. <listitem>
  20. <para>
  21. Der Zoom Faktor der verwendet werden soll wenn die Seite angezeigt wird.
  22. </para>
  23. </listitem>
  24. </itemizedlist>
  25. <para>
  26. Ziele können mit Outline Elementen ((<link
  27. linkend="zend.pdf.pages.interactive-features.outlines">Document Outline
  28. (bookmarks)</link>), Hinweisen (<link
  29. linkend="zend.pdf.pages.interactive-features.annotations">Annotations</link>), oder
  30. Aktionen (<link linkend="zend.pdf.pages.interactive-features.actions">Actions</link>)
  31. verknüpft werden. In jedem Fall spezifiziert das Ziel die Sicht des Dokuments welche
  32. dargestellt werden soll wenn das Outline Element oder der Hinweis geöffnet, oder die
  33. Aktion durchgeführt werden soll. Zusätzlich kann eine optionale Dokument Öffnungs-Aktion
  34. spezifiziert werden.
  35. </para>
  36. <sect3 id="zend.pdf.pages.interactive-features.destinations.types">
  37. <title>Unterstützte Zieltypen</title>
  38. <para>
  39. Die folgenden Typen werden von der <classname>Zend_Pdf</classname> Komponente
  40. unterstützt.
  41. </para>
  42. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.zoom">
  43. <title>Zend_Pdf_Destination_Zoom</title>
  44. <para>
  45. Zeigt die spezifizierte Seite, mit den Koordinaten (Links, Oben) positioniert
  46. an der oberen-linken Ecke des Fensters und dem Inhalt der Seite vergrößert
  47. auf den Zoom Faktor.
  48. </para>
  49. <para>
  50. Zielobjekte können durch Verwendung der
  51. <methodname>Zend_Pdf_Destination_Zoom::create($page, $left = null, $top = null,
  52. $zoom = null)</methodname> Methode erstellt werden.
  53. </para>
  54. <para>
  55. Wobei:
  56. </para>
  57. <itemizedlist>
  58. <listitem>
  59. <para>
  60. <varname>$page</varname> eine Zielseite ist (ein
  61. <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitennummer).
  62. </para>
  63. </listitem>
  64. <listitem>
  65. <para>
  66. <varname>$left</varname> ist die linke Ecke der angezeigten Seite
  67. (float).
  68. </para>
  69. </listitem>
  70. <listitem>
  71. <para>
  72. <varname>$top</varname> ist eine obere Ecke der angezeigten Seite
  73. (float).
  74. </para>
  75. </listitem>
  76. <listitem>
  77. <para>
  78. <varname>$zoom</varname> ist ein Zoom Faktor (float).
  79. </para>
  80. </listitem>
  81. </itemizedlist>
  82. <para>
  83. <constant>NULL</constant>, wenn es für die <varname>$left</varname>,
  84. <varname>$top</varname> or <varname>$zoom</varname> Parameter spezifiziert wird,
  85. heißt "aktueller Wert der Viewer Anwendung".
  86. </para>
  87. <para>
  88. Die <classname>Zend_Pdf_Destination_Zoom</classname> Klasse bietet die folgenden
  89. Methoden an:
  90. </para>
  91. <itemizedlist>
  92. <listitem>
  93. <para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
  94. </listitem>
  95. <listitem>
  96. <para><methodname>setLeftEdge(float $left)</methodname>;</para>
  97. </listitem>
  98. <listitem>
  99. <para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
  100. </listitem>
  101. <listitem>
  102. <para><methodname>setTopEdge(float $top)</methodname>;</para>
  103. </listitem>
  104. <listitem>
  105. <para><type>Float</type><methodname>getZoomFactor()</methodname>;</para>
  106. </listitem>
  107. <listitem>
  108. <para><methodname>setZoomFactor(float $zoom)</methodname>;</para>
  109. </listitem>
  110. </itemizedlist>
  111. </sect4>
  112. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit">
  113. <title>Zend_Pdf_Destination_Fit</title>
  114. <para>
  115. Zeigt die spezifizierte Seite an, wobei der Inhalt soweit vergrössert wird,
  116. dass er auf die komplette Seite passt sowohl Horizontal als auch Vertikal im
  117. Fenster. Wenn die benötigten horizontalen und vertikalen Vergrösserungsfaktoren
  118. unterschiedlich sind, wird der kleinere der zwei verwendet, und die Seite im
  119. Fenster mit der anderen Dimension zentriert.
  120. </para>
  121. <para>
  122. Das Zielobjekt kann erstellt werden indem die
  123. <methodname>Zend_Pdf_Destination_Fit::create($page)</methodname> Methode
  124. verwendet wird.
  125. </para>
  126. <para>
  127. Wobei <varname>$page</varname> eine Zielseite ist (ein
  128. <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitennummer).
  129. </para>
  130. </sect4>
  131. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-horizontally">
  132. <title>Zend_Pdf_Destination_FitHorizontally</title>
  133. <para>
  134. Zeigt die spezifizierte Seite, mit den vertikalen Koordinaten an der oberen Ecke
  135. des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert
  136. damit die komplette Breite der Seite in das Fenster passt.
  137. </para>
  138. <para>
  139. Das Zielobjekt kann erstellt werden indem die
  140. <methodname>Zend_Pdf_Destination_FitHorizontally::create($page,
  141. $top)</methodname> Methode verwendet wird.
  142. </para>
  143. <para>
  144. Wobei:
  145. </para>
  146. <itemizedlist>
  147. <listitem>
  148. <para>
  149. <varname>$page</varname> ist eine Zielseite
  150. (ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
  151. </para>
  152. </listitem>
  153. <listitem>
  154. <para>
  155. <varname>$top</varname> ist die obere Ecke der angezeigten Seite
  156. (float).
  157. </para>
  158. </listitem>
  159. </itemizedlist>
  160. <para>
  161. Die Klasse <classname>Zend_Pdf_Destination_FitHorizontally</classname> bietet
  162. auch die folgenden Methoden:
  163. </para>
  164. <itemizedlist>
  165. <listitem>
  166. <para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
  167. </listitem>
  168. <listitem>
  169. <para><methodname>setTopEdge(float $top)</methodname>;</para>
  170. </listitem>
  171. </itemizedlist>
  172. </sect4>
  173. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-vertically">
  174. <title>Zend_Pdf_Destination_FitVertically</title>
  175. <para>
  176. Zeigt die spezifizierte Seite, mit den horizontalen Koordinaten an der oberen
  177. Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug
  178. vergrössert damit die komplette Höhe der Seite in das Fenster passt.
  179. </para>
  180. <para>
  181. Das Zielobjekt kann erstellt werden indem die
  182. <methodname>Zend_Pdf_Destination_FitVertically::create($page,
  183. $left)</methodname> Methode verwendet wird.
  184. </para>
  185. <para>
  186. Wobei:
  187. </para>
  188. <itemizedlist>
  189. <listitem>
  190. <para>
  191. <varname>$page</varname> ist eine Zielseite
  192. (ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
  193. </para>
  194. </listitem>
  195. <listitem>
  196. <para>
  197. <varname>$left</varname> die linke Ecke der angezeigten Seite ist.
  198. (float).
  199. </para>
  200. </listitem>
  201. </itemizedlist>
  202. <para>
  203. Die Klasse <classname>Zend_Pdf_Destination_FitVertically</classname> bietet auch
  204. die folgenden Methoden:
  205. </para>
  206. <itemizedlist>
  207. <listitem>
  208. <para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
  209. </listitem>
  210. <listitem>
  211. <para><methodname>setLeftEdge(float $left)</methodname>;</para>
  212. </listitem>
  213. </itemizedlist>
  214. </sect4>
  215. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-rectangle">
  216. <title>Zend_Pdf_Destination_FitRectangle</title>
  217. <para>
  218. Zeigt die spezifizierte Seite an, wobei der Inhalt gerade genug vergrössert ist
  219. damit er komplett in das Rechteck passt das durch die Koordinaten links, unten,
  220. rechts und oben spezifiziert wird sowohl horizontal als auch vertikal. Wenn die
  221. notwendigen horizontalen und vertikalen Vergrösserungsfaktoren unterschiedlich
  222. sind, wird der kleinere der zwei verwendet, wobei das Rechteck im Fenster durch
  223. Verwendung der andern Dimension zentriert wird.
  224. </para>
  225. <para>
  226. Das Zielobjekt kann erstellt werden indem die
  227. <methodname>Zend_Pdf_Destination_FitRectangle::create($page, $left, $bottom,
  228. $right, $top)</methodname> Methode verwendet wird.
  229. </para>
  230. <para>
  231. Wobei:
  232. </para>
  233. <itemizedlist>
  234. <listitem>
  235. <para>
  236. <varname>$page</varname> ist eine Zielseite
  237. (ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
  238. </para>
  239. </listitem>
  240. <listitem>
  241. <para>
  242. <varname>$left</varname> die linke Ecke der angezeigten Seite ist.
  243. (float).
  244. </para>
  245. </listitem>
  246. <listitem>
  247. <para>
  248. <varname>$bottom</varname> die untere Ecke der angezeigten Seite ist
  249. (float).
  250. </para>
  251. </listitem>
  252. <listitem>
  253. <para>
  254. <varname>$right</varname> die rechte Ecke der angezeigten Seite ist
  255. (float).
  256. </para>
  257. </listitem>
  258. <listitem>
  259. <para>
  260. <varname>$top</varname> die obere Ecke der angezeigten Seite ist
  261. (float).
  262. </para>
  263. </listitem>
  264. </itemizedlist>
  265. <para>
  266. Die Klasse <classname>Zend_Pdf_Destination_FitRectangle</classname> bietet auch
  267. die folgenden Methoden an:
  268. </para>
  269. <itemizedlist>
  270. <listitem>
  271. <para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
  272. </listitem>
  273. <listitem>
  274. <para><methodname>setLeftEdge(float $left)</methodname>;</para>
  275. </listitem>
  276. <listitem>
  277. <para><type>Float</type><methodname>getBottomEdge()</methodname>;</para>
  278. </listitem>
  279. <listitem>
  280. <para><methodname>setBottomEdge(float $bottom)</methodname>;</para>
  281. </listitem>
  282. <listitem>
  283. <para><type>Float</type><methodname>getRightEdge()</methodname>;</para>
  284. </listitem>
  285. <listitem>
  286. <para><methodname>setRightEdge(float $right)</methodname>;</para>
  287. </listitem>
  288. <listitem>
  289. <para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
  290. </listitem>
  291. <listitem>
  292. <para><methodname>setTopEdge(float $top)</methodname>;</para>
  293. </listitem>
  294. </itemizedlist>
  295. </sect4>
  296. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-bounding-box">
  297. <title>Zend_Pdf_Destination_FitBoundingBox</title>
  298. <para>
  299. Zeigt die spezifizierte Seite an, wobei der Inhalt gerade genug vergrössert ist
  300. damit die Zeichenbox komplett in das Fenster passt, sowohl horizontal als auch
  301. vertikal. Wenn die notwendigen horizontalen und vertikalen
  302. Vergrösserungsfaktoren unterschiedlich sind, wird der kleinere der zwei
  303. verwendet, wobei die Zeichenbox im Fenster durch Verwendung der andern Dimension
  304. zentriert wird.
  305. </para>
  306. <para>
  307. Das Zielobjekt kann erstellt werden indem die
  308. <methodname>Zend_Pdf_Destination_FitBoundingBox::create($page, $left, $bottom,
  309. $right, $top)</methodname> Methode verwendet wird.
  310. </para>
  311. <para>
  312. Wobei <varname>$page</varname> eine Zielseite ist
  313. (ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
  314. </para>
  315. </sect4>
  316. <sect4
  317. id="zend.pdf.pages.interactive-features.destinations.types.fit-bounding-box-horizontally">
  318. <title>Zend_Pdf_Destination_FitBoundingBoxHorizontally</title>
  319. <para>
  320. Zeigt die spezifizierte Seite, mit den vertikalen Koordinaten an der oberen Ecke
  321. des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert
  322. damit die komplette Breite der Zeichenbox in das Fenster passt.
  323. </para>
  324. <para>
  325. Das Zielobjekt kann erstellt werden indem die
  326. <methodname>Zend_Pdf_Destination_FitBoundingBoxHorizontally::create($page,
  327. $top)</methodname> Methode verwendet wird.
  328. </para>
  329. <para>
  330. Wobei
  331. </para>
  332. <itemizedlist>
  333. <listitem>
  334. <para>
  335. <varname>$page</varname> eine Zielseite ist
  336. (ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
  337. </para>
  338. </listitem>
  339. <listitem>
  340. <para>
  341. <varname>$top</varname> ist die obere Ecke der angezeigten Seite
  342. (float).
  343. </para>
  344. </listitem>
  345. </itemizedlist>
  346. <para>
  347. Die Klasse
  348. <classname>Zend_Pdf_Destination_FitBoundingBoxHorizontally</classname> bietet
  349. auch die folgenden Methoden:
  350. </para>
  351. <itemizedlist>
  352. <listitem>
  353. <para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
  354. </listitem>
  355. <listitem>
  356. <para><methodname>setTopEdge(float $top)</methodname>;</para>
  357. </listitem>
  358. </itemizedlist>
  359. </sect4>
  360. <sect4
  361. id="zend.pdf.pages.interactive-features.destinations.types.fit-bounding-box-vertically">
  362. <title>Zend_Pdf_Destination_FitBoundingBoxVertically</title>
  363. <para>
  364. Zeigt die spezifizierte Seite, mit den horizontalen Koordinaten an der oberen
  365. Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug
  366. vergrössert damit die komplette Höhe der Zeichenbox in das Fenster passt.
  367. </para>
  368. <para>
  369. Das Zielobjekt kann erstellt werden indem die
  370. <methodname>Zend_Pdf_Destination_FitBoundingBoxVertically::create($page,
  371. $left)</methodname> Methode verwendet wird.
  372. </para>
  373. <para>
  374. Wobei
  375. </para>
  376. <itemizedlist>
  377. <listitem>
  378. <para>
  379. <varname>$page</varname> eine Zielseite ist
  380. (ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
  381. </para>
  382. </listitem>
  383. <listitem>
  384. <para>
  385. <varname>$left</varname> ist die linke Ecke der angezeigten Seite
  386. (float).
  387. </para>
  388. </listitem>
  389. </itemizedlist>
  390. <para>
  391. Die Klasse <classname>Zend_Pdf_Destination_FitBoundingBoxVertically</classname>
  392. bietet auch die folgenden Methoden:
  393. </para>
  394. <itemizedlist>
  395. <listitem>
  396. <para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
  397. </listitem>
  398. <listitem>
  399. <para><methodname>setLeftEdge(float $left)</methodname>;</para>
  400. </listitem>
  401. </itemizedlist>
  402. </sect4>
  403. <sect4 id="zend.pdf.pages.interactive-features.destinations.types.named">
  404. <title>Zend_Pdf_Destination_Named</title>
  405. <para>
  406. Alle oben aufgeführten Ziele sind "Explizite Ziele".
  407. </para>
  408. <para>
  409. Zusätzlich dazu können <acronym>PDF</acronym> Dokumente ein Verzeichnis solcher
  410. Ziele enthalten welche verwendet werden können um nach ausserhalb des
  411. <acronym>PDF</acronym>'s zu referenzieren (z.B.
  412. '<filename>http://www.mycompany.com/document.pdf#chapter3</filename>').
  413. </para>
  414. <para>
  415. <classname>Zend_Pdf_Destination_Named</classname> Objekte erlauben es auf Ziele
  416. der benannten Zielverzeichnisse des Dokuments zu referenzieren.
  417. </para>
  418. <para>
  419. Benannte Zielobjekte können erstellt werden indem man die
  420. <methodname>Zend_Pdf_Destination_Named::create(string $name)</methodname>
  421. Methode verwendet.
  422. </para>
  423. <para>
  424. Die Klasse <classname>Zend_Pdf_Destination_Named</classname> bietet eine einzige
  425. zusätzliche Methode:
  426. </para>
  427. <para>
  428. <type>String</type><methodname>getName()</methodname>;
  429. </para>
  430. </sect4>
  431. </sect3>
  432. <sect3 id="zend.pdf.pages.interactive-features.destinations.processing">
  433. <title>Verarbeitung von Zielen auf Level des Dokuments</title>
  434. <para>
  435. Die Klasse <classname>Zend_Pdf</classname> bietet ein Set von Methoden zur
  436. Verarbeitung von Zielen.
  437. </para>
  438. <para>
  439. Jedes Zielobjekt (inklusive benannter Ziele) kann aufgelöst werden indem die
  440. Methode <methodname>resolveDestination($destination)</methodname> verwendet wird.
  441. Sie gibt ein passendes <classname>Zend_Pdf_Page</classname> Objekt zurück wenn das
  442. Zielobjekt gefunden wurde, andernfalls <constant>NULL</constant>.
  443. </para>
  444. <para>
  445. Die Methode <methodname>Zend_Pdf::resolveDestination()</methodname> nimmt auch einen
  446. optionalen booleschen Parameter <varname>$refreshPageCollectionHashes</varname>, der
  447. standardmäßig true ist. Er zwingt das <classname>Zend_Pdf</classname> Objekt die
  448. Hashes der internen Kollektion der Seiten neu zu laden da die Liste der Seiten des
  449. Dokuments vom Benutzer aktualisiert sein könnte indem die Eigenschaft
  450. <varname>Zend_Pdf::$pages</varname> verwendet wird
  451. (<link linkend="zend.pdf.pages">Arbeiten mit Seiten</link>). Das kann aus Gründen
  452. der Performance ausgeschaltet werden, wenn bekannt ist das die Liste der Seiten des
  453. Dokuments seit der letzten Anfragemethode nicht geändert wurde.
  454. </para>
  455. <para>
  456. Die komplette Liste der benannten Ziele kann empfangen werden indem die Methode
  457. <methodname>Zend_Pdf::getNamedDestinations()</methodname> verwendet wird. Sie gibt
  458. ein Array von <classname>Zend_Pdf_Target</classname> Objekten zurück, welche
  459. entweder explizite Ziele oder eine GoTo Aktion sind
  460. (<link linkend="zend.pdf.pages.interactive-features.actions">Aktionen</link>).
  461. </para>
  462. <para>
  463. Die Methode <methodname>Zend_Pdf::getNamedDestination(string $name)</methodname>
  464. gibt spezifizierte benannte Ziele zurück (ein explizites Ziel oder eine GoTo
  465. Aktion).
  466. </para>
  467. <para>
  468. Das Verzeichnis der benannten Ziele des <acronym>PDF</acronym> Dokuments kann mit
  469. der Methode
  470. <methodname>Zend_Pdf::setNamedDestination(string $name, $destination)</methodname>
  471. aktualisiert werden, wobei <varname>$destination</varname> entweder ein explizites
  472. Ziel ist (jedes Ziel ausser <classname>Zend_Pdf_Destination_Named</classname>) oder
  473. eine GoTo Aktion.
  474. </para>
  475. <para>
  476. Wenn <constant>NULL</constant> statt <varname>$destination</varname> spezifiziert
  477. ist, werden die spezifizierten benannten Ziele entfernt.
  478. </para>
  479. <note>
  480. <para>
  481. Benannte Ziele die nicht aufgelöst werden können, werden automatisch vom
  482. Dokument entfernt wenn das Dokument gespeichert wird.
  483. </para>
  484. </note>
  485. <example id="zend.pdf.interactive-features.destinations.example-1">
  486. <title>Beispiel für die Verwendung von Zielen</title>
  487. <programlisting language="php"><![CDATA[
  488. $pdf = new Zend_Pdf();
  489. $page1 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
  490. $page2 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
  491. $page3 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
  492. // Erstellte Seiten, aber nicht in der Seitenliste enthalten
  493. $pdf->pages[] = $page1;
  494. $pdf->pages[] = $page2;
  495. $destination1 = Zend_Pdf_Destination_Fit::create($page2);
  496. $destination2 = Zend_Pdf_Destination_Fit::create($page3);
  497. // Gibt das $page2 Objekt zurück
  498. $page = $pdf->resolveDestination($destination1);
  499. // Gibt null zurück, die Seite 3 ist bis jetzt nicht im Dokument enthalten
  500. $page = $pdf->resolveDestination($destination2);
  501. $pdf->setNamedDestination('Page2', $destination1);
  502. $pdf->setNamedDestination('Page3', $destination2);
  503. // Gibt $destination2 zurück
  504. $destination = $pdf->getNamedDestination('Page3');
  505. // Gibt $destination1 zurück
  506. $pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page2'));
  507. // Gibt null zurück, die Seite 3 ist bis jetzt nicht im Dokument enthalten
  508. $pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page3'));
  509. ]]></programlisting>
  510. </example>
  511. </sect3>
  512. </sect2>
  513. <sect2 id="zend.pdf.pages.interactive-features.actions">
  514. <title>Aktionen</title>
  515. <para>
  516. Statt einfach zu einem Ziel im Dokument zu springen, kann ein Hinweis oder Outline
  517. Element eine Aktion für die Viewer Anwendung spezifizieren die auszuführen ist, wie
  518. das starten einer Anwendung, das Abspielen eines Sounds, oder der Änderung der
  519. Sichtweise des Hinweis Status.
  520. </para>
  521. <sect3 id="zend.pdf.pages.interactive-features.actions.types">
  522. <title>Unterstützte Typen von Aktionen</title>
  523. <para>
  524. Die folgenden Typen von Aktionen werden beim Laden vom <acronym>PDF</acronym>
  525. Dokument erkannt:
  526. </para>
  527. <itemizedlist>
  528. <listitem>
  529. <para>
  530. <classname>Zend_Pdf_Action_GoTo</classname> - geht zu einem Ziel im
  531. aktuellen Dokument.
  532. </para>
  533. </listitem>
  534. <listitem>
  535. <para>
  536. <classname>Zend_Pdf_Action_GoToR</classname> - geht zu einem Ziel in
  537. einem anderen Dokument.
  538. </para>
  539. </listitem>
  540. <listitem>
  541. <para>
  542. <classname>Zend_Pdf_Action_GoToE</classname> - geht zu einem Ziel in
  543. einem eingebetteten Dokument.
  544. </para>
  545. </listitem>
  546. <listitem>
  547. <para>
  548. <classname>Zend_Pdf_Action_Launch</classname> - startet eine Anwendung,
  549. öffnet oder druckt ein Dokument.
  550. </para>
  551. </listitem>
  552. <listitem>
  553. <para>
  554. <classname>Zend_Pdf_Action_Thread</classname> - beginnt einen Artikel Thread
  555. zu lesen.
  556. </para>
  557. </listitem>
  558. <listitem>
  559. <para>
  560. <classname>Zend_Pdf_Action_URI</classname> - löst ein
  561. <acronym>URI</acronym> auf.
  562. </para>
  563. </listitem>
  564. <listitem>
  565. <para>
  566. <classname>Zend_Pdf_Action_Sound</classname> - spielt einen Sound.
  567. </para>
  568. </listitem>
  569. <listitem>
  570. <para>
  571. <classname>Zend_Pdf_Action_Movie</classname> - spielt einen Film.
  572. </para>
  573. </listitem>
  574. <listitem>
  575. <para>
  576. <classname>Zend_Pdf_Action_Hide</classname> - versteckt oder zeigt einen
  577. oder mehrere Hinweise auf dem Bildschirm.
  578. </para>
  579. </listitem>
  580. <listitem>
  581. <para>
  582. <classname>Zend_Pdf_Action_Named</classname> - führt eine vordefinierte
  583. Aktion an der Viewer Anwendung aus:
  584. </para>
  585. <itemizedlist>
  586. <listitem>
  587. <para>
  588. <emphasis>NextPage</emphasis> - Geht zur nächsten Seite des
  589. Dokuments.
  590. </para>
  591. </listitem>
  592. <listitem>
  593. <para>
  594. <emphasis>PrevPage</emphasis> - Geht zur vorhergehenden Seite des
  595. Dokuments.
  596. </para>
  597. </listitem>
  598. <listitem>
  599. <para>
  600. <emphasis>FirstPage</emphasis> - Geht zur ersten Seite des
  601. Dokuments.
  602. </para>
  603. </listitem>
  604. <listitem>
  605. <para>
  606. <emphasis>LastPage</emphasis> - Geht zur letzten Seite des
  607. Dokuments.
  608. </para>
  609. </listitem>
  610. </itemizedlist>
  611. </listitem>
  612. <listitem>
  613. <para>
  614. <classname>Zend_Pdf_Action_SubmitForm</classname> - sendet Daten zu einem
  615. eindeutigen Ressourcenziel.
  616. </para>
  617. </listitem>
  618. <listitem>
  619. <para>
  620. <classname>Zend_Pdf_Action_ResetForm</classname> - setzt Felder mit Ihren
  621. Standardwerten.
  622. </para>
  623. </listitem>
  624. <listitem>
  625. <para>
  626. <classname>Zend_Pdf_Action_ImportData</classname> - importiert Feldwerte von
  627. einer Datei.
  628. </para>
  629. </listitem>
  630. <listitem>
  631. <para>
  632. <classname>Zend_Pdf_Action_JavaScript</classname> - führt ein JavaScript
  633. Skript aus.
  634. </para>
  635. </listitem>
  636. <listitem>
  637. <para>
  638. <classname>Zend_Pdf_Action_SetOCGState</classname> - setzt den Status von
  639. einem oder mehreren optionalen Inhaltsgruppen.
  640. </para>
  641. </listitem>
  642. <listitem>
  643. <para>
  644. <classname>Zend_Pdf_Action_Rendition</classname> - kontrolliert das
  645. Abspielen von Multimedia Inhalten (Beginnen, Stoppen, Pausieren oder
  646. Fortsetzen des Abspielens).
  647. </para>
  648. </listitem>
  649. <listitem>
  650. <para>
  651. <classname>Zend_Pdf_Action_Trans</classname> - Aktualisiert das Display
  652. eines Dokuments indem ein Übersetzungsverzeichnis verwendet wird.
  653. </para>
  654. </listitem>
  655. <listitem>
  656. <para>
  657. <classname>Zend_Pdf_Action_GoTo3DView</classname> - setzt die aktuelle
  658. Ansicht eines 3D Hinweises.
  659. </para>
  660. </listitem>
  661. </itemizedlist>
  662. <para>
  663. Nur <classname>Zend_Pdf_Action_GoTo</classname> Aktionen können aktuell von
  664. Benutzern erstellt werden. Das kann getan werden indem die Methode
  665. <methodname>Zend_Pdf_Action_GoTo::create($destination)</methodname> verwendet
  666. wird wobei <varname>$destination</varname> ein
  667. <classname>Zend_Pdf_Destination</classname> Objekt oder String ist der verwendet
  668. werden kann um ein benanntes Ziel zu identifizieren.
  669. </para>
  670. <para>
  671. Es unterstützt auch die folgenden Methoden:
  672. </para>
  673. </sect3>
  674. <sect3 id="zend.pdf.pages.interactive-features.actions.chaining">
  675. <title>Actions chaining</title>
  676. <para>
  677. Actions objects can be chained using <varname>Zend_Pdf_Action::$next</varname>
  678. public property.
  679. </para>
  680. <para>
  681. It's an array of <classname>Zend_Pdf_Action</classname> objects, which also
  682. may have their sub-actions.
  683. </para>
  684. <para>
  685. <classname>Zend_Pdf_Action</classname> class supports RecursiveIterator interface,
  686. so child actions may be iterated recursively:
  687. </para>
  688. <programlisting language="php"><![CDATA[
  689. $pdf = new Zend_Pdf();
  690. $page1 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
  691. $page2 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
  692. // Page created, but not included into pages list
  693. $page3 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
  694. $pdf->pages[] = $page1;
  695. $pdf->pages[] = $page2;
  696. $action1 = Zend_Pdf_Action_GoTo::create(
  697. Zend_Pdf_Destination_Fit::create($page2));
  698. $action2 = Zend_Pdf_Action_GoTo::create(
  699. Zend_Pdf_Destination_Fit::create($page3));
  700. $action3 = Zend_Pdf_Action_GoTo::create(
  701. Zend_Pdf_Destination_Named::create('Chapter1'));
  702. $action4 = Zend_Pdf_Action_GoTo::create(
  703. Zend_Pdf_Destination_Named::create('Chapter5'));
  704. $action2->next[] = $action3;
  705. $action2->next[] = $action4;
  706. $action1->next[] = $action2;
  707. $actionsCount = 1; // Note! Iteration doesn't include top level action and
  708. // walks through children only
  709. $iterator = new RecursiveIteratorIterator(
  710. $action1,
  711. RecursiveIteratorIterator::SELF_FIRST);
  712. foreach ($iterator as $chainedAction) {
  713. $actionsCount++;
  714. }
  715. printf("Actions in a tree: %d\n", $actionsCount++); // Prints 'Actions in a tree: 4'
  716. ]]></programlisting>
  717. </sect3>
  718. <sect3 id="zend.pdf.pages.interactive-features.actions.open-action">
  719. <title>Document Open Action</title>
  720. <para>
  721. Special open action may be specify a destination to be displayed or an action
  722. to be performed when the document is opened.
  723. </para>
  724. <para>
  725. <methodname>Zend_Pdf_Target Zend_Pdf::getOpenAction()</methodname> method
  726. returns current document open action (or null if open action is not set).
  727. </para>
  728. <para>
  729. <methodname>setOpenAction(Zend_Pdf_Target $openAction = null)</methodname>
  730. method sets document open action or clean it if <varname>$openAction</varname>
  731. is null.
  732. </para>
  733. </sect3>
  734. </sect2>
  735. <sect2 id="zend.pdf.pages.interactive-features.outlines">
  736. <title>Document Outline (bookmarks)</title>
  737. <para>
  738. A PDF document may optionally display a document outline on the screen, allowing
  739. the user to navigate interactively from one part of the document to another.
  740. The outline consists of a tree-structured hierarchy of outline items (sometimes
  741. called bookmarks), which serve as a visual table of contents to display the document’s
  742. structure to the user. The user can interactively open and close individual
  743. items by clicking them with the mouse. When an item is open, its immediate children
  744. in the hierarchy become visible on the screen; each child may in turn be
  745. open or closed, selectively revealing or hiding further parts of the hierarchy.
  746. When an item is closed, all of its descendants in the hierarchy are hidden. Clicking
  747. the text of any visible item activates the item, causing the viewer application to
  748. jump to a destination or trigger an action associated with the item.
  749. </para>
  750. <para>
  751. <classname>Zend_Pdf</classname> class provides public property
  752. <varname>$outlines</varname> which is an array of
  753. <classname>Zend_Pdf_Outline</classname> objects.
  754. <programlisting language="php"><![CDATA[
  755. $pdf = Zend_Pdf::load($path);
  756. // Remove outline item
  757. unset($pdf->outlines[0]->childOutlines[1]);
  758. // Set Outline to be displayed in bold
  759. $pdf->outlines[0]->childOutlines[3]->setIsBold(true);
  760. // Add outline entry
  761. $pdf->outlines[0]->childOutlines[5]->childOutlines[] =
  762. Zend_Pdf_Outline::create('Chapter 2', 'chapter_2');
  763. $pdf->save($path, true);
  764. ]]></programlisting>
  765. </para>
  766. <para>
  767. Outline attributes may be retrieved or set using the following methods:
  768. </para>
  769. <itemizedlist>
  770. <listitem>
  771. <para>
  772. <methodname>string getTitle()</methodname> - get outline item title.
  773. </para>
  774. </listitem>
  775. <listitem>
  776. <para>
  777. <methodname>setTitle(string $title)</methodname> - set outline item title.
  778. </para>
  779. </listitem>
  780. <listitem>
  781. <para>
  782. <methodname>boolean isOpen()</methodname> - true if outline is open
  783. by default.
  784. </para>
  785. </listitem>
  786. <listitem>
  787. <para>
  788. <methodname>setIsOpen(boolean $isOpen)</methodname> - set isOpen state.
  789. </para>
  790. </listitem>
  791. <listitem>
  792. <para>
  793. <methodname>boolean isItalic()</methodname> - true if outline item
  794. is displayed in italic.
  795. </para>
  796. </listitem>
  797. <listitem>
  798. <para>
  799. <methodname>setIsItalic(boolean $isItalic)</methodname> - set
  800. isItalic state.
  801. </para>
  802. </listitem>
  803. <listitem>
  804. <para>
  805. <methodname>boolean isBold()</methodname> - true if outline item
  806. is displayed in bold.
  807. </para>
  808. </listitem>
  809. <listitem>
  810. <para>
  811. <methodname>setIsBold(boolean $isBold)</methodname> - set
  812. isBold state.
  813. </para>
  814. </listitem>
  815. <listitem>
  816. <para>
  817. <methodname>Zend_Pdf_Color_Rgb getColor()</methodname> - get outline
  818. text color (null means black).
  819. </para>
  820. </listitem>
  821. <listitem>
  822. <para>
  823. <methodname>setColor(Zend_Pdf_Color_Rgb $color)</methodname> - set
  824. outline text color (null means black).
  825. </para>
  826. </listitem>
  827. <listitem>
  828. <para>
  829. <methodname>Zend_Pdf_Target getTarget()</methodname> - get outline
  830. target (action or explicit or named destination object).
  831. </para>
  832. </listitem>
  833. <listitem>
  834. <para>
  835. <methodname>setTarget(Zend_Pdf_Target|string $target)</methodname> - set
  836. outline target (action or destination). String may be used to identify
  837. named destination. Null means 'no target'.
  838. </para>
  839. </listitem>
  840. <listitem>
  841. <para>
  842. <methodname>array getOptions()</methodname> - get outline attributes
  843. as an array.
  844. </para>
  845. </listitem>
  846. <listitem>
  847. <para>
  848. <methodname>setOptions(array $options)</methodname> - set outline options.
  849. The following options are recognized: 'title', 'open', 'color', 'italic',
  850. 'bold', and 'target'.
  851. </para>
  852. </listitem>
  853. </itemizedlist>
  854. <para>
  855. New outline may be created in two ways:
  856. </para>
  857. <itemizedlist>
  858. <listitem>
  859. <para>
  860. <methodname>Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target|string $target])</methodname>
  861. </para>
  862. </listitem>
  863. <listitem>
  864. <para>
  865. <methodname>Zend_Pdf_Outline::create(array $options)</methodname>
  866. </para>
  867. </listitem>
  868. </itemizedlist>
  869. <para>
  870. Each outline object may have child outline items listed in
  871. <varname>Zend_Pdf_Outline::$childOutlines</varname> public property.
  872. It's an array of <classname>Zend_Pdf_Outline</classname> objects,
  873. so outlines are organized in a tree.
  874. </para>
  875. <para>
  876. <classname>Zend_Pdf_Outline</classname> class implements RecursiveArray interface,
  877. so child outlines may be recursively iterated using RecursiveIteratorIterator:
  878. <programlisting language="php"><![CDATA[
  879. $pdf = Zend_Pdf::load($path);
  880. foreach ($pdf->outlines as $documentRootOutlineEntry) {
  881. $iterator = new RecursiveIteratorIterator($documentRootOutlineEntry,
  882. RecursiveIteratorIterator::SELF_FIRST);
  883. foreach ($iterator as $childOutlineItem) {
  884. $OutlineItemTarget = $childOutlineItem->getTarget();
  885. if ($OutlineItemTarget instanceof Zend_Pdf_Destination) {
  886. if ($pdf->resolveDestination($OutlineItemTarget) === null) {
  887. // Mark Outline item with unresolvable destination using RED color
  888. $childOutlineItem->setColor(new Zend_Pdf_Color_Rgb(1, 0, 0));
  889. }
  890. } else if ($OutlineItemTarget instanceof Zend_Pdf_Action_GoTo) {
  891. if ($pdf->resolveDestination($OutlineItemTarget->setDestination()) === null) {
  892. // Mark Outline item with unresolvable destination using RED color
  893. $childOutlineItem->setColor(new Zend_Pdf_Color_Rgb(1, 0, 0));
  894. }
  895. }
  896. }
  897. }
  898. $pdf->save($path, true);
  899. ]]></programlisting>
  900. </para>
  901. <note>
  902. <para>
  903. All outline items with unresolved destinations (or destinations of GoTo
  904. actions) are updated while document saving by setting their targets to null.
  905. So document will not be corrupted by removing pages referenced by outlines.
  906. </para>
  907. </note>
  908. </sect2>
  909. <sect2 id="zend.pdf.pages.interactive-features.annotations">
  910. <title>Annotations</title>
  911. <para>
  912. An annotation associates an object such as a note, sound, or movie with a location
  913. on a page of a PDF document, or provides a way to interact with the user by means
  914. of the mouse and keyboard.
  915. </para>
  916. <para>
  917. All annotations are represented by <classname>Zend_Pdf_Annotation</classname>
  918. abstract class.
  919. </para>
  920. <para>
  921. Annotation may be attached to a page using
  922. <methodname>Zend_Pdf_Page::attachAnnotation(Zend_Pdf_Annotation $annotation)</methodname>
  923. method.
  924. </para>
  925. <para>
  926. Three types of annotations may be created by user now:
  927. </para>
  928. <itemizedlist>
  929. <listitem>
  930. <para>
  931. <methodname>Zend_Pdf_Annotation_Link::create($x1, $y1, $x2, $y2, $target)</methodname>
  932. where <varname>$target</varname> is an action object or a destination or
  933. string (which may be used in place of named destination object).
  934. </para>
  935. </listitem>
  936. <listitem>
  937. <para>
  938. <methodname>Zend_Pdf_Annotation_Text::create($x1, $y1, $x2, $y2, $text)</methodname>
  939. </para>
  940. </listitem>
  941. <listitem>
  942. <para>
  943. <methodname>Zend_Pdf_Annotation_FileAttachment::create($x1, $y1, $x2, $y2, $fileSpecification)</methodname>
  944. </para>
  945. </listitem>
  946. </itemizedlist>
  947. <para>
  948. A link annotation represents either a hypertext link to a destination elsewhere in
  949. the document or an action to be performed.
  950. </para>
  951. <para>
  952. A text annotation represents a "sticky note" attached to a point in the PDF document.
  953. </para>
  954. <para>
  955. A file attachment annotation contains a reference to a file.
  956. </para>
  957. <para>
  958. The following methods are shared between all annotation types:
  959. </para>
  960. <itemizedlist>
  961. <listitem>
  962. <para><methodname>setLeft(float $left)</methodname></para>
  963. </listitem>
  964. <listitem>
  965. <para><methodname>float getLeft()</methodname></para>
  966. </listitem>
  967. <listitem>
  968. <para><methodname>setRight(float $right)</methodname></para>
  969. </listitem>
  970. <listitem>
  971. <para><methodname>float getRight()</methodname></para>
  972. </listitem>
  973. <listitem>
  974. <para><methodname>setTop(float $top)</methodname></para>
  975. </listitem>
  976. <listitem>
  977. <para><methodname>float getTop()</methodname></para>
  978. </listitem>
  979. <listitem>
  980. <para><methodname>setBottom(float $bottom)</methodname></para>
  981. </listitem>
  982. <listitem>
  983. <para><methodname>float getBottom()</methodname></para>
  984. </listitem>
  985. <listitem>
  986. <para><methodname>setText(string $text)</methodname></para>
  987. </listitem>
  988. <listitem>
  989. <para><methodname>string getText()</methodname></para>
  990. </listitem>
  991. </itemizedlist>
  992. <para>
  993. Text annotation property is a text to be displayed for the annotation or, if this
  994. type of annotation does not display text, an alternate description of the annotation’s
  995. contents in human-readable form.
  996. </para>
  997. <para>
  998. Link annotation objects also provide two additional methods:
  999. </para>
  1000. <itemizedlist>
  1001. <listitem>
  1002. <para>
  1003. <methodname>setDestination(Zend_Pdf_Target|string $target)</methodname>
  1004. </para>
  1005. </listitem>
  1006. <listitem>
  1007. <para>
  1008. <methodname>Zend_Pdf_Target getDestination()</methodname>
  1009. </para>
  1010. </listitem>
  1011. </itemizedlist>
  1012. </sect2>
  1013. </sect1>
  1014. <!--
  1015. vim:se ts=4 sw=4 et:
  1016. -->