Package de.elo.client.scripting.constants

Interface ScriptEvents

public interface ScriptEvents

Überschrift: ScriptEvents.

Beschreibung: Ein ScriptEvent ist eine Konstante, welche bezeichnet, an welcher Stelle im Programmablauf des Client eine Script-Funktion mit welchen Parametern gestartet wird.

Copyright: Copyright (c) ELO Digital Office GmbH 2006-2019

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ScriptEvents.SimpleScriptEvent	Die einfachen Skript-Events haben keine Parameter.

Method Summary

Modifier and Type	Method	Description
void	eloAddNoteEnd(Note note)	Nach dem Hinzufügen einer neuen Notiz.
int	eloAddNoteStart(Note note)	Vor dem Hinzufügen einer neuen Notiz.
void	eloBarcodeRecognized(String barcode)	Beim Scannen eines Barcodes mit einem HID Barcode Scanner.
void	eloBasicKeywordingObjKeyEnter(int lineId, KeywordingAdapter adapter)	Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus bekommen.
void	eloBasicKeywordingObjKeyExit(int lineId, KeywordingAdapter adapter)	Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus verloren.
int	eloBeforeConvertToPdf(File documentFile, File tempPdfFile)	Vor dem Konvertieren eines Dokumentes nach PDF.
void	eloBroadcast(int fromWorkspace, String tag, String message)	Event wenn ein Skript ein Broadcast verschickt hat.
void	eloBuildVersionNumber(VersionInfo info)	Neue Versionsnummer beim CheckIn ermitteln
void	eloCheckinDocumentEnd(ArchiveDocument document)	Nach dem Einchecken eines ausgecheckten Dokuments
int	eloCheckinDocumentStart(CheckoutDocument document)	Vor dem Einchecken eines ausgecheckten Archivdokuments.
int	eloCheckoutDocumentAvailable(int docId, File docFile)	Event wenn ein neues Checkout Dokument zur Bearbeitung zur Verfügung steht.
void	eloCollectListEnd(int id, Sord[] items)	Nach dem Einfügen in die Liste.
void	eloCollectListStart(int id, Sord[] items)	Vor dem Einfügen in die Liste.
int	eloDocVersionsCompareStart(DocVersionsDialogAdapter docVersionsDialog)	Bei Klick auf "Vergleichen" im Dialog "Dokumentversionen".
int	eloDragAndDropStart(boolean internalDnD, int targetId, ParameterScriptEvent.TargetWorkArea targetWorkArea)	Event, wenn ein Element aus einem DnD Vorgang im ELO Client gedroppt wird.
int	eloEnableFillWithLastSord(Sord currentSord, Sord lastSord, boolean hasLastSearch)	Wird aufgerufen, wenn Überprüft wird, ob die F3-Funktion im Verschlagwortungsdialog aktiviert werden soll.
int	eloFillWithLastSord(Sord currentSord, Sord lastSord, FindInfo lastSearch)	Wird aufgerufen, wenn die F3-Funktion im Verschlagwortungsdialog aufgerufen wird und die aktuelle Verschlagwortung mit der zuletzt verwendeten Verschlagwortung überschrieben werden soll.
void	eloFlowConfirmDialogObjKeyEnter(int lineId, FlowConfirmDialogAdapter adapter)	Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus bekommen.
void	eloFlowConfirmDialogObjKeyExit(int lineId, FlowConfirmDialogAdapter adapter)	Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus verloren.
void	eloFlowConfirmDialogOkStart(Sord sord)	Deprecated. Sord sollte im Event ScriptEvents.SimpleScriptEvent.FlowConfirmDialogOkStart über den FlowConfirmDialogAdapter bearbeitet werden.
String	eloGenerateExternalFilename(Sord sord, DocVersion docVersion)	Wird aufgerufen wenn ein Dokument für die externe Verwendung gespeichert wird.
int	eloIndexDialogCancelStart(IndexDialogAdapter adapter)	Nach dem Drücken der Schaltfläche "Abbrechen" im IndexDialog.
void	eloIndexDialogNameEnter(KeywordingAdapter adapter)	Name-Eingabefeld (Kurzbezeichnung) hat den Fokus bekommen.
void	eloIndexDialogNameExit(KeywordingAdapter adapter)	Name-Eingabefeld (Kurzbezeichnung) hat den Fokus verloren.
void	eloIndexDialogObjKeyEnter(int objKeyNo, IndexDialogAdapter adapter)	Ein ObjKey-Eingabefeld hat den Fokus bekommen.
void	eloIndexDialogObjKeyExit(int objKeyNo, IndexDialogAdapter adapter)	Ein ObjKey-Eingabefeld hat den Fokus verloren.
int	eloIndexDialogOkStart(IndexDialogAdapter adapter)	Nach dem Drücken der Schaltfläche "OK" im IndexDialogs.
void	eloIndexDialogSetDocMask(IndexDialogAdapter adapter)	Nach dem Setzen einer Verschlagwortungsmaske im IndexDialog.
void	eloIndexDialogXDateEnter(KeywordingAdapter adapter)	Datum-Eingabefeld hat den Fokus bekommen.
void	eloIndexDialogXDateExit(KeywordingAdapter adapter)	Datum-Eingabefeld hat den Fokus verloren.
void	eloInsertDocumentEnd(ArchiveDocument document)	Nach dem Ablegen einer Datei als neues Dokument im Archiv.
int	eloInsertDocumentStart(String mode, File file, int targetId, Sord sord)	Vor dem Ablegen einer Datei als neues Dokument im Archiv.
void	eloInsertFileInIntrayEnd(IntrayDocument intrayDocument)	Nach dem Einfügen eines externen Dokuments in die Client-Postbox.
int	eloInsertFileInIntrayStart(String intrayFileSource, File externFile)	Vor dem Einfügen eines externen Dokuments in die Client-Postbox.
void	eloInsertFolderEnd(StructureElement folder)	Nach dem Anlegen eines neuen Ordners im Archiv.
int	eloInsertFolderStart(int targetId, Sord sord, File file, String mode)	Vor dem Schreiben eines neuen Ordners im Archiv.
int	eloInsertNoteLink(LinkPosition preparedLink, int targetId, Note note)	Vor dem Anlegen einer neuen Annotation Verlinkung.
void	eloInsertObservedDocumentIntrayEnd(IntrayDocument intrayDocument)	Deprecated. Ersetzt durch eloInsertFileInIntrayEnd(IntrayDocument)
int	eloInsertObservedDocumentIntrayStart(File externalFile)	Deprecated. Ersetzt durch eloInsertFileInIntrayStart(String, File)
void	eloMoveArchiveElementEnd(String mode, ArchiveElement element, int parentId, int targetId)	Nach dem Verschieben eines Eintrags im Archiv.
int	eloMoveArchiveElementStart(String mode, ArchiveElement element, int parentId, int targetId)	Vor dem Verschieben eines Eintrags im Archiv.
void	eloNewTaskAvailable(UserTask task, boolean isSeen)	Beim automatischen Nachlagen der Aufgabenliste wurde ein neuer Eintrag gefunden.
int	eloPrepareNoteLink(LinkPosition preparedLink, Sord parentSord, Note destinationNote)	Beim "Merken" der aktuellen Annotation für eine Verlinkung An dieser Stelle wird der Link Text erzeugt und gespeichert sowie in das Windows Clipboard geschrieben.
int	eloPreviewAvailable(ParameterScriptEvent.ViewMode mode, IndexedElement indexedElement)	Event, wenn ein Element in die Vorschau geladen wird.
void	eloReceiveBrowserMessage(EventMessage browserMessage, String browserCompName, BrowserComponent browser)	Dieses Event wird nach dem Erhalt einer Nachricht aus der integrierten Java FX Browser Komponente gesendet.
void	eloReferenceArchiveElementEnd(String mode, ArchiveElement element, int parentId, int targetId)	Nach dem Referenzieren eines Eintrags im Archiv.
int	eloReferenceArchiveElementStart(String mode, ArchiveElement element, int parentId, int targetId)	Vor dem Referenzieren eines Eintrags im Archiv.
void	eloSaveNotesEnd(Note[] notes)	Nach dem Speichern der Notizen.
int	eloSaveNotesStart(Note[] notes)	Vor dem Speichern der Notizen.
void	eloSearchResultAvailable(SearchView destinationView, FindResult searchResult)	Beim Eintragen des FindResults in die Search View.
void	eloSelectionChanged(Object source)	Wird bei einer Selektionsänderung aufgerufen.
int	eloUpdateVersion(EditInfo target, File newVersionFile)	Vor dem Upload einer neuen Dokumentenversion.
void	eloVersionCheckinDialogObjKeyEnter(int lineId, DocVersionsDialogAdapter adapter)	Ein ObjKey-Eingabefeld im Version-Einchecken-Dialog hat den Fokus bekommen.
void	eloVersionCheckinDialogObjKeyExit(int lineId, DocVersionsDialogAdapter adapter)	Ein ObjKey-Eingabefeld im Version-Einchecken-Dialog hat den Fokus verloren.

