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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.pdf.interactive-features">
<title>Interaktive Features</title>
<sect2 id="zend.pdf.pages.interactive-features.destinations">
<title>Ziele</title>
<para>
Ein Ziel definiert eine spezielle Sicht eines Dokuments, bestehend aus den folgenden
Elementen:
</para>
<itemizedlist>
<listitem><para>Die Seite des Dokuments das angezeigt werden soll.</para></listitem>
<listitem><para>Der Ort des Dokumenten Fensters auf dieser Seite.</para></listitem>
<listitem>
<para>
Der Zoom Faktor der verwendet werden soll wenn die Seite angezeigt wird.
</para>
</listitem>
</itemizedlist>
<para>
Ziele können mit Outline Elementen ((<link
linkend="zend.pdf.pages.interactive-features.outlines">Document Outline
(bookmarks)</link>), Hinweisen (<link
linkend="zend.pdf.pages.interactive-features.annotations">Annotations</link>), oder
Aktionen (<link linkend="zend.pdf.pages.interactive-features.actions">Actions</link>)
verknüpft werden. In jedem Fall spezifiziert das Ziel die Sicht des Dokuments welche
dargestellt werden soll wenn das Outline Element oder der Hinweis geöffnet, oder die
Aktion durchgeführt werden soll. Zusätzlich kann eine optionale Dokument Öffnungs-Aktion
spezifiziert werden.
</para>
<sect3 id="zend.pdf.pages.interactive-features.destinations.types">
<title>Unterstützte Zieltypen</title>
<para>
Die folgenden Typen werden von der <classname>Zend_Pdf</classname> Komponente
unterstützt.
</para>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.zoom">
<title>Zend_Pdf_Destination_Zoom</title>
<para>
Zeigt die spezifizierte Seite, mit den Koordinaten (Links, Oben) positioniert
an der oberen-linken Ecke des Fensters und dem Inhalt der Seite vergrößert
auf den Zoom Faktor.
</para>
<para>
Zielobjekte können durch Verwendung der
<methodname>Zend_Pdf_Destination_Zoom::create($page, $left = null, $top = null,
$zoom = null)</methodname> Methode erstellt werden.
</para>
<para>
Wobei:
</para>
<itemizedlist>
<listitem>
<para>
<varname>$page</varname> eine Zielseite ist (ein
<classname>Zend_Pdf_Page</classname> Objekt oder eine Seitennummer).
</para>
</listitem>
<listitem>
<para>
<varname>$left</varname> ist die linke Ecke der angezeigten Seite
(float).
</para>
</listitem>
<listitem>
<para>
<varname>$top</varname> ist eine obere Ecke der angezeigten Seite
(float).
</para>
</listitem>
<listitem>
<para>
<varname>$zoom</varname> ist ein Zoom Faktor (float).
</para>
</listitem>
</itemizedlist>
<para>
<constant>NULL</constant>, wenn es für die <varname>$left</varname>,
<varname>$top</varname> or <varname>$zoom</varname> Parameter spezifiziert wird,
heißt "aktueller Wert der Viewer Anwendung".
</para>
<para>
Die <classname>Zend_Pdf_Destination_Zoom</classname> Klasse bietet die folgenden
Methoden an:
</para>
<itemizedlist>
<listitem>
<para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setLeftEdge(float $left)</methodname>;</para>
</listitem>
<listitem>
<para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setTopEdge(float $top)</methodname>;</para>
</listitem>
<listitem>
<para><type>Float</type><methodname>getZoomFactor()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setZoomFactor(float $zoom)</methodname>;</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit">
<title>Zend_Pdf_Destination_Fit</title>
<para>
Zeigt die spezifizierte Seite an, wobei der Inhalt soweit vergrössert wird,
dass er auf die komplette Seite passt sowohl Horizontal als auch Vertikal im
Fenster. Wenn die benötigten horizontalen und vertikalen Vergrösserungsfaktoren
unterschiedlich sind, wird der kleinere der zwei verwendet, und die Seite im
Fenster mit der anderen Dimension zentriert.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_Fit::create($page)</methodname> Methode
verwendet wird.
</para>
<para>
Wobei <varname>$page</varname> eine Zielseite ist (ein
<classname>Zend_Pdf_Page</classname> Objekt oder eine Seitennummer).
</para>
</sect4>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-horizontally">
<title>Zend_Pdf_Destination_FitHorizontally</title>
<para>
Zeigt die spezifizierte Seite, mit den vertikalen Koordinaten an der oberen Ecke
des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert
damit die komplette Breite der Seite in das Fenster passt.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_FitHorizontally::create($page,
$top)</methodname> Methode verwendet wird.
</para>
<para>
Wobei:
</para>
<itemizedlist>
<listitem>
<para>
<varname>$page</varname> ist eine Zielseite
(ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
</para>
</listitem>
<listitem>
<para>
<varname>$top</varname> ist die obere Ecke der angezeigten Seite
(float).
</para>
</listitem>
</itemizedlist>
<para>
Die Klasse <classname>Zend_Pdf_Destination_FitHorizontally</classname> bietet
auch die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setTopEdge(float $top)</methodname>;</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-vertically">
<title>Zend_Pdf_Destination_FitVertically</title>
<para>
Zeigt die spezifizierte Seite, mit den horizontalen Koordinaten an der oberen
Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug
vergrössert damit die komplette Höhe der Seite in das Fenster passt.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_FitVertically::create($page,
$left)</methodname> Methode verwendet wird.
</para>
<para>
Wobei:
</para>
<itemizedlist>
<listitem>
<para>
<varname>$page</varname> ist eine Zielseite
(ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
</para>
</listitem>
<listitem>
<para>
<varname>$left</varname> die linke Ecke der angezeigten Seite ist.
(float).
</para>
</listitem>
</itemizedlist>
<para>
Die Klasse <classname>Zend_Pdf_Destination_FitVertically</classname> bietet auch
die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setLeftEdge(float $left)</methodname>;</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-rectangle">
<title>Zend_Pdf_Destination_FitRectangle</title>
<para>
Zeigt die spezifizierte Seite an, wobei der Inhalt gerade genug vergrössert ist
damit er komplett in das Rechteck passt das durch die Koordinaten links, unten,
rechts und oben spezifiziert wird sowohl horizontal als auch vertikal. Wenn die
notwendigen horizontalen und vertikalen Vergrösserungsfaktoren unterschiedlich
sind, wird der kleinere der zwei verwendet, wobei das Rechteck im Fenster durch
Verwendung der andern Dimension zentriert wird.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_FitRectangle::create($page, $left, $bottom,
$right, $top)</methodname> Methode verwendet wird.
</para>
<para>
Wobei:
</para>
<itemizedlist>
<listitem>
<para>
<varname>$page</varname> ist eine Zielseite
(ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
</para>
</listitem>
<listitem>
<para>
<varname>$left</varname> die linke Ecke der angezeigten Seite ist.
(float).
</para>
</listitem>
<listitem>
<para>
<varname>$bottom</varname> die untere Ecke der angezeigten Seite ist
(float).
</para>
</listitem>
<listitem>
<para>
<varname>$right</varname> die rechte Ecke der angezeigten Seite ist
(float).
</para>
</listitem>
<listitem>
<para>
<varname>$top</varname> die obere Ecke der angezeigten Seite ist
(float).
</para>
</listitem>
</itemizedlist>
<para>
Die Klasse <classname>Zend_Pdf_Destination_FitRectangle</classname> bietet auch
die folgenden Methoden an:
</para>
<itemizedlist>
<listitem>
<para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setLeftEdge(float $left)</methodname>;</para>
</listitem>
<listitem>
<para><type>Float</type><methodname>getBottomEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setBottomEdge(float $bottom)</methodname>;</para>
</listitem>
<listitem>
<para><type>Float</type><methodname>getRightEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setRightEdge(float $right)</methodname>;</para>
</listitem>
<listitem>
<para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setTopEdge(float $top)</methodname>;</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.fit-bounding-box">
<title>Zend_Pdf_Destination_FitBoundingBox</title>
<para>
Zeigt die spezifizierte Seite an, wobei der Inhalt gerade genug vergrössert ist
damit die Zeichenbox komplett in das Fenster passt, sowohl horizontal als auch
vertikal. Wenn die notwendigen horizontalen und vertikalen
Vergrösserungsfaktoren unterschiedlich sind, wird der kleinere der zwei
verwendet, wobei die Zeichenbox im Fenster durch Verwendung der andern Dimension
zentriert wird.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_FitBoundingBox::create($page, $left, $bottom,
$right, $top)</methodname> Methode verwendet wird.
</para>
<para>
Wobei <varname>$page</varname> eine Zielseite ist
(ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
</para>
</sect4>
<sect4
id="zend.pdf.pages.interactive-features.destinations.types.fit-bounding-box-horizontally">
<title>Zend_Pdf_Destination_FitBoundingBoxHorizontally</title>
<para>
Zeigt die spezifizierte Seite, mit den vertikalen Koordinaten an der oberen Ecke
des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert
damit die komplette Breite der Zeichenbox in das Fenster passt.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_FitBoundingBoxHorizontally::create($page,
$top)</methodname> Methode verwendet wird.
</para>
<para>
Wobei
</para>
<itemizedlist>
<listitem>
<para>
<varname>$page</varname> eine Zielseite ist
(ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
</para>
</listitem>
<listitem>
<para>
<varname>$top</varname> ist die obere Ecke der angezeigten Seite
(float).
</para>
</listitem>
</itemizedlist>
<para>
Die Klasse
<classname>Zend_Pdf_Destination_FitBoundingBoxHorizontally</classname> bietet
auch die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para><type>Float</type><methodname>getTopEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setTopEdge(float $top)</methodname>;</para>
</listitem>
</itemizedlist>
</sect4>
<sect4
id="zend.pdf.pages.interactive-features.destinations.types.fit-bounding-box-vertically">
<title>Zend_Pdf_Destination_FitBoundingBoxVertically</title>
<para>
Zeigt die spezifizierte Seite, mit den horizontalen Koordinaten an der oberen
Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug
vergrössert damit die komplette Höhe der Zeichenbox in das Fenster passt.
</para>
<para>
Das Zielobjekt kann erstellt werden indem die
<methodname>Zend_Pdf_Destination_FitBoundingBoxVertically::create($page,
$left)</methodname> Methode verwendet wird.
</para>
<para>
Wobei
</para>
<itemizedlist>
<listitem>
<para>
<varname>$page</varname> eine Zielseite ist
(ein <classname>Zend_Pdf_Page</classname> Objekt oder eine Seitenzahl).
</para>
</listitem>
<listitem>
<para>
<varname>$left</varname> ist die linke Ecke der angezeigten Seite
(float).
</para>
</listitem>
</itemizedlist>
<para>
Die Klasse <classname>Zend_Pdf_Destination_FitBoundingBoxVertically</classname>
bietet auch die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para><type>Float</type><methodname>getLeftEdge()</methodname>;</para>
</listitem>
<listitem>
<para><methodname>setLeftEdge(float $left)</methodname>;</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 id="zend.pdf.pages.interactive-features.destinations.types.named">
<title>Zend_Pdf_Destination_Named</title>
<para>
Alle oben aufgeführten Ziele sind "Explizite Ziele".
</para>
<para>
Zusätzlich dazu können <acronym>PDF</acronym> Dokumente ein Verzeichnis solcher
Ziele enthalten welche verwendet werden können um nach ausserhalb des
<acronym>PDF</acronym>'s zu referenzieren (z.B.
'<filename>http://www.mycompany.com/document.pdf#chapter3</filename>').
</para>
<para>
<classname>Zend_Pdf_Destination_Named</classname> Objekte erlauben es auf Ziele
der benannten Zielverzeichnisse des Dokuments zu referenzieren.
</para>
<para>
Benannte Zielobjekte können erstellt werden indem man die
<methodname>Zend_Pdf_Destination_Named::create(string $name)</methodname>
Methode verwendet.
</para>
<para>
Die Klasse <classname>Zend_Pdf_Destination_Named</classname> bietet eine einzige
zusätzliche Methode:
</para>
<para>
<type>String</type><methodname>getName()</methodname>;
</para>
</sect4>
</sect3>
<sect3 id="zend.pdf.pages.interactive-features.destinations.processing">
<title>Verarbeitung von Zielen auf Level des Dokuments</title>
<para>
Die Klasse <classname>Zend_Pdf</classname> bietet ein Set von Methoden zur
Verarbeitung von Zielen.
</para>
<para>
Jedes Zielobjekt (inklusive benannter Ziele) kann aufgelöst werden indem die
Methode <methodname>resolveDestination($destination)</methodname> verwendet wird.
Sie gibt ein passendes <classname>Zend_Pdf_Page</classname> Objekt zurück wenn das
Zielobjekt gefunden wurde, andernfalls <constant>NULL</constant>.
</para>
<para>
Die Methode <methodname>Zend_Pdf::resolveDestination()</methodname> nimmt auch einen
optionalen booleschen Parameter <varname>$refreshPageCollectionHashes</varname>, der
standardmäßig <constant>TRUE</constant> ist. Er zwingt das
<classname>Zend_Pdf</classname> Objekt die Hashes der internen Kollektion der Seiten
neu zu laden da die Liste der Seiten des Dokuments vom Benutzer aktualisiert sein
könnte indem die Eigenschaft <varname>Zend_Pdf::$pages</varname> verwendet wird
(<link linkend="zend.pdf.pages">Arbeiten mit Seiten</link>). Das kann aus Gründen
der Performance ausgeschaltet werden, wenn bekannt ist das die Liste der Seiten des
Dokuments seit der letzten Anfragemethode nicht geändert wurde.
</para>
<para>
Die komplette Liste der benannten Ziele kann empfangen werden indem die Methode
<methodname>Zend_Pdf::getNamedDestinations()</methodname> verwendet wird. Sie gibt
ein Array von <classname>Zend_Pdf_Target</classname> Objekten zurück, welche
entweder explizite Ziele oder eine GoTo Aktion sind
(<link linkend="zend.pdf.pages.interactive-features.actions">Aktionen</link>).
</para>
<para>
Die Methode <methodname>Zend_Pdf::getNamedDestination(string $name)</methodname>
gibt spezifizierte benannte Ziele zurück (ein explizites Ziel oder eine GoTo
Aktion).
</para>
<para>
Das Verzeichnis der benannten Ziele des <acronym>PDF</acronym> Dokuments kann mit
der Methode
<methodname>Zend_Pdf::setNamedDestination(string $name, $destination)</methodname>
aktualisiert werden, wobei <varname>$destination</varname> entweder ein explizites
Ziel ist (jedes Ziel ausser <classname>Zend_Pdf_Destination_Named</classname>) oder
eine GoTo Aktion.
</para>
<para>
Wenn <constant>NULL</constant> statt <varname>$destination</varname> spezifiziert
ist, werden die spezifizierten benannten Ziele entfernt.
</para>
<note>
<para>
Benannte Ziele die nicht aufgelöst werden können, werden automatisch vom
Dokument entfernt wenn das Dokument gespeichert wird.
</para>
</note>
<example id="zend.pdf.interactive-features.destinations.example-1">
<title>Beispiel für die Verwendung von Zielen</title>
<programlisting language="php"><![CDATA[
$pdf = new Zend_Pdf();
$page1 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
$page2 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
$page3 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
// Erstellte Seiten, aber nicht in der Seitenliste enthalten
$pdf->pages[] = $page1;
$pdf->pages[] = $page2;
$destination1 = Zend_Pdf_Destination_Fit::create($page2);
$destination2 = Zend_Pdf_Destination_Fit::create($page3);
// Gibt das $page2 Objekt zurück
$page = $pdf->resolveDestination($destination1);
// Gibt null zurück, die Seite 3 ist bis jetzt nicht im Dokument enthalten
$page = $pdf->resolveDestination($destination2);
$pdf->setNamedDestination('Page2', $destination1);
$pdf->setNamedDestination('Page3', $destination2);
// Gibt $destination2 zurück
$destination = $pdf->getNamedDestination('Page3');
// Gibt $destination1 zurück
$pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page2'));
// Gibt null zurück, die Seite 3 ist bis jetzt nicht im Dokument enthalten
$pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page3'));
]]></programlisting>
</example>
</sect3>
</sect2>
<sect2 id="zend.pdf.pages.interactive-features.actions">
<title>Aktionen</title>
<para>
Statt einfach zu einem Ziel im Dokument zu springen, kann ein Hinweis oder Outline
Element eine Aktion für die Viewer Anwendung spezifizieren die auszuführen ist, wie
das starten einer Anwendung, das Abspielen eines Sounds, oder der Änderung der
Sichtweise des Hinweis Status.
</para>
<sect3 id="zend.pdf.pages.interactive-features.actions.types">
<title>Unterstützte Typen von Aktionen</title>
<para>
Die folgenden Typen von Aktionen werden beim Laden vom <acronym>PDF</acronym>
Dokument erkannt:
</para>
<itemizedlist>
<listitem>
<para>
<classname>Zend_Pdf_Action_GoTo</classname> - geht zu einem Ziel im
aktuellen Dokument.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_GoToR</classname> - geht zu einem Ziel in
einem anderen Dokument.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_GoToE</classname> - geht zu einem Ziel in
einem eingebetteten Dokument.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Launch</classname> - startet eine Anwendung,
öffnet oder druckt ein Dokument.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Thread</classname> - beginnt einen Artikel Thread
zu lesen.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_URI</classname> - löst ein
<acronym>URI</acronym> auf.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Sound</classname> - spielt einen Sound.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Movie</classname> - spielt einen Film.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Hide</classname> - versteckt oder zeigt einen
oder mehrere Hinweise auf dem Bildschirm.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Named</classname> - führt eine vordefinierte
Aktion an der Viewer Anwendung aus:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>NextPage</emphasis> - Geht zur nächsten Seite des
Dokuments.
</para>
</listitem>
<listitem>
<para>
<emphasis>PrevPage</emphasis> - Geht zur vorhergehenden Seite des
Dokuments.
</para>
</listitem>
<listitem>
<para>
<emphasis>FirstPage</emphasis> - Geht zur ersten Seite des
Dokuments.
</para>
</listitem>
<listitem>
<para>
<emphasis>LastPage</emphasis> - Geht zur letzten Seite des
Dokuments.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_SubmitForm</classname> - sendet Daten zu einem
eindeutigen Ressourcenziel.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_ResetForm</classname> - setzt Felder mit Ihren
Standardwerten.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_ImportData</classname> - importiert Feldwerte von
einer Datei.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_JavaScript</classname> - führt ein JavaScript
Skript aus.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_SetOCGState</classname> - setzt den Status von
einem oder mehreren optionalen Inhaltsgruppen.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Rendition</classname> - kontrolliert das
Abspielen von Multimedia Inhalten (Beginnen, Stoppen, Pausieren oder
Fortsetzen des Abspielens).
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_Trans</classname> - Aktualisiert das Display
eines Dokuments indem ein Übersetzungsverzeichnis verwendet wird.
</para>
</listitem>
<listitem>
<para>
<classname>Zend_Pdf_Action_GoTo3DView</classname> - setzt die aktuelle
Ansicht eines 3D Hinweises.
</para>
</listitem>
</itemizedlist>
<para>
Nur <classname>Zend_Pdf_Action_GoTo</classname> und
<classname>Zend_Pdf_Action_URI</classname> Aktionen können aktuell von
Benutzern erstellt werden.
</para>
<para>
Goto Aktionen können erstellt werden indem die Methode
<methodname>Zend_Pdf_Action_GoTo::create($destination)</methodname> verwendet
wird wobei <varname>$destination</varname> ein
<classname>Zend_Pdf_Destination</classname> Objekt oder ein String ist der verwendet
werden kann um ein benanntes Ziel zu identifizieren.
</para>
<para>
Die Methode <methodname>Zend_Pdf_Action_URI::create($uri[, $isMap])</methodname>
muss verwendet werden um eine URI Aktion zu erstellen (siehe die
<acronym>API</acronym> Dokumentation für Details). Der optionale
<varname>$isMap</varname> Parameter wird standardmäßig auf
<constant>FALSE</constant> gesetzt.
</para>
<para>
Es unterstützt auch die folgenden Methoden:
</para>
</sect3>
<sect3 id="zend.pdf.pages.interactive-features.actions.chaining">
<title>Verketten von Aktionen</title>
<para>
Aktions Objekte können verkettet werden indem die öffentliche Eigenschaft
<varname>Zend_Pdf_Action::$next</varname> verwendet wird.
</para>
<para>
Sie ist ein Array von <classname>Zend_Pdf_Action</classname> Objekten, welche auch
Unter-Aktionen haben können.
</para>
<para>
Die <classname>Zend_Pdf_Action</classname> Klasse unterstützt das RecursiveIterator
Interface damit Kinder-Aktionen iterativ durchlaufen werden können:
</para>
<programlisting language="php"><![CDATA[
$pdf = new Zend_Pdf();
$page1 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
$page2 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
// Seite erstellt, aber nicht in der Seitenliste hinzugefügt
$page3 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4);
$pdf->pages[] = $page1;
$pdf->pages[] = $page2;
$action1 = Zend_Pdf_Action_GoTo::create(
Zend_Pdf_Destination_Fit::create($page2));
$action2 = Zend_Pdf_Action_GoTo::create(
Zend_Pdf_Destination_Fit::create($page3));
$action3 = Zend_Pdf_Action_GoTo::create(
Zend_Pdf_Destination_Named::create('Chapter1'));
$action4 = Zend_Pdf_Action_GoTo::create(
Zend_Pdf_Destination_Named::create('Chapter5'));
$action2->next[] = $action3;
$action2->next[] = $action4;
$action1->next[] = $action2;
$actionsCount = 1; // Achtung! Iteration enthält nicht die oberste Aktion und
// Arbeitet sich nur durch die Kinder
$iterator = new RecursiveIteratorIterator(
$action1,
RecursiveIteratorIterator::SELF_FIRST);
foreach ($iterator as $chainedAction) {
$actionsCount++;
}
// Ausgabe 'Aktionen im Baum: 4'
printf("Aktionen im Baum: %d\n", $actionsCount++);
]]></programlisting>
</sect3>
<sect3 id="zend.pdf.pages.interactive-features.actions.open-action">
<title>Dokument Öffnen Aktion</title>
<para>
Eine spezielle Öffnen Aktion kann durch ein Ziel spezifiziert werden das angezeigt
werden soll, oder eine Aktion die ausgeführt werden soll wenn das Dokument geöffnet
wird.
</para>
<para>
Die <methodname>Zend_Pdf_Target Zend_Pdf::getOpenAction()</methodname> Methode gibt
die aktuelle Dokument Öffnen Aktion zurück (oder <constant>NULL</constant> wenn die
Öffnen Aktion nicht gesetzt ist).
</para>
<para>
Die <methodname>setOpenAction(Zend_Pdf_Target $openAction = null)</methodname>
Methode setzt eine Dokument Öffnen Aktion oder löscht diese wenn
<varname>$openAction</varname> <constant>NULL</constant> ist.
</para>
</sect3>
</sect2>
<sect2 id="zend.pdf.pages.interactive-features.outlines">
<title>Dokument Outline (Bookmarks)</title>
<para>
Ein PDF Dokument kann optional ein Dokument Outline am Schirm anzeigen, welcher es dem
Benutzer erlaubt interaktiv von einem Teil des Dokuments zu einem anderen zu navigieren.
Der Outline besteht aus einer baum-strukturierten Hierarchie von Outline Elementen
(manchmal Bookmarks genannt), welche als visuelle Tabelle des Inhalts fungieren um dem
Benutzer die Struktur des Dokuments anzuzeigen. Der Benutzer kann individuelle Elemente
interaktiv öffnen und schließen indem er Sie mit der Maus anklickt. Wenn ein Element
geöffnet ist, werden seine unmittelbaren Kinder in der Hierarchie auf dem Schirm
sichtbar; jedes Kind kann seinerseits geöffnet und geschlossen werden, das weitere Teile
der Hierarchie selektiv anzeigt oder versteckt. Wenn ein Element geschlossen wird,
werden alle seine abhängigen Elemente in der Hierarchie versteckt. Das Klicken auf einen
Text von irgendeinem sichtbaren Element aktiviert dieses Element, was dazu führt das die
anzeigende Anwendung zum Ziel springt oder eine mit dem Element assoziierte Aktion
ausführt.
</para>
<para>
Die Klasse <classname>Zend_Pdf</classname> bietet eine öffentliche Eigenschaft
<varname>$outlines</varname> welche ein Array von
<classname>Zend_Pdf_Outline</classname> Objekten ist.
</para>
<programlisting language="php"><![CDATA[
$pdf = Zend_Pdf::load($path);
// Entfernt ein Outline Element
unset($pdf->outlines[0]->childOutlines[1]);
// Setzt Outline damit es Dick angezeigt wird
$pdf->outlines[0]->childOutlines[3]->setIsBold(true);
// Fügt den Outline Eintrag hinzu
$pdf->outlines[0]->childOutlines[5]->childOutlines[] =
Zend_Pdf_Outline::create('Chapter 2', 'chapter_2');
$pdf->save($path, true);
]]></programlisting>
<para>
Outline Attribute können mit Hilfe der folgenden Methoden empfangen oder gesetzt werden:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>string getTitle()</methodname> - holt den Titel des Outline
Elements.
</para>
</listitem>
<listitem>
<para>
<methodname>setTitle(string $title)</methodname> - setzt den Titel des Outline
Elements.
</para>
</listitem>
<listitem>
<para>
<methodname>boolean isOpen()</methodname> - <constant>TRUE</constant> wenn
Outline standardmäßig geöffnet ist.
</para>
</listitem>
<listitem>
<para>
<methodname>setIsOpen(boolean $isOpen)</methodname> - setzt den isOpen Status.
</para>
</listitem>
<listitem>
<para>
<methodname>boolean isItalic()</methodname> - <constant>TRUE</constant> wenn
das Outline Element schräg dargestellt wird.
</para>
</listitem>
<listitem>
<para>
<methodname>setIsItalic(boolean $isItalic)</methodname> - setzt den isItalic
Status.
</para>
</listitem>
<listitem>
<para>
<methodname>boolean isBold()</methodname> - <constant>TRUE</constant> wenn das
Outline Element dick dargestellt wird.
</para>
</listitem>
<listitem>
<para>
<methodname>setIsBold(boolean $isBold)</methodname> - setzt den isBold Status.
</para>
</listitem>
<listitem>
<para>
<methodname>Zend_Pdf_Color_Rgb getColor()</methodname> - holt die Outline Text
Farbe (<constant>NULL</constant> bedeutet schwarz).
</para>
</listitem>
<listitem>
<para>
<methodname>setColor(Zend_Pdf_Color_Rgb $color)</methodname> - setzt die Outline
Text Farbe (<constant>NULL</constant> bedeutet schwarz).
</para>
</listitem>
<listitem>
<para>
<methodname>Zend_Pdf_Target getTarget()</methodname> - holt das Outline Ziel
(eine Aktion oder ein benanntes Zielobjekt).
</para>
</listitem>
<listitem>
<para>
<methodname>setTarget(Zend_Pdf_Target|string $target)</methodname> - setzt ein
Outline Ziel (Aktion oder Ziel). Ein String kann verwendet werden um ein
benanntes Ziel zu identifizieren. <constant>NULL</constant> bedeutet
'kein Ziel'.
</para>
</listitem>
<listitem>
<para>
<methodname>array getOptions()</methodname> - holt die Outline Attribute als
Array.
</para>
</listitem>
<listitem>
<para>
<methodname>setOptions(array $options)</methodname> - setzt Outline Optionen.
Die folgenden Optionen werden erkannt: 'title', 'open', 'color', 'italic',
'bold', und 'target'.
</para>
</listitem>
</itemizedlist>
<para>
Ein neues Outline kann auf folgenden zwei Wegen erstellt werden:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target|string
$target])</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>Zend_Pdf_Outline::create(array $options)</methodname>
</para>
</listitem>
</itemizedlist>
<para>
Jedes Outline Objekt kann Kinder-Outline Elemente haben die in der öffentlichen
Eigenschaft <varname>Zend_Pdf_Outline::$childOutlines</varname> aufgelistet werden. Das
ist ein Array von <classname>Zend_Pdf_Outline</classname> Objekten. Deshalb sind
Outlines als Baum organisiert.
</para>
<para>
Die Klasse <classname>Zend_Pdf_Outline</classname> implementiert das RecursiveArray
Interface damit man durch Kinder-Outlines rekursiv iterieren kann indem
RecursiveIteratorIterator verwendet wird:
</para>
<programlisting language="php"><![CDATA[
$pdf = Zend_Pdf::load($path);
foreach ($pdf->outlines as $documentRootOutlineEntry) {
$iterator = new RecursiveIteratorIterator(
$documentRootOutlineEntry,
RecursiveIteratorIterator::SELF_FIRST
);
foreach ($iterator as $childOutlineItem) {
$OutlineItemTarget = $childOutlineItem->getTarget();
if ($OutlineItemTarget instanceof Zend_Pdf_Destination) {
if ($pdf->resolveDestination($OutlineItemTarget) === null) {
// Markiert ein Outline Element dessen Ziel
// nicht auflösbar ist mit Roter Farbe
$childOutlineItem->setColor(new Zend_Pdf_Color_Rgb(1, 0, 0));
}
} else if ($OutlineItemTarget instanceof Zend_Pdf_Action_GoTo) {
$OutlineItemTarget->setDestination();
if ($pdf->resolveDestination($OutlineItemTarget) === null) {
// Markiert ein Outline Element dessen Ziel
// nicht auflösbar ist mit Roter Farbe
$childOutlineItem->setColor(new Zend_Pdf_Color_Rgb(1, 0, 0));
}
}
}
}
$pdf->save($path, true);
]]></programlisting>
<note>
<para>
Alle Outline Elemente mit unlösbaren Zielen (oder Zielen auf GoTo Aktionen) werden
aktualisiert während das dokument gespeichert wird, indem dessen Ziele auf
<constant>NULL</constant> gesetzt werden. Damit wird das Dokument nicht durch
Entfernen von Seiten korrupiert auf die durch Outlines referenziert wird.
</para>
</note>
</sect2>
<sect2 id="zend.pdf.pages.interactive-features.annotations">
<title>Anhänge</title>
<para>
Ein Anhang assoziiert ein Objekt wie eine Notiz, einen Sound, oder einen Film mit einem
Ort auf einer Seite in einem PDF Dokument, oder bietet einen Weg um mit dem Benutzer zu
interagieren, durch Verwendung von Maus und Tastatur.
</para>
<para>
Alle Anhänge werden durch die abstrakte Klasse
<classname>Zend_Pdf_Annotation</classname> repräsentiert.
</para>
<para>
Anhänge können einer Seite angehängt werden indem die Methode
<methodname>Zend_Pdf_Page::attachAnnotation(Zend_Pdf_Annotation
$annotation)</methodname> verwendet wird.
</para>
<para>
Aktuell können drei Typen von Anhängen von Benutzern erstellt werden:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>Zend_Pdf_Annotation_Link::create($x1, $y1, $x2, $y2,
$target)</methodname> wobei <varname>$target</varname> ein Aktionsobjekt
oder ein Ziel oder ein String ist (welche für ein benanntes Zielobjekt
verwendet werden kann).
</para>
</listitem>
<listitem>
<para>
<methodname>Zend_Pdf_Annotation_Text::create($x1, $y1, $x2, $y2,
$text)</methodname>
</para>
</listitem>
<listitem>
<para>
<methodname>Zend_Pdf_Annotation_FileAttachment::create($x1, $y1, $x2, $y2,
$fileSpecification)</methodname>
</para>
</listitem>
</itemizedlist>
<para>
Ein Link-Anhang repräsentiert entweder einen Hypertext Link oder ein Ziel anderswo im
Dokument oder eine Aktion die ausgeführt werden soll.
</para>
<para>
Ein Text Anhang repräsentiert eine "schnelle Notiz" die an einem Punkt im PDF Dokument
angehängt ist.
</para>
<para>
Ein File Anhang enthält eine Referenz zu einer Datei.
</para>
<para>
Die folgenden Methoden können von allen Typen von Anhängen verwendet werden:
</para>
<itemizedlist>
<listitem><para><methodname>setLeft(float $left)</methodname></para></listitem>
<listitem><para><methodname>float getLeft()</methodname></para></listitem>
<listitem><para><methodname>setRight(float $right)</methodname></para></listitem>
<listitem><para><methodname>float getRight()</methodname></para></listitem>
<listitem><para><methodname>setTop(float $top)</methodname></para></listitem>
<listitem><para><methodname>float getTop()</methodname></para></listitem>
<listitem><para><methodname>setBottom(float $bottom)</methodname></para></listitem>
<listitem><para><methodname>float getBottom()</methodname></para></listitem>
<listitem><para><methodname>setText(string $text)</methodname></para></listitem>
<listitem><para><methodname>string getText()</methodname></para></listitem>
</itemizedlist>
<para>
Die Text Anhang Eigenschaft ist ein Text der für den Anhang dargestellt wird oder, wenn
dieser Typ von Anhang keinen Text darstellt, eine alternative Beschreibung des
Inhalts des Anhangs in einer menschlich lesbaren Form.
</para>
<para>
Link Anhangs Objekte bieten auch zwei zusätzliche Methoden:
</para>
<itemizedlist>
<listitem>
<para><methodname>setDestination(Zend_Pdf_Target|string $target)</methodname></para>
</listitem>
<listitem>
<para><methodname>Zend_Pdf_Target getDestination()</methodname></para>
</listitem>
</itemizedlist>
</sect2>
</sect1>
|