CalendarSheet (SP-Tag): Unterschied zwischen den Versionen
Sed (Diskussion | Beiträge) |
Sed (Diskussion | Beiträge) |
||
(10 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
==Name== | ==Name== | ||
− | <sp:calendarsheet> - CalendarSheet-Tag | + | <sp:calendarsheet> - CalendarSheet-Tag zur Verwaltung eines [[CalendarSheet]]-Objektes |
==Syntax== | ==Syntax== | ||
Zeile 8: | Zeile 8: | ||
==Beschreibung== | ==Beschreibung== | ||
− | Dieser Tag legt ein CalendarSheet-Objekt an und liefert Funktionen zum Befüllen. | + | Dieser Tag legt ein [[CalendarSheet]]-Objekt an und liefert Funktionen zum Befüllen. Ein [[CalendarSheet]] ist ein Object, welches [[Date|Daten]] für einen bestimmten Zeitraum sammeln und nach Tagen gruppieren kann. Dies erlaubt die einfache und effiziente Auswertung aller Termine, die in den definierten Zeitraum fallen. |
+ | |||
+ | Ein praktisches Beispiel ist z.B. die Jahres oder Monatsansicht eines Kalenders. Eine Suchabfrage kann alle Termine innerhalb des gewünschten Monats ermitteln. Über CalendarSheet-Tag wird dann für diesen Zeitraum ein entsprechendes Objekt angelegt. In einer Schleife über alle Treffer der Suchabfrage können diese in das [[CalendarSheet]] übertragen werden. Die Auswertung des [[CalendarSheet|CalendarSheets]] erfolgt dann einfach über eine Loop über alle Tage des genannten Zeitraums. Es braucht nicht jeder Tag über eine einzelne Suchabfrage ausgewertet werden. | ||
==Attribute== | ==Attribute== | ||
− | {| class="prettytable" | + | {| class="prettytable sortable" |
|- class="hintergrundfarbe1" | |- class="hintergrundfarbe1" | ||
! Name || Type || Required || Default || ab IES Version | ! Name || Type || Required || Default || ab IES Version | ||
Zeile 56: | Zeile 58: | ||
| None | | None | ||
| 2 | | 2 | ||
+ | |- | ||
+ | | <code>mode</code> | ||
+ | | [[Text]] | ||
+ | | Nein | ||
+ | | allDays | ||
+ | | 2.0.4 | ||
|- | |- | ||
| <code>scope</code> | | <code>scope</code> | ||
Zeile 65: | Zeile 73: | ||
;<code>name</code> | ;<code>name</code> | ||
− | :Name über das | + | :Name über den das [[CalendarSheet]] angesprochen werden kann. |
;<code>action</code> | ;<code>action</code> | ||
− | :Aktion, die ausgeführt werden soll. Es existieren die Aktionen add, clear und new. | + | :Aktion, die ausgeführt werden soll. Es existieren die Aktionen <code>add</code>, <code>clear</code> und <code>new</code>. |
;<code>value</code> | ;<code>value</code> | ||
− | :Zu setzendes [[ | + | :Zu setzendes [[CalendarInformation]]-Objekt. Dieser wird immer als Zeichenkette ausgewertet. Das Element, zu dem das [[CalendarInformation]] gehört (<code>root</code>) wird automatisch als Referenz verwendet. |
;<code>object</code> | ;<code>object</code> | ||
− | :Evaluiert das Attribut und setzt das entsprechende [[ | + | :Evaluiert das Attribut und setzt das entsprechende [[CalendarInformation]]-Objekt. Im Gegensatz zu <code>value</code> wird hier das Objekt direkt erwartet und nicht der Text. Das Element, zu dem das [[CalendarInformation]] gehört (<code>root</code>) wird automatisch als Referenz verwendet. |
;<code>date</code> | ;<code>date</code> | ||
− | :Zu setzender Wert. Hiermit kann direkt ein einzelnes [[Date|Datum]] angegeben werden. | + | :Zu setzender Wert. Hiermit kann direkt ein einzelnes [[Date|Datum]] angegeben werden. Über die Attribute <code>value</code> bzw. <code>object</code> kann die zugehörige Referenz angegeben werden. |
;<code>from</code> | ;<code>from</code> | ||
Zeile 84: | Zeile 92: | ||
;<code>to</code> | ;<code>to</code> | ||
:Über diesen Parameter wird der zeitliche Rahmen des CalendarSheets festgelegt. | :Über diesen Parameter wird der zeitliche Rahmen des CalendarSheets festgelegt. | ||
+ | |||
+ | ;<code>mode</code> | ||
+ | :Über diesen Parameter wird Modus angegeben, mit dem ein Termin eingefügt werden soll. Gültige Werte sind: <code>allDays</code> (alle Tage einfügen), <code>startDays</code> (nur den Start-Tag, sofern dieser innerhalb des angegebenen Zeitraums liegt einfügen) und <code>firstDays</code> (den ersten gültigen Tag einfügen) | ||
;<code>scope</code> | ;<code>scope</code> | ||
Zeile 101: | Zeile 112: | ||
CalendarSheet ausgeben | CalendarSheet ausgeben | ||
<source lang="text"> | <source lang="text"> | ||
− | <sp:loop collection=" | + | <sp:loop collection="_cal.entries.keys" item="day"> |
<sp:sort name="_events" collection="_cal.entries(${day.reference})" keys="name" sequences="asc" types="text"/> | <sp:sort name="_events" collection="_cal.entries(${day.reference})" keys="name" sequences="asc" types="text"/> | ||
<sp:loop collection="_events" item="it"> | <sp:loop collection="_events" item="it"> | ||
− | <tt><sp:print name="it. | + | <tt><sp:print name="it.sp_date"/></tt> <sp:print name="it.name"/><br> |
</sp:loop> | </sp:loop> | ||
</sp:loop> | </sp:loop> |
Aktuelle Version vom 26. März 2009, 09:38 Uhr
Name
<sp:calendarsheet> - CalendarSheet-Tag zur Verwaltung eines CalendarSheet-Objektes
Syntax
<sp:calendarsheet name="variable" action="new" from="" to=""/>
Beschreibung
Dieser Tag legt ein CalendarSheet-Objekt an und liefert Funktionen zum Befüllen. Ein CalendarSheet ist ein Object, welches Daten für einen bestimmten Zeitraum sammeln und nach Tagen gruppieren kann. Dies erlaubt die einfache und effiziente Auswertung aller Termine, die in den definierten Zeitraum fallen.
Ein praktisches Beispiel ist z.B. die Jahres oder Monatsansicht eines Kalenders. Eine Suchabfrage kann alle Termine innerhalb des gewünschten Monats ermitteln. Über CalendarSheet-Tag wird dann für diesen Zeitraum ein entsprechendes Objekt angelegt. In einer Schleife über alle Treffer der Suchabfrage können diese in das CalendarSheet übertragen werden. Die Auswertung des CalendarSheets erfolgt dann einfach über eine Loop über alle Tage des genannten Zeitraums. Es braucht nicht jeder Tag über eine einzelne Suchabfrage ausgewertet werden.
Attribute
Name | Type | Required | Default | ab IES Version |
---|---|---|---|---|
name
|
Attribute | Ja | None | 2 |
action
|
Text | Ja | None | 2 |
value
|
Text | Ja oder object bzw. date | None | 2 |
object
|
Object | Ja oder value bzw. date | None | 2 |
date
|
Date | Ja oder object bzw. value | None | 2 |
from
|
Date | Ja | None | 2 |
to
|
Date | Ja | None | 2 |
mode
|
Text | Nein | allDays | 2.0.4 |
scope
|
Text | Nein | None | 2 |
name
- Name über den das CalendarSheet angesprochen werden kann.
action
- Aktion, die ausgeführt werden soll. Es existieren die Aktionen
add
,clear
undnew
.
value
- Zu setzendes CalendarInformation-Objekt. Dieser wird immer als Zeichenkette ausgewertet. Das Element, zu dem das CalendarInformation gehört (
root
) wird automatisch als Referenz verwendet.
object
- Evaluiert das Attribut und setzt das entsprechende CalendarInformation-Objekt. Im Gegensatz zu
value
wird hier das Objekt direkt erwartet und nicht der Text. Das Element, zu dem das CalendarInformation gehört (root
) wird automatisch als Referenz verwendet.
date
- Zu setzender Wert. Hiermit kann direkt ein einzelnes Datum angegeben werden. Über die Attribute
value
bzw.object
kann die zugehörige Referenz angegeben werden.
from
- Über diesen Parameter wird der zeitliche Rahmen des CalendarSheets festgelegt.
to
- Über diesen Parameter wird der zeitliche Rahmen des CalendarSheets festgelegt.
mode
- Über diesen Parameter wird Modus angegeben, mit dem ein Termin eingefügt werden soll. Gültige Werte sind:
allDays
(alle Tage einfügen),startDays
(nur den Start-Tag, sofern dieser innerhalb des angegebenen Zeitraums liegt einfügen) undfirstDays
(den ersten gültigen Tag einfügen)
scope
- Namensraum, in dem die Variable definiert ist. Für diesen Tag ist der Page- und Request-Scope möglich (
page
,request
).
Beispiele
CalendarSheet aufbauen
<%-- Übertragung aller Ergebnisse in das CalendarSheet --%>
<sp:calendarsheet name="_cal" action="new" from="${_from}" to="${_to}"/>
<sp:loop collection="_result" item="it">
<sp:calendarsheet name="_cal" action="add" object="it.sp_date"/>
</sp:loop>
CalendarSheet ausgeben
<sp:loop collection="_cal.entries.keys" item="day">
<sp:sort name="_events" collection="_cal.entries(${day.reference})" keys="name" sequences="asc" types="text"/>
<sp:loop collection="_events" item="it">
<tt><sp:print name="it.sp_date"/></tt> <sp:print name="it.name"/><br>
</sp:loop>
</sp:loop>