Method Detail

eloBuildVersionNumber

void eloBuildVersionNumber(VersionInfo info)

Neue Versionsnummer beim CheckIn ermitteln

Parameters:

info - Typ - Verschlagwortung, kann je nach Kontext auch null sein - alte und neue Versionsnummer

Since:

10.03.000

eloSelectionChanged

void eloSelectionChanged(Object source)

Wird bei einer Selektionsänderung aufgerufen. Es kann nicht garantiert werden, dass alle Listen erfasst werden.

Parameters:

source - Event

Since:

12.00.000

eloNewTaskAvailable

void eloNewTaskAvailable(UserTask task,
                         boolean isSeen)

Beim automatischen Nachlagen der Aufgabenliste wurde ein neuer Eintrag gefunden.

Parameters:

task - Aufgabe

isSeen - True, wenn die Aufgabe bereits vom Benutzer angesehen wurde.

Since:

10.00.000

eloSearchResultAvailable

void eloSearchResultAvailable(SearchView destinationView,
                              FindResult searchResult)

Beim Eintragen des FindResults in die Search View.

Parameters:

destinationView - Ziel der Trefferliste

searchResult - Indexserver Objekt mit der Trefferliste

Since:

10.00.000

eloInsertDocumentStart

int eloInsertDocumentStart(String mode,
                           File file,
                           int targetId,
                           Sord sord)

