BinaryInformation (Objekt): Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
| (10 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
| Zeile 7: | Zeile 7: | ||
;Folgende Dateiformate besitzen erweiterte BinaryInformation-Objekte: | ;Folgende Dateiformate besitzen erweiterte BinaryInformation-Objekte: | ||
* [[ImageInformation]] | * [[ImageInformation]] | ||
| − | |||
* [[SwfInformation]] | * [[SwfInformation]] | ||
| Zeile 24: | Zeile 23: | ||
| Variablenname des Objektes | | Variablenname des Objektes | ||
| 1 | | 1 | ||
| + | |- | ||
| + | | lastField | ||
| + | | [[String]] | ||
| + | | Variablenname des Objektes ohne Struktur-Daten | ||
| + | | 2.13 | ||
|- | |- | ||
| root | | root | ||
| [[Element]] | | [[Element]] | ||
| Root-Element dieser Information | | Root-Element dieser Information | ||
| + | | 1 | ||
| + | |- | ||
| + | | parent | ||
| + | | [[ID]] | ||
| + | | ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein | ||
| 1 | | 1 | ||
|- | |- | ||
| Zeile 44: | Zeile 53: | ||
| ID, unter der die Bilddaten selbst erreichbar sind | | ID, unter der die Bilddaten selbst erreichbar sind | ||
| 1 | | 1 | ||
| + | |- | ||
| + | | binary.media | ||
| + | | [[BinDBMedia]] | ||
| + | | Medien-Objekt der [BinDB] | ||
| + | | 2.22 | ||
| + | |- | ||
| + | | binDBMedia | ||
| + | | [[BinDBMedia]] | ||
| + | | Entspricht <code>binary.media</code> wenn der Artikel noch nicht gepeichert ist (Edit-Moduls, Preview) | ||
| + | | 2.22 | ||
|- | |- | ||
| filename | | filename | ||
| Zeile 71: | Zeile 90: | ||
|} | |} | ||
| + | ==Methoden== | ||
| + | {| class="prettytable sortable" | ||
| + | |- class="hintergrundfarbe1" | ||
| + | ! Methode || Rückgabewert || Beschreibung || ab IES Version | ||
| + | |- | ||
| + | | <code>reader([[String]] charsetName)</code> | ||
| + | | Reader | ||
| + | | Liefert einen Reader auf die Binärdaten zurück. Dieser kann z.B. mit sp:print verwendet werden, um Text-Binäredaten (z.B. CSS) selbst im Template auszugeben. Default-Encoding ist UTF-8. | ||
| + | | 2.5.4 | ||
| + | |- | ||
| + | | <code>stream()</code> | ||
| + | | Reader | ||
| + | | Liefert einen Stream auf die Binärdaten zurück. Dieser kann z.B. mit sp:print und encoding="base64" verwendet werden um Bilder direkt Inline in HTML auszugeben. | ||
| + | | 2.5.5 | ||
| + | |- | ||
| + | | <code>toXip([[Boolean]] emptyFields)</code> | ||
| + | | String | ||
| + | | Erzeugt XML-Daten im XIP-Format für dieses Objekt | ||
| + | | 2.14 | ||
| + | |} | ||
| + | |||
| + | ;<code>[[String]] reader([[String]] charsetName)</code> | ||
| + | :Liefert einen Reader auf die Binärdaten zurück. (Beispiel: <sp:print name="!{css.upload}.media.binary.reader('utf-8')"/>) | ||
| + | :;Parameter | ||
| + | ::;<code>String charsetName</code> (Optional) | ||
| + | :::Charset mit dem die Binärdaten interpretiert werden sollen. Dieser Parameter ist Optional. Wird dieser Parameter nicht angegeben, wird UTF-8 verwendet. | ||
| + | :;Rückgabewert | ||
| + | ::;Reader | ||
| + | :::Reader der Text-Binärdaten. | ||
| + | ;<code>Bytes stream()</code> | ||
| + | :Liefert einen Stream auf die Binärdaten zurück. (Beispiel: <sp:print name="!{image.upload}.media.binary.stream()" encoding="base64"/>) | ||
| + | ;Rückgabewert | ||
| + | :;Stream | ||
| + | ::Stream der Binärdaten. | ||
<noinclude> | <noinclude> | ||
| + | |||
| + | ;<code>[[String]] toXip([[Boolean]] emptyFields)</code> | ||
| + | :Erzeugt XML-Daten im XIP-Format für dieses Objekt. | ||
| + | :;Parameter | ||
| + | ::;<code>Boolean emptyFields</code> | ||
| + | :::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true). | ||
| + | :;Rückgabewert | ||
| + | ::;String | ||
| + | :::XML-Daten im XIP-Format | ||
| + | |||
[[Category:Objekte]] | [[Category:Objekte]] | ||
</noinclude> | </noinclude> | ||
Aktuelle Version vom 12. Februar 2021, 07:01 Uhr
Name
BinaryInformation - Binärdaten
Beschreibung
Ein BinaryInformation-Objekt repräsentiert binären Content. Dies sind im Regelfall Dateien wie PDF, DOC, .... Handelt es sich um Textdateien, werden diese auch als Binärdaten behandelt. Für einige Dateiformate gibt es spezialisierte Erweiterungen dieses Objekts.
- Folgende Dateiformate besitzen erweiterte BinaryInformation-Objekte
Attribute
| Attribut | Type | Beschreibung | ab IES Version |
|---|---|---|---|
| id | ID | ID des Objektes | 1 |
| field | String | Variablenname des Objektes | 1 |
| lastField | String | Variablenname des Objektes ohne Struktur-Daten | 2.13 |
| root | Element | Root-Element dieser Information | 1 |
| parent | ID | ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein | 1 |
| locale | Locale | Sprache, für die die Information gilt | 1 |
| isEmpty | Boolean | true, wenn die Größe der Binäredaten 0 ist
|
1 |
| binary | ID | ID, unter der die Bilddaten selbst erreichbar sind | 1 |
| binary.media | BinDBMedia | Medien-Objekt der [BinDB] | 2.22 |
| binDBMedia | BinDBMedia | Entspricht binary.media wenn der Artikel noch nicht gepeichert ist (Edit-Moduls, Preview)
|
2.22 |
| filename | String | Dateiname des Bildes | 1 |
| filesize | Number | Dateigröße in Bytes | 1 |
| format | String | Binärformat (pdf, doc, ...) | 1 |
| mime | String | MIME-Typ (application/pdf, application/msword, ...)
|
1 |
| isImage | Boolean | Liefert immer false
|
1 |
Methoden
| Methode | Rückgabewert | Beschreibung | ab IES Version |
|---|---|---|---|
reader(String charsetName)
|
Reader | Liefert einen Reader auf die Binärdaten zurück. Dieser kann z.B. mit sp:print verwendet werden, um Text-Binäredaten (z.B. CSS) selbst im Template auszugeben. Default-Encoding ist UTF-8. | 2.5.4 |
stream()
|
Reader | Liefert einen Stream auf die Binärdaten zurück. Dieser kann z.B. mit sp:print und encoding="base64" verwendet werden um Bilder direkt Inline in HTML auszugeben. | 2.5.5 |
toXip(Boolean emptyFields)
|
String | Erzeugt XML-Daten im XIP-Format für dieses Objekt | 2.14 |
String reader(String charsetName)- Liefert einen Reader auf die Binärdaten zurück. (Beispiel: <sp:print name="!{css.upload}.media.binary.reader('utf-8')"/>)
- Parameter
-
String charsetName(Optional)- Charset mit dem die Binärdaten interpretiert werden sollen. Dieser Parameter ist Optional. Wird dieser Parameter nicht angegeben, wird UTF-8 verwendet.
- Rückgabewert
-
- Reader
- Reader der Text-Binärdaten.
Bytes stream()- Liefert einen Stream auf die Binärdaten zurück. (Beispiel: <sp:print name="!{image.upload}.media.binary.stream()" encoding="base64"/>)
- Rückgabewert
-
- Stream
- Stream der Binärdaten.