Package de.elo.client.scripting.interfaces

Class IndexDialogAdapter

Object

KeywordingAdapter

IndexDialogAdapter

All Implemented Interfaces:

DialogActionInterface

public class IndexDialogAdapter
extends KeywordingAdapter
implements DialogActionInterface

Überschrift: IndexDialogAdapter

Beschreibung: Kapselt den IndexDialog gegenüber dem Script. Im Scripting verfügbar als "indexDialog".

Copyright: Copyright (c) ELO Digital Office GmbH 2007-2015

Constructor Summary

Constructors

Constructor	Description
IndexDialogAdapter(Workspace workspace, IndexDialog indexDialog)	Interner Konstruktor.

Method Summary

Modifier and Type	Method	Description
boolean	editMultiple(Sord sord, boolean modal, String title)	Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog.
boolean	editSord(Sord sord, boolean modal, String title)	Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog.
boolean	editSord(Sord sord, String title)	Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog.
boolean	editSord(Sord sord, String title, String okCallbackMethod, String cancelCallbackMethod)	Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog.
boolean	editSord(Sord sord, String title, BaseFunction okCallback, BaseFunction closeCallback, ScriptableObject thisScope)	Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog.
File	getFile()	Quelldatei zum Indexdialog ausgeben.
String	getXDate()	Liefert das aktuell eingetragene Datum.
boolean	isNewEntry()	Meldet zurück, ob der Verschlagwortungsdialog zum Bearbeiten der Verschlagwortung eines neuen Eintrags benutzt wird.
boolean	isSearch()	Prüft, ob der Verschlagwortungsdialog zur Suche benutzt wird.
boolean	isVisible()	Meldet zurück, ob der Verschlagwortungsdialog gerade angezeigt wird.
void	pressCancel()	Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
void	pressOK()	Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
boolean	searchSord(Sord sord, String title)	Öffnet das angegebene SORD-Objekt zur Suche im Verschlagwortungs-Dialog.
void	setDelDateSearch(String isoDateFrom, String isoDateTo)	Setzt den Suchbereich für das Lösch-/Verfalls-Datum.
void	setDocMask(int maskId)	Setzt die angezeigte Verschlagwortungsmaske mit der angegebenen Masken-ID.
void	setDocMask(DocMask docMask)	Setzt die Verschlagwortungsmaske in die Dialogdarstellung.
void	setDocMask(String maskName)	Setzt die Maske mit dem angegebenen Namen.
void	setFillEnabled(boolean enable)	Aktiviert oder deaktiviert den Button für das Füllen der Verschlagwortung.
void	setFillVisible(boolean visible)	Setzt die Sichtbarkeit der Schaltfläche "Füllen".
void	setFocusToName()	Setzt den Eingabe-Fokus auf das Feld für die Namen / Kurzbezeichnung.
void	setFocusToObjKey(int objKeyId)	Setzt den Eingabe-Fokus auf das Feld für den ObjKey mit der angegebenen Id.
void	setFocusToXDate()	Setzt den Eingabe-Fokus auf das Feld für das Datum.
void	setIDateSearch(String isoDateFrom, String isoDateTo)	Setzt den Suchbereich für das Ablagedatum.
void	setLoadVisible(boolean visible)	Setzt die Sichtbarkeit der Schaltfläche "Verschlagwortung".
void	setMasksListVisible(boolean visible)	Setzt die Sichtbarkeit der Liste mit den Masken (Maskenauswahl), welche normalerweise links im IndexDialog vorhanden ist.
boolean	setMaskVisible(int maskId, boolean visible)	Setzt die Sichtbarkeit der Maske im Dialog.
boolean	setMaskVisible(String maskName, boolean visible)	Setzt die Sichtbarkeit der Maske im Dialog.
boolean	setPermissionsChoiceVisible(boolean showUsers, boolean showGroups, boolean showKeys, boolean showOthers)	Setzt die Sichtbarkeit der verschiedenen Tabs in der Auswahl für die Berechtigungen.
void	setReadOnly()	Setzt die Verschlagwortung in den ReadOnly-Modus.
void	setSaveVisible(boolean visible)	Setzt die Sichtbarkeit der Schaltfläche "Verschlagwortung speichern".
void	setTabEnabled(int tabNo, boolean enabled)	Sperrt oder entsperrt die Inhalte eines Tabs im Dialog "Verschlagwortung".
void	setTabVisible(int tabNo, boolean visible)	Setzt die Sichtbarkeit eines Tabs im Dialog "Verschlagwortung".
void	setXDate(String isoDate)	Setzt das Datum des Archivelementes.
void	setXDateSearch(String isoDateFrom, String isoDateTo)	Setzt den Suchbereich für das Dokumentendatum.
boolean	wasClosedByOk()	Liefert zurück, ob der Verschlagwortungsdialog beim letzten Aufruf mit Ok geschlossen wurde.