Vor dem Ablegen einer Datei als neues Dokument im Archiv. Nach diesem Event kommen Dublettenkontrolle und (falls notwendig und konfiguriert) die "Verschlagwortung bei Bedarf".

Parameters:

mode - NORMAL: Ablage aus dem Dateisystem, z.B. per "Datei Einfügen"
DND: Ablage aus dem Dateisystem per Drag&Drop
INTRAY: Ablage einer Dokumentdatei aus der Postbox, z.B. per "Archivablage"
INTRAYDND: Ablage einer Dokumentdatei aus der Postbox per Drag&Drop
SCRIPTING: Ablage einer Dokumentdatei aus der Postbox per Internem Scripting
COMSERVER: Ablage einer Datei per Java Client COM-Server

file - Dokumentdatei, welche im Archiv abgeleget werden soll.

targetId - ObjektID des Zielordners im Archiv

sord - (since 8.05.000) Verschlagwortung der abzulegenden Datei.
Bei noch nicht vorhandener Vorbelegung ist der Parameter leer. Das Sord sollte nur lesend verwendet werden und wird bei noch nicht erfolgter Verschlagwortung oder Serienablage überschrieben.

Returns:

Bei -1 als Rückgabewert wird der Ablegevorgang abgebrochen.

Since:

8.01.000

eloInsertDocumentEnd

void eloInsertDocumentEnd(ArchiveDocument document)

Nach dem Ablegen einer Datei als neues Dokument im Archiv.

Parameters:

document - Das neu angelegte Dokument im Archiv.

Since:

8.01.000

eloInsertFolderStart

int eloInsertFolderStart(int targetId,
                         Sord sord,
                         File file,
                         String mode)

Vor dem Schreiben eines neuen Ordners im Archiv.

Parameters:

targetId - Parent-Id des neuen Ordners

sord - Verschlagwortung des neuen Ordners

mode - NORMAL: Erstellen eines Ordners, z.B. per "Neuer Ordner"
DND: Ablage aus dem Dateisystem per Drag&Drop
STDREG: Erstellen durch Funktion "Standardregister"
SCRIPTING: Erstellen eines Ordners per internem Scripting

file - Ordner, welcher im Archiv abgelegt werden soll (nur bei DND).

Returns:

Bei -1 als Rückgabewert wird der Vorgang abgebrochen

Since:

9.00.000, 9.02.000 mit zusätzlichen Parametern (mode, file)

eloInsertNoteLink

int eloInsertNoteLink(LinkPosition preparedLink,
                      int targetId,
                      Note note)

Vor dem Anlegen einer neuen Annotation Verlinkung. Hier kann der NoteText verändert werden.

Parameters:

preparedLink - Link Objekt für die Verbindung

targetId - ELO Objekt Id des Parent Dokuments

note - Note Objekt, in welches der Link eingetragen wird.

Returns:

Bei -1 als Rückgabewert wird der Vorgang abgebrochen

Since:

9.02.000

eloPrepareNoteLink

int eloPrepareNoteLink(LinkPosition preparedLink,
                       Sord parentSord,
                       Note destinationNote)

