ch.elexis.util
Interface IKonsExtension

All Known Implementing Classes:

XrefExtension

Deprecated. use IRangeRenderer and SSDRange

public interface IKonsExtension

Erweiterung für Konsultationseinträge. Wird vom Extensionpoint KonsExtensions benötigt Eine KonsExtension kann Textstellen umformatieren, kann Hyperlinks einfügen und kann Einträge für das Popup-Menu der Konsultationsanzeige definieren. Die IKonsExtension wird zunächst beim Analysieren der KonsExtension mit connect() initialisiert. Dann wird sie beim Rendern des Texts im KonsDetailView für jedes von ihr deklarierte xref-tag einmal aufgerufen (doLayout). Sie kann da "true" zurückgeben um anzuzeigen, dass sie auf Mausklicks reagieren will, oder false, wenn es nur um Layout ohne Klickaktivität geht. Falls sie auf doLayout "true" zurückgegeben hat, wird sie immer dann via doXref aufgerufe, wenn der Benutzer den von ihr gesetzten Link anklickt. Schliesslich wird die IKonsExtension immer dann aufgerufen, wenn der Anwender das Kontext- menu des Textfelds anzeigen will (rechte Maustaste). Wenn getAction eine IAction zurückliefert, dann wird diese ins Kontextmenu eingebunden. Wenn getAction null zurückliefert, erfolgt keine Veränderung des Kontxtmenüs. Referenzimplementation: ch.elexis.privatnotizen

Author:

gerry

Method Summary

java.lang.String	connect(IRichTextDisplay tf) Deprecated. diese KonsExtension mit einem EnhancedTextField verknüpfen
boolean	doLayout(StyleRange styleRange, java.lang.String provider, java.lang.String id) Deprecated. Einen Querverweis für die Darstellung layouten
boolean	doXRef(java.lang.String refProvider, java.lang.String refID) Deprecated. Aktion für einen Querverweis auslösen (wurde angeklickt)
IAction[]	getActions() Deprecated. Actions für diese Extension holen. z.B. für Kontextmenu
void	insert(java.lang.Object o, int pos) Deprecated. Ein Object wurde eingefügt, z.B. mit drag&drop
void	removeXRef(java.lang.String refProvider, java.lang.String refID) Deprecated. Anwender hat eine XRef gelöscht -> ggf. damit verbundene Daten müssen jetzt entfernt werden

Method Detail

connect

java.lang.String connect(IRichTextDisplay tf)

Deprecated.

diese KonsExtension mit einem EnhancedTextField verknüpfen

Parameters:

tf - das TextField, an das diese Extension gebunden wird

Returns:

einen Namen, der diese Extension eindeutig identifiziert

doLayout

boolean doLayout(StyleRange styleRange,
                 java.lang.String provider,
                 java.lang.String id)

Deprecated.

Einen Querverweis für die Darstellung layouten

Parameters:

styleRange - eine StyleRange zum beliebig bearbeiten. Kann NULL sein.

provider - den Provider-String, den diese IKonsExtension dem Extension-Point angegeben hat

id - die ID, die die IKonsExtension dieser Textstelle zugewiesen hat

Returns:

true wenn der Text auch als Hyperlink funktionieren soll. styleRange.length muss dann >0 sein.

doXRef

boolean doXRef(java.lang.String refProvider,
               java.lang.String refID)

Deprecated.

Aktion für einen Querverweis auslösen (wurde angeklickt)

Parameters:

refProvider - Provider-String

refID - ID für die angeklickte Textstelle

Returns:

false wenn bei der Aktion ein Fehler auftrat

getActions

IAction[] getActions()

Deprecated.

Actions für diese Extension holen. z.B. für Kontextmenu

insert

void insert(java.lang.Object o,
            int pos)

Deprecated.

Ein Object wurde eingefügt, z.B. mit drag&drop

Parameters:

o - eingefügtes Object

removeXRef

void removeXRef(java.lang.String refProvider,
                java.lang.String refID)

Deprecated.

Anwender hat eine XRef gelöscht -> ggf. damit verbundene Daten müssen jetzt entfernt werden