Methods inherited from class KeywordingAdapter

addButton, addButton, addCheckBox, addComboBox, addComponent, addDateField, addLabel, addList, addTextArea, addTextField, getDocMask, getDocMaskId, getDocMaskName, getEditorField, getHiddenText, getId, getIDateField, getMemo, getMemoField, getName, getNameField, getObjKey, getObjKey, getObjKeyValue, getObjKeyValue, getSord, getVersionField, getXDateField, setHiddenText, setMemo, setName, setObjKeyValue, setObjKeyValue, setSord

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexDialogAdapter

public IndexDialogAdapter(Workspace workspace,
                          IndexDialog indexDialog)

Interner Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

indexDialog - IndexDialog, auf welchen dieser Adapter zugreift

Method Detail

getFile

public File getFile()

Quelldatei zum Indexdialog ausgeben. Dieser Wert ist nur bei der Neuablage gefüllt.

Returns:

Dokumentdatei

Since:

8.01.000

setXDate

public void setXDate(String isoDate)

Setzt das Datum des Archivelementes.

Parameters:

isoDate - Das Datum in ISO-Formatierung: für den 09.10.2011 ist dies 20111009. Wenn eine Uhrzeit gesetzt werden soll, müssen auch Sekunden angegeben werden, obwohl ELO nur minutengenaue Angaben speichert. Für den 09.10.2011 um 12:34 also 20111009123400.

Since:

7.00.010

getXDate

public String getXDate()

Liefert das aktuell eingetragene Datum.

Returns:

Das Datum in ISO-Formatierung: für den 09.10.2011 ist dies 20111009. Wenn eine Uhrzeit gesetzt wurde, sind auch Sekunden angegeben, obwohl ELO nur minutengenaue Angaben speichert. Für den 09.10.2011 um 12:34 also 20111009123400.

Since:

7.00.010

setXDateSearch

public void setXDateSearch(String isoDateFrom,
                           String isoDateTo)
                    throws Exception

Setzt den Suchbereich für das Dokumentendatum.

Parameters:

isoDateFrom - Startdatum in ISO-Formatierung

isoDateTo - Enddatum in ISO-Formatierung oder leer für die Eingrenzung auf einen Tag.

Throws:

Exception - Wenn sich der Verschlagwortungsdialog nicht im Suchmodus befindet.

Since:

10.03.000

See Also:

isSearch()

setIDateSearch

public void setIDateSearch(String isoDateFrom,
                           String isoDateTo)
                    throws Exception

Setzt den Suchbereich für das Ablagedatum.

Parameters:

isoDateFrom - Startdatum in ISO-Formatierung

isoDateTo - Enddatum in ISO-Formatierung oder leer für die Eingrenzung auf einen Tag.

Throws:

Exception - Wenn sich der Verschlagwortungsdialog nicht im Suchmodus befindet.

Since:

10.03.000

See Also:

isSearch()

setDelDateSearch

public void setDelDateSearch(String isoDateFrom,
                             String isoDateTo)
                      throws Exception

Setzt den Suchbereich für das Lösch-/Verfalls-Datum.

Parameters:

isoDateFrom - Startdatum in ISO-Formatierung

isoDateTo - Enddatum in ISO-Formatierung oder leer für die Eingrenzung auf einen Tag.

Throws:

Exception - Wenn sich der Verschlagwortungsdialog nicht im Suchmodus befindet.

Since:

10.03.000

See Also:

isSearch()

setDocMask

public void setDocMask(DocMask docMask)

Setzt die Verschlagwortungsmaske in die Dialogdarstellung.

Parameters:

docMask - Verschlagwortungsmaske

setFocusToObjKey

public void setFocusToObjKey(int objKeyId)

Setzt den Eingabe-Fokus auf das Feld für den ObjKey mit der angegebenen Id.

Parameters:

objKeyId - ID des ObjKey

setFocusToName

public void setFocusToName()

Setzt den Eingabe-Fokus auf das Feld für die Namen / Kurzbezeichnung.

setFocusToXDate

public void setFocusToXDate()

Setzt den Eingabe-Fokus auf das Feld für das Datum.

setDocMask

public void setDocMask(String maskName)
                throws Exception

Setzt die Maske mit dem angegebenen Namen.

Parameters:

maskName - Bezeichnung der Verschlagwortungsmaske

Throws:

Exception - Wenn die Maske nicht vom Server geladen werden kann.

setDocMask

public void setDocMask(int maskId)
                throws Exception

Setzt die angezeigte Verschlagwortungsmaske mit der angegebenen Masken-ID.

Parameters:

maskId - Id der Verschlagwortungsmaske

Throws:

Exception - Wenn die Maske nicht vom Server geladen werden kann.

editSord

public boolean editSord(Sord sord,
                        boolean modal,
                        String title)
                 throws Exception

Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog. Wenn in sord.access kein Schreibrecht gegeben ist, erscheint der Dialog im Read-Only-Modus.

Parameters:

sord - Zu bearbeitende Verschlagwortung

modal - true, wenn der Dialog den Client blockieren soll

title - Titel des Verschlagwortungsdialogs

Returns:

True wenn das Sord modaler Anzeige geändert wurde, sonst False

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann, oder die Daten nicht gespeichert werden können.

Since:

6.00.088

editSord

public boolean editSord(Sord sord,
                        String title,
                        String okCallbackMethod,
                        String cancelCallbackMethod)
                 throws Exception

Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog. Wenn in sord.access kein Schreibrecht gegeben ist, erscheint der Dialog im Read-Only-Modus.

Parameters:

sord - Zu bearbeitende Verschlagwortung

title - Titel des Verschlagwortungsdialogs

okCallbackMethod - Ein Event welches beim Klick auf "OK" aufgerufen werden soll oder null. Im Scripting kann das Schließen des Dialogs verhindert werden, wenn eine Funktion zu diesem Event einen negativen Rückgabewert liefert.

cancelCallbackMethod - Ein Event welches bei "Abbrechen" oder "X" aufgerufen wird oder null. Das Schließen des Dialogs kann hierbei nicht abgebrochen werden.

Returns:

Immer false, da bei nicht modaler Anzeige nicht auf Ergebnisse gewartet wird.

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann, oder die Daten nicht gespeichert werden können.

Since:

10.00.000

editSord

public boolean editSord(Sord sord,
                        String title,
                        BaseFunction okCallback,
                        BaseFunction closeCallback,
                        ScriptableObject thisScope)
                 throws Exception

Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog. Wenn in sord.access kein Schreibrecht gegeben ist, erscheint der Dialog im Read-Only-Modus.

Parameters:

sord - Zu bearbeitende Verschlagwortung

title - Titel des Verschlagwortungsdialogs

okCallback - Ein Event welches beim Klick auf "OK" aufgerufen werden soll oder null. Im Scripting kann das Schließen des Dialogs verhindert werden, wenn eine Funktion zu diesem Event einen negativen Rückgabewert liefert.

closeCallback - Ein Event welches bei "Abbrechen" oder "X" aufgerufen wird oder null. Das Schließen des Dialogs kann hierbei nicht abgebrochen werden.

thisScope - "this" Scope der Callback-Methoden: Das die Funktionen definierende Objekt.

Returns:

Immer false, da bei nicht modaler Anzeige nicht auf Ergebnisse gewartet wird.

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann, oder die Daten nicht gespeichert werden können.