Beim "Merken" der aktuellen Annotation für eine Verlinkung An dieser Stelle wird der Link Text erzeugt und gespeichert sowie in das Windows Clipboard geschrieben.

Parameters:

preparedLink - Link Objekt für die Verbindung

parentSord - ELO Objekt Id des Parent Dokuments

destinationNote - Verlinkte Annotation.

Returns:

Bei -1 als Rückgabewert wird der Vorgang abgebrochen

Since:

9.02.000

eloInsertFolderEnd

void eloInsertFolderEnd(StructureElement folder)

Nach dem Anlegen eines neuen Ordners im Archiv.

Parameters:

folder - Der neu erzeugte Ordner.

Since:

9.00.000

eloMoveArchiveElementStart

int eloMoveArchiveElementStart(String mode,
                               ArchiveElement element,
                               int parentId,
                               int targetId)

Vor dem Verschieben eines Eintrags im Archiv.

Parameters:

mode - NORMAL: Verschieben per Funktion "Eintrag verschieben"
DND: Verschieben per Drag&Drop
UNDO: Verschieben als UNDO-Funktion
DELETE: Verschieben an Referenzposition beim Löschen
SCRIPTING: Verschieben per Internem Scripting

element - Der Archiveintrag.

parentId - Bisheriger Ordner in dem der Eintrag noch liegt.

targetId - Neuer Ordner in den der Eintrag verschoben werden soll.

Returns:

Bei -1 Rückgabewert als wird das Verschieben abgebrochen.

Since:

8.01.000

eloMoveArchiveElementEnd

void eloMoveArchiveElementEnd(String mode,
                              ArchiveElement element,
                              int parentId,
                              int targetId)

Nach dem Verschieben eines Eintrags im Archiv.

Parameters:

mode - siehe eloMoveArchiveElementStart

element - Der Archiveintrag.

parentId - Bisheriger Ordner in dem der Eintrag vorher lag.

targetId - Neuer Ordner in den der Eintrag verschoben wurde.

Since:

8.01.000

eloReferenceArchiveElementStart

int eloReferenceArchiveElementStart(String mode,
                                    ArchiveElement element,
                                    int parentId,
                                    int targetId)

Vor dem Referenzieren eines Eintrags im Archiv.

Parameters:

mode - NORMAL: Referenzieren per Funktion "Referenz erstellen"
INSERT_INTO_ARCHIVE: Referenzieren bei einer Archivablage
DND: Referenzieren per Drag&Drop
SCRIPTING: Referenzieren per internem Scripting

element - Der Eintrag, der referenziert wird

parentId - Bisheriger Ordner, in dem der Eintrag noch liegt

targetId - Neuer Ordner, in den der Eintrag referenziert werden soll

Returns:

Bei -1 als Rückgabewert wird das Referenzieren abgebrochen

Since:

8.03.000

eloReferenceArchiveElementEnd

void eloReferenceArchiveElementEnd(String mode,
                                   ArchiveElement element,
                                   int parentId,
                                   int targetId)

Nach dem Referenzieren eines Eintrags im Archiv.

Parameters:

mode - siehe eloReferenceArchiveElementStart

element - Der Archiveintrag, der referenziert wird

parentId - Bisheriger Ordner, in dem der Eintrag vorher lag

targetId - Neuer Ordner in den der Eintrag referenziert wurde

Since:

8.03.000

eloInsertObservedDocumentIntrayStart

int eloInsertObservedDocumentIntrayStart(File externalFile)

Deprecated.

Ersetzt durch eloInsertFileInIntrayStart(String, File)

Vor dem Einfügen eines Dokumentes aus einem überwachten Ordner in die Postbox.

Parameters:

externalFile - Externes Dokument, das in die Postbox eingefügt wird

Returns:

int Bei -1 als Rückgabewert wird das Einfügen abgebrochen

Since:

8.03.000

eloInsertObservedDocumentIntrayEnd

void eloInsertObservedDocumentIntrayEnd(IntrayDocument intrayDocument)

Deprecated.

Ersetzt durch eloInsertFileInIntrayEnd(IntrayDocument)

Nach dem Einfügen eines Dokumentes aus einem überwachten Ordner in die Postbox.

Parameters:

intrayDocument - Externes Dokument, das in die Postbox eingefügt wurde

Since:

8.03.000

eloInsertFileInIntrayStart

int eloInsertFileInIntrayStart(String intrayFileSource,
                               File externFile)

Vor dem Einfügen eines externen Dokuments in die Client-Postbox.

Parameters:

intrayFileSource - Quelle des externen Dokuments
OBSERVED_DIRECTORY_FILE Dokument aus einem überwachten Verzeichnis
PRINTER_DIRECTORY_FILE Dokument aus dem Druckerausgabeverzeichnis
SCANNED_FILE Vom Client gescanntes Dokument
DROPPED_EXTERN_FILE Gedropptes externes Dokument
DROPPED_ARCHIVE_FILE Gedropptes Archivdokument
FCT_INSERT_FILE Dokument von der Funktion "Datei einfügen"
FCT_NEW_DOCUMENT_FILE Dokument von der Funktion "Neues Dokument aus Vorlage"

externFile - Externes Dokument, das in die Client-Postbox eingefügt wird

Returns:

int Bei -1 als Rückgabewert wird das Einfügen abgebrochen

Since:

8.04.000

eloInsertFileInIntrayEnd

void eloInsertFileInIntrayEnd(IntrayDocument intrayDocument)

Nach dem Einfügen eines externen Dokuments in die Client-Postbox.

Parameters:

intrayDocument - Externes Dokument, das in die Postbox eingefügt wurde

Since:

8.04.000

eloIndexDialogObjKeyEnter

void eloIndexDialogObjKeyEnter(int objKeyNo,
                               IndexDialogAdapter adapter)

Ein ObjKey-Eingabefeld hat den Fokus bekommen.

Parameters:

objKeyNo - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Verschlagwortungsdialog, in welchem das Event ausgelöst wurde

Since:

7.00.000, 8.05.000 neuer Parameter objKeyNo, 12.00.000 neuer Parameter adapter

eloIndexDialogObjKeyExit

void eloIndexDialogObjKeyExit(int objKeyNo,
                              IndexDialogAdapter adapter)

Ein ObjKey-Eingabefeld hat den Fokus verloren.

Parameters:

objKeyNo - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Verschlagwortungsdialog, in welchem das Event ausgelöst wurde

Since:

7.00.000, 8.05.000 neuer Parameter objKeyNo, 12.00.000 neuer Parameter adapter

eloIndexDialogSetDocMask

void eloIndexDialogSetDocMask(IndexDialogAdapter adapter)

Nach dem Setzen einer Verschlagwortungsmaske im IndexDialog.

Parameters:

adapter - Verschlagwortungsdialog, in welchem das Event ausgelöst wurde

Since:

12.00.000 Ersetzt ScriptEvents.SimpleScriptEvent.IndexDialogSetDocMask

eloIndexDialogNameEnter

void eloIndexDialogNameEnter(KeywordingAdapter adapter)

Name-Eingabefeld (Kurzbezeichnung) hat den Fokus bekommen.

Parameters:

adapter - Verschlagwortungskomponente, in welcher das Event ausgelöst wurde

Since:

12.00.000

See Also:

ErsetztSimpleScriptEvent#IndexDialogNameEnter

eloIndexDialogNameExit

void eloIndexDialogNameExit(KeywordingAdapter adapter)

Name-Eingabefeld (Kurzbezeichnung) hat den Fokus verloren.

Parameters:

adapter - Verschlagwortungskomponente, in welcher das Event ausgelöst wurde

Since:

12.00.000

See Also:

ErsetztSimpleScriptEvent#IndexDialogNameExit

eloIndexDialogXDateEnter

void eloIndexDialogXDateEnter(KeywordingAdapter adapter)

Datum-Eingabefeld hat den Fokus bekommen.

Parameters:

adapter - Verschlagwortungskomponente, in welcher das Event ausgelöst wurde

Since:

12.00.000

See Also:

ErsetztSimpleScriptEvent#IndexDialogXDateEnter

eloIndexDialogXDateExit

void eloIndexDialogXDateExit(KeywordingAdapter adapter)

Datum-Eingabefeld hat den Fokus verloren.

Parameters:

adapter - Verschlagwortungskomponente, in welcher das Event ausgelöst wurde

Since:

12.00.000

See Also:

ErsetztSimpleScriptEvent#IndexDialogXDateExit

eloIndexDialogCancelStart

int eloIndexDialogCancelStart(IndexDialogAdapter adapter)

Nach dem Drücken der Schaltfläche "Abbrechen" im IndexDialog. Das "Start" kennzeichnet die Auswertung des Rückgabewertes. Bei einem negativen Rückgabewert, bleibt die Verschlagwortung geöffnet.

Parameters:

adapter - Verschlagwortungsdialog

Returns:

negativ, um die Aktion abzubrechen, damit die Verschlagwortung geöffnet bleibt.

Since:

12.00.000

See Also:

ErsetztSimpleScriptEvent#IndexDialogCancelStart

