de.elo.client.scripting.interfaces
Class IndexDialogAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.KeywordingAdapter
      de.elo.client.scripting.interfaces.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-2011

Constructor Summary

IndexDialogAdapter(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

boolean	editSord(de.elo.ix.client.Sord sord, boolean modal, java.lang.String title) Öffnet das angegebene SORD-Objekt im Verschlagwortungs-Dialog.
java.io.File	getFile() Quelldatei zum Indexdialog ausgeben.
java.lang.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.
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.
void	setDocMask(de.elo.ix.client.DocMask docMask) Setzt die Verschlagwortungsmaske in die Dialogdarstellung.
void	setDocMask(int maskId) Setzt die angezeigte Verschlagwortungsmaske mit der angegebenen Masken-ID.
void	setDocMask(java.lang.String maskName) Setzt die Maske mit dem angegebenen Namen.
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.
boolean	setMaskVisible(int maskId, boolean visible) Setzt die Sichtbarkeit der Maske im Dialog.
boolean	setMaskVisible(java.lang.String maskName, boolean visible) Setzt die Sichtbarkeit der Maske im Dialog.
void	setReadOnly() Setzt die Verschlagwortung in den ReadOnly-Modus.
void	setTabVisible(int tabNo, boolean visible) Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
void	setXDate(java.lang.String isoDate) Setzt das Datum des Archivelementes.

Methods inherited from class de.elo.client.scripting.interfaces.KeywordingAdapter

addButton, addCheckBox, addComboBox, addComponent, addLabel, addList, addTextArea, addTextField, getDocMask, getDocMaskId, getDocMaskName, getHiddenText, getId, getMemo, getName, getObjKey, getObjKey, getObjKeyValue, getObjKeyValue, getSord, setHiddenText, setMemo, setName, setObjKeyValue, setObjKeyValue, setSord

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDialogAdapter

public IndexDialogAdapter(de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

getFile

public java.io.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(java.lang.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 java.lang.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

setDocMask

public void setDocMask(de.elo.ix.client.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(java.lang.String maskName)
                throws java.lang.Exception

Setzt die Maske mit dem angegebenen Namen.

Parameters:

maskName - Bezeichnung der Verschlagwortungsmaske

Throws:

java.lang.Exception

setDocMask

public void setDocMask(int maskId)
                throws java.lang.Exception

Setzt die angezeigte Verschlagwortungsmaske mit der angegebenen Masken-ID.

Parameters:

maskId - Id der Verschlagwortungsmaske

Throws:

java.lang.Exception

editSord

public boolean editSord(de.elo.ix.client.Sord sord,
                        boolean modal,
                        java.lang.String title)
                 throws java.lang.Exception

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

Parameters:

sord - Zu bearbeitendes Archivelement

modal - true, wenn der Dialog den Client blockieren soll

title - Titel des Verschlagwortungsdialogs

Returns:

True wenn das Sord geändert wurde, sonst False

Throws:

java.lang.Exception

Since:

6.00.088

setMaskVisible

public boolean setMaskVisible(java.lang.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

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

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)

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

Parameters:

tabNo - Nummer des Tabs der Verschlagwortungsdaten, Zählung beginnt bei 1

visible -

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