Since:

10.00.000

editMultiple

public boolean editMultiple(Sord sord,
                            boolean modal,
                            String title)
                     throws Exception

Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog. Wenn in sord.access kein Schreibrecht gegeben ist, erscheint der Dialog im Read-Only-Modus.

Parameters:

sord - Zu bearbeitende Verschlagwortung

modal - true, wenn der Dialog den Client blockieren soll

title - Titel des Verschlagwortungsdialogs

Returns:

True wenn das Sord bei modaler Anzeige geändert wurde, sonst False

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann, oder die Daten nicht gespeichert werden können.

Since:

10.00.000

wasClosedByOk

public boolean wasClosedByOk()

Liefert zurück, ob der Verschlagwortungsdialog beim letzten Aufruf mit Ok geschlossen wurde.

Returns:

True, wenn der Dialog mit OK beendet wurde, sonst false.

Since:

9.03.000

searchSord

public boolean searchSord(Sord sord,
                          String title)
                   throws Exception

Öffnet das angegebene SORD-Objekt zur Suche im Verschlagwortungs-Dialog.

Parameters:

sord - Zu bearbeitende Verschlagwortung

title - Titel des Verschlagwortungsdialogs

Returns:

True wenn das Sord geändert wurde, sonst False

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann, oder die Daten nicht gespeichert werden können.

Since:

9.01.000

editSord

public boolean editSord(Sord sord,
                        String title)
                 throws Exception

Öffnet das angegebene SORD-Objekt zur Bearbeitung im Verschlagwortungs-Dialog. Wenn in sord.access kein Schreibrecht gegeben ist, erscheint der Dialog im Read-Only-Modus.

Parameters:

sord - Zu bearbeitende Verschlagwortung

title - Titel des Verschlagwortungsdialogs

Returns:

True wenn der Dialog mit OK beendet wurde, sonst False

Throws:

Exception - Wenn der Dialog nicht angezeigt werden kann, oder die Daten nicht gespeichert werden können.

Since:

8.04.000

setMaskVisible

public boolean setMaskVisible(String maskName,
                              boolean visible)

Setzt die Sichtbarkeit der Maske im Dialog. Dazu wird die Sichtbarkeit des Buttons für die Maske eingestellt. Dies kann sinnvoll im Event "IndexDialogSetDocMask" verwendet werden.

Parameters:

maskName - Bezeichnung der Verschlagwortungsmaske

visible - True für eine sichtbare Maske, False für unsichtbar.

Returns:

True bei Erfolg, False falls der Button nicht gefunden wurde.

Since:

7.00.008

setMaskVisible

public boolean setMaskVisible(int maskId,
                              boolean visible)

Setzt die Sichtbarkeit der Maske im Dialog. Dazu wird die Sichtbarkeit des Buttons für die Maske eingestellt. Dies kann sinnvoll im Event "IndexDialogSetDocMask" verwendet werden.

Parameters:

maskId - ID der Maske

visible - True für eine sichtbare Maske, False für unsichtbar.

Returns:

True bei Erfolg, False falls die Maske oder der Button nicht gefunden wurde.

Since:

7.00.008

setMasksListVisible

public void setMasksListVisible(boolean visible)

Setzt die Sichtbarkeit der Liste mit den Masken (Maskenauswahl), welche normalerweise links im IndexDialog vorhanden ist.

Parameters:

visible - True für eine sichtbare Maskenauswahl, False um die Maskenauswahl auszublenden.

Since:

8.03.000

setFillVisible

public void setFillVisible(boolean visible)

Setzt die Sichtbarkeit der Schaltfläche "Füllen".

Parameters:

visible - True für eine sichtbare Schaltfläche, False um sie auszublenden.

Since:

8.03.000

setFillEnabled

public void setFillEnabled(boolean enable)

Aktiviert oder deaktiviert den Button für das Füllen der Verschlagwortung.

Parameters:

enable - Button aktivieren

Since:

10.03.000

setLoadVisible

public void setLoadVisible(boolean visible)

Setzt die Sichtbarkeit der Schaltfläche "Verschlagwortung".