eloIndexDialogOkStart

int eloIndexDialogOkStart(IndexDialogAdapter adapter)

Nach dem Drücken der Schaltfläche "OK" im IndexDialogs. Das "Start" kennzeichnet die Auswertung des Rückgabewertes. Bei einem negativen Rückgabewert, wird nicht gespeichert und die Verschlagwortung bleibt geöffnet.

Parameters:

adapter - Verschlagwortungsdialog

Returns:

negativ, um die Aktion abzubrechen, damit die Verschlagwortung geöffnet bleibt.

Since:

12.00.000

See Also:

ErsetztSimpleScriptEvent#IndexDialogOkStart

eloCheckinDocumentStart

int eloCheckinDocumentStart(CheckoutDocument document)

Vor dem Einchecken eines ausgecheckten Archivdokuments.

Parameters:

document - Ausgechecktes Dokument

Returns:

Bei -1 wird das Einchecken des Dokuments abgebrochen

Since:

8.05.000

eloCheckinDocumentEnd

void eloCheckinDocumentEnd(ArchiveDocument document)

Nach dem Einchecken eines ausgecheckten Dokuments

Parameters:

document - Ausgechecktes Archivdokument

Since:

8.05.000

eloAddNoteStart

int eloAddNoteStart(Note note)

Vor dem Hinzufügen einer neuen Notiz. Dieses Event wird direkt bei dem Mausklick aufgerufen, das Speichern der neuen Notiz passiert später mit dem Event eloSaveNotes.

Parameters:

note - Die neue Notiz (Randnotiz oder Anmerkung auf dem Dokument)

Returns:

Bei -1 als Rückgabewert wird das Einfügen abgebrochen

Since:

8.03.002

eloAddNoteEnd

void eloAddNoteEnd(Note note)

Nach dem Hinzufügen einer neuen Notiz. Dieses Event wird direkt bei dem Mausklick aufgerufen, das Speichern der neuen Notiz passiert später mit dem Event eloSaveNotes.

Parameters:

note - Die neue Notiz (Randnotiz oder Anmerkung auf dem Dokument)

Since:

8.03.002

eloSaveNotesStart

int eloSaveNotesStart(Note[] notes)

Vor dem Speichern der Notizen.

Parameters:

notes - Die Notizen (Randnotiz oder Anmerkung auf dem Dokument)

Returns:

Bei -1 als Rückgabewert wird das Speichern abgebrochen

Since:

8.03.002

eloSaveNotesEnd

void eloSaveNotesEnd(Note[] notes)

Nach dem Speichern der Notizen.

Parameters:

notes - Die Notizen (Randnotiz oder Anmerkung auf dem Dokument), welche nach dem Speichern neu vom Server eingelesen wurden.

Since:

8.03.002

eloBeforeConvertToPdf

int eloBeforeConvertToPdf(File documentFile,
                          File tempPdfFile)

Vor dem Konvertieren eines Dokumentes nach PDF.

Parameters:

documentFile - Datei, die konvertiert wird

tempPdfFile - Konvertierte Datei im temporären Client-Verzeichnis

Returns:

-1

Since:

8.05.000

eloDocVersionsCompareStart

int eloDocVersionsCompareStart(DocVersionsDialogAdapter docVersionsDialog)

Bei Klick auf "Vergleichen" im Dialog "Dokumentversionen".

Parameters:

docVersionsDialog - Der Dialog "Dokumentversionen" in dem auf die Schaltfläche geklickt wurde.

Returns:

Bei -1 als Rückgabewert wird der normale Dialog mit dem Versionvergleich nicht angezeigt.

Since:

8.05.000

eloCheckoutDocumentAvailable

int eloCheckoutDocumentAvailable(int docId,
                                 File docFile)

Event wenn ein neues Checkout Dokument zur Bearbeitung zur Verfügung steht.

Parameters:

docId - ELO Object-Id des Checkout Dokuments.

docFile - Datei, die ausgecheckt wurde.

Returns:

nicht verwendet.

Since:

9.00.000

eloBroadcast

void eloBroadcast(int fromWorkspace,
                  String tag,
                  String message)

Event wenn ein Skript ein Broadcast verschickt hat.

Parameters:

fromWorkspace - Die Meldung kommt aus diesem Workspace

tag - Kennung der Meldung

message - Meldungstext

eloFlowConfirmDialogOkStart

void eloFlowConfirmDialogOkStart(Sord sord)

Deprecated.

Sord sollte im Event ScriptEvents.SimpleScriptEvent.FlowConfirmDialogOkStart über den FlowConfirmDialogAdapter bearbeitet werden.

