Platzhalterersetzung (Templates)
Inhalt
[
Verbergen
]
Schnittstelle IPluginTemplateReplacer
Verwendungsmöglichkeiten
Eine Implementierung der Schnittstelle IPluginTemplateReplacer ermöglicht es, eigene Ersetzungslogik für den Ersetzungsprozess von Template-Platzhaltern zu integrieren. Templates können unter dem Menüpunkt Dateien & Templates für die Typen HTML, Text, E-Mail und Link definiert werden.
Die eigenen Implementierungen werden dabei vor dem internen Platzhaltersetzungsprozess von Xima® Formcycle durchgeführt.
Bei der Platzhalterersetzung wird nach folgendem Muster gesucht und durch das entsprechende Template ersetzt:
[%$$<Eigener Platzhalterbezeichner oder Name eines Templates>%]
Methodensignaturen
Die Plugin-Schnittstelle IPluginTemplateReplacer referenziert alle durch die Basis-Schnittstelle IFCPlugin bereitgestellten Methoden
und zusätzlich noch folgende Plugin-spezifische Methodensignaturen:
IPluginTemplateReplacerRetVal replace(IPluginTemplateReplacerParams params) throws FCPluginException
Übergabewert:
Der Typ IPluginTemplateReplacerParams stellt den Zugriff auf folgende Eigenschaften bereit:
- getPlaceholder() kompletten String des Platzhalters (dies schließt den Markup des Platzhalters mit ein)
- getPlaceholderContent() Inhalt des Platzhalters (ohne typ-spezifischen Markup)
- getEntityContext() aktueller Nutzerkontext, um beispielsweise Datenbankoperationen ausführen zu können
- getMandant() aktueller Mandant, in dessen Anwendungsbereich der TemplateReplacer ausgeführt wird