Parameters:

visible - True für eine sichtbare Schaltfläche, False um sie auszublenden.

Since:

8.03.000

setSaveVisible

public void setSaveVisible(boolean visible)

Setzt die Sichtbarkeit der Schaltfläche "Verschlagwortung speichern".

Parameters:

visible - True für eine sichtbare Schaltfläche, False um sie auszublenden.

Since:

8.03.000

isSearch

public boolean isSearch()

Prüft, ob der Verschlagwortungsdialog zur Suche benutzt wird.

Returns:

boolean True bei Suche, False bei Verschlagwortung

Since:

7.00.010

isNewEntry

public boolean isNewEntry()

Meldet zurück, ob der Verschlagwortungsdialog zum Bearbeiten der Verschlagwortung eines neuen Eintrags benutzt wird.

Returns:

boolean True wenn ein neuer Eintrag verschlagwortet wird, False wenn ein bestehender bearbeitet oder gesucht wird.

Since:

7.00.010

isVisible

public boolean isVisible()

Meldet zurück, ob der Verschlagwortungsdialog gerade angezeigt wird.

Returns:

Dialog sichtbar

Since:

9.01.000

setReadOnly

public void setReadOnly()

Setzt die Verschlagwortung in den ReadOnly-Modus. Dort sind keine Änderungen möglich und der Dialog kann nur über "Abbrechen" geschlossen werden.

Since:

7.00.014

setTabVisible

public void setTabVisible(int tabNo,
                          boolean visible)

Setzt die Sichtbarkeit eines Tabs im Dialog "Verschlagwortung".

Parameters:

tabNo - Nummer des Tabs der Verschlagwortungsdaten, Zählung beginnt bei 1
Spezielle, feste Nummern für die hinteren Tabs sind:
10 : Zusatztext
11 : Optionen
12 : Berechtigungen
13 : Änderungschronik
14 : Weitere Infos (falls verfügbar)

visible - True um den Tab sichtbar zu schalten, False um ihn auszublenden

Since:

8.03.000

setTabEnabled

public void setTabEnabled(int tabNo,
                          boolean enabled)

Sperrt oder entsperrt die Inhalte eines Tabs im Dialog "Verschlagwortung".

Parameters:

tabNo - Nummer des Tabs der Verschlagwortungsdaten, Zählung beginnt bei 1
Spezielle, feste Nummern für die hinteren Tabs sind:
10 : Zusatztext
11 : Optionen
12 : Berechtigungen
13 : Änderungschronik
14 : Weitere Infos (falls verfügbar)

enabled - False um die Eingabefelder des Tabs zu sperren, True um sie nach der normalen Dialog-Logik zu sperren/entsperren.

Since:

9.01.000

setPermissionsChoiceVisible

public boolean setPermissionsChoiceVisible(boolean showUsers,
                                           boolean showGroups,
                                           boolean showKeys,
                                           boolean showOthers)

Setzt die Sichtbarkeit der verschiedenen Tabs in der Auswahl für die Berechtigungen.

Parameters:

showUsers - True wenn die Liste der Benutzer angezeigt werden soll, False wenn nicht.

showGroups - True wenn die Liste der Gruppen angezeigt werden soll, False wenn nicht.

showKeys - True wenn die Liste der Schlüssel angezeigt werden soll, False wenn nicht.

showOthers - True wenn die Liste "Sonstiges" angezeigt werden soll, False wenn nicht.

Returns:

True wenn die Einstellung umgesetzt werden konnte, False wenn nicht - dies kann der Fall sein, wenn der Dialog keine Anzeige der Berechtigungen hat.

Since:

8.03.002

pressCancel

public void pressCancel()

Deprecated.

UNDER CONSTRUCTION, do not use this function, it may change.

Schließt den Dialog über den Button "Abbruch".

Specified by:

pressCancel in interface DialogActionInterface

pressOK

public void pressOK()

Deprecated.

UNDER CONSTRUCTION, do not use this function, it may change.

Schließt den Dialog über den Button "OK".

Specified by:

pressOK in interface DialogActionInterface