Nach dem Drücken des OK im Dialog "Workflow weiterleiten". Das "Start" kennzeichnet die Auswertung des Rückgabewertes. Bei einem negativen Rückgabewert, läuft der Client weiter, als wäre "OK" nicht gedrückt worden.

Parameters:

sord - Verschlagwortung des Archiveintrags, mit dem der Workflow gestartet wurde

Since:

9.00.001

eloFlowConfirmDialogObjKeyEnter

void eloFlowConfirmDialogObjKeyEnter(int lineId,
                                     FlowConfirmDialogAdapter adapter)

Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus bekommen.

Parameters:

lineId - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Workflow-Weiterleiten-Dialog, in welchem das Event ausgelöst wurde

Since:

9.03.000, 12.00.000 neuer Parameter adapter

eloFlowConfirmDialogObjKeyExit

void eloFlowConfirmDialogObjKeyExit(int lineId,
                                    FlowConfirmDialogAdapter adapter)

Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus verloren.

Parameters:

lineId - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Workflow-Weiterleiten-Dialog, in welchem das Event ausgelöst wurde

Since:

9.03.000, 12.00.000 neuer Parameter adapter

eloVersionCheckinDialogObjKeyEnter

void eloVersionCheckinDialogObjKeyEnter(int lineId,
                                        DocVersionsDialogAdapter adapter)

Ein ObjKey-Eingabefeld im Version-Einchecken-Dialog hat den Fokus bekommen.

Parameters:

lineId - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Versionsdialog, in welchem das Event ausgelöst wurde

Since:

11.00.000 Zuvor wurde hier ein eloIndexDialogObjKeyEnter(int, IndexDialogAdapter) ausgelöst., 12.00.000 neuer Parameter adapter

eloVersionCheckinDialogObjKeyExit

void eloVersionCheckinDialogObjKeyExit(int lineId,
                                       DocVersionsDialogAdapter adapter)

Ein ObjKey-Eingabefeld im Version-Einchecken-Dialog hat den Fokus verloren.

Parameters:

lineId - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Versionsdialog, in welchem das Event ausgelöst wurde

Since:

11.00.000 Zuvor wurde hier ein eloIndexDialogObjKeyExit(int, IndexDialogAdapter) ausgelöst., 12.00.000 neuer Parameter adapter

eloBasicKeywordingObjKeyEnter

void eloBasicKeywordingObjKeyEnter(int lineId,
                                   KeywordingAdapter adapter)

Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus bekommen.

Parameters:

lineId - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Verschlagwortungskomponente, in welcher das Event ausgelöst wurde

Since:

12.00.000 Zuvor wurde hier ein eloIndexDialogObjKeyEnter(int, IndexDialogAdapter) ausgelöst.

eloBasicKeywordingObjKeyExit

void eloBasicKeywordingObjKeyExit(int lineId,
                                  KeywordingAdapter adapter)

Ein ObjKey-Eingabefeld im Workflow Weiterleiten Dialog hat den Fokus verloren.

Parameters:

lineId - Nummer des Indexfelds, ACHTUNG: Zählung beginnt hier bei 0

adapter - Verschlagwortungskomponente, in welcher das Event ausgelöst wurde

Since:

12.00.000 Zuvor wurde hier ein eloIndexDialogObjKeyExit(int, IndexDialogAdapter) ausgelöst.

eloReceiveBrowserMessage

void eloReceiveBrowserMessage(EventMessage browserMessage,
                              String browserCompName,
                              BrowserComponent browser)

Dieses Event wird nach dem Erhalt einer Nachricht aus der integrierten Java FX Browser Komponente gesendet.

Parameters:

browserMessage - Inhalt der Browser-Nachricht

browserCompName - Bezeichnung der Browser-Komponente

browser - Browser-Komponente

Since:

9.02.000, 9.03.006 Parameter "Browser"

eloPreviewAvailable

int eloPreviewAvailable(ParameterScriptEvent.ViewMode mode,
                        IndexedElement indexedElement)

Event, wenn ein Element in die Vorschau geladen wird.

Parameters:

mode - Modus der Vorschau
NO_SELECTION Keine Einträge ausgewählt
SINGLE_SELECTION Ein Eintrag ausgewählt
MULTIPLE_SELECTION Mehrere Einträge ausgewählt
EXTERNAL_OPENED Das Dokument wird in einem externen Programm angezeigt
SCRIPTING Eine Komponente oder Nachricht aus dem Scripting wird angezeigt

indexedElement - Selektierter Eintrag oder null

Returns:

Bei -1 als Rückgabewert wird die alte Vorschau beibehalten

Since:

9.00.000, 9.02.000 Rückgabewert für den Abbruch

eloDragAndDropStart

int eloDragAndDropStart(boolean internalDnD,
                        int targetId,
                        ParameterScriptEvent.TargetWorkArea targetWorkArea)

Event, wenn ein Element aus einem DnD Vorgang im ELO Client gedroppt wird.

Parameters:

internalDnD - true falls es sich um einen DnD-Vorgang innerhalb der Anwendung handelt

targetId - ObjektID des Zielordners im Archiv, kann je nach Funktionsbereich null sein

targetWorkArea - Funktionsbereich in dem das Element gedroppt wurde
REPOSITORY Archiv
INTRAY Postbox
CLIPBOARD Klemmbrett
TASKS Aufgaben
CHECKOUT Bearbeitung
SEARCH Suche

Returns:

Bei -1 als Rückgabewert wird der DnD-Vorgang abgebrochen

Since:

9.02.000

eloCollectListStart

void eloCollectListStart(int id,
                         Sord[] items)

Vor dem Einfügen in die Liste.

Parameters:

id - OrdnerId

items - Liste mit Unterelementen

Since:

8.03.000

eloCollectListEnd

void eloCollectListEnd(int id,
                       Sord[] items)

Nach dem Einfügen in die Liste.

Parameters:

id - OrdnerId

items - Liste mit Unterelementen

Since:

8.03.000

eloUpdateVersion

int eloUpdateVersion(EditInfo target,
                     File newVersionFile)

Vor dem Upload einer neuen Dokumentenversion.

Parameters:

target - Zielobjekt, welches eine neue Version bekommt.

newVersionFile - Neue Version.

Returns:

Bei -1 als Rückgabewert wird der Vorgang abgebrochen

Since:

9.00.000

eloBarcodeRecognized

void eloBarcodeRecognized(String barcode)

Beim Scannen eines Barcodes mit einem HID Barcode Scanner.

Die Barcodeerkennung bei Tastatureingaben muss erst in der Konfiguration aktiviert werden.
Das Event wird nicht von der integrierten Barcodeerkennung auf TIFF oder PDF Dokumenten verwendet.

Parameters:

barcode - Barcode

Since:

10.01.000

eloGenerateExternalFilename

String eloGenerateExternalFilename(Sord sord,
                                   DocVersion docVersion)

Wird aufgerufen wenn ein Dokument für die externe Verwendung gespeichert wird.

Falls am Zielort bereits eine Datei mit dem durch dieses Event erzeugten Dateinamen existiert, wird dieser durch eine Nummerierung ergänzt.

Die Dateiendung wird anschließend vom Client ermittelt.

Parameters:

sord - Verschlagwortung

docVersion - Version

Returns:

Dateiname ohne Dateiendung oder -1, damit der Client den Dateinamen ermittelt.

Since:

10.01.006

eloFillWithLastSord

int eloFillWithLastSord(Sord currentSord,
                        Sord lastSord,
                        FindInfo lastSearch)

Wird aufgerufen, wenn die F3-Funktion im Verschlagwortungsdialog aufgerufen wird und die aktuelle Verschlagwortung mit der zuletzt verwendeten Verschlagwortung überschrieben werden soll.

Einige Felder, wie SordType und die speziellen ObjKeys > 50, sollten nicht überschrieben werden.

Parameters:

currentSord - Aktuelle Verschlagwortung

lastSord - Zuletzt verwendete Verschlagwortung, null beim Suchdialog

lastSearch - Zuletzt verwendete Suche beim Suchdialog, sonst null

Returns:

Bei -1 als Rückgabewert wird das Füllen durch den Client übersprungen.

Since:

10.03.000

eloEnableFillWithLastSord

int eloEnableFillWithLastSord(Sord currentSord,
                              Sord lastSord,
                              boolean hasLastSearch)

Wird aufgerufen, wenn Überprüft wird, ob die F3-Funktion im Verschlagwortungsdialog aktiviert werden soll.

Parameters:

currentSord - Aktuelle Verschlagwortung

lastSord - Zuletzt verwendete Verschlagwortung, null beim Suchdialog

hasLastSearch - True falls bereits gesucht wurde und es sich um einen Suchdialog handelt, sonst false

Returns:

Bei -1 als Rückgabewert wird die normale Aktivierung/Deaktivierung durch den Client übersprungen.

Since:

10.03.000

See Also:

IndexDialogAdapter.setFillEnabled(boolean)