de.elo.client.scripting.interfaces
Class KeywordingAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.KeywordingAdapter

Direct Known Subclasses:

IndexDialogAdapter

public class KeywordingAdapter
extends java.lang.Object

Überschrift: IndexDialogAdapter.

Beschreibung: Kapselt die Verschlagwortung in einer Eingabemaske gegenüber dem Script.

Copyright: Copyright (c) ELO Digital Office GmbH 2011

See Also:

IndexDialogAdapter, BasicKeywordingPanel

Constructor Summary

KeywordingAdapter(de.elo.client.maindialog.Workspace workspace, de.elo.client.indexdialog.IndexFieldFactory fieldFactory, de.elo.client.indexdialog.FieldManager fieldManager, de.elo.client.indexdialog.IndexDataIO indexDataIO, de.elo.client.indexdialog.IndexFieldChecker fieldChecker, de.elo.client.indexdialog.IndexDialogMode mode, de.elo.client.indexdialog.IndexTabsFactory tabs, java.awt.Component comp)
Normaler Konstruktor.

Method Summary

Button	addButton(int tabNo, int x, int y, int w, java.lang.String text, java.lang.String eventName) Fügt einen Button an die angegebene Stelle im Dialog "Verschlagwortung" ein.
CheckBox	addCheckBox(int tabNo, int x, int y, int w, java.lang.String text, boolean checked) Erzeugt eine CheckBox und fügt sie an der angegebenen Stelle in den Dialog ein.
ComboBox	addComboBox(int tabNo, int x, int y, int w, java.lang.String[] values, boolean editable) Erzeugt eine ComboBox und fügt sie an der angegebenen Stelle in den Dialog ein.
void	addComponent(int tabNo, int x, int y, int w, int h, java.awt.Component comp) Fügt eine Standard-Java Komponente (AWT/Swing) im Dialog "Verschlagwortung" ein.
Label	addLabel(int tabNo, int x, int y, int w, java.lang.String text) Erzeugt einen Text (Label) und fügt ihn an der angegebenen Stelle in den Dialog ein.
List	addList(int tabNo, int x, int y, int w, int h) Erzeugt eine Liste und fügt ihn an der angegebenen Stelle in den Dialog ein.
TextArea	addTextArea(int tabNo, int x, int y, int w, int h) Erzeugt ein mehrzeiliges Textfeld (TextArea) und fügt ihn an der angegebenen Stelle in den Dialog ein.
TextField	addTextField(int tabNo, int x, int y, int w) Erzeugt ein einzeiliges Textfeld (TextField) und fügt ihn an der angegebenen Stelle in den Dialog ein.
de.elo.ix.client.DocMask	getDocMask() Liefert das DocMask-Objekt der derzeit im Dialog angezeigten Verschlagwortungsmaske.
int	getDocMaskId() Liefert die Masken-ID der derzeit im Dialog angezeigten Verschlagwortungsmaske.
java.lang.String	getDocMaskName() Liefert den Namen der derzeit im Dialog angezeigten Verschlagwortungsmaske.
java.lang.String	getHiddenText() Liefert den versteckten Text des Archivelements zurück.
int	getId() Liefert die ELO Objekt-Id des Archivelements.
java.lang.String	getMemo() Liefert den Zusatztext des Archivelements zurück.
java.lang.String	getName() Liefert den Namen/die Kurzbezeichnung des Archivelementes.
ObjKeyAdapter	getObjKey(int no) Liefert den Adapter für ein Indexfeld.
ObjKeyAdapter	getObjKey(java.lang.String name) Liefert den Adapter für ein Indexfeld.
java.lang.String	getObjKeyValue(int no) Liefert den Wert einer Indexfelds.
java.lang.String	getObjKeyValue(java.lang.String name) Liefert den Wert eines Indexfelds.
de.elo.ix.client.Sord	getSord() Liefert die aktuell angezeigten Verschlagwortungsinformationen als ein SORD-Objekt.
void	setHiddenText(java.lang.String text) Setzt den versteckten Text des Archivelements.
void	setMemo(java.lang.String memo) Setzt den Zusatztext des Archivelements.
void	setName(java.lang.String name) Setzt den Namen/die Kurzbezeichnung des Archivelementes.
void	setObjKeyValue(int no, java.lang.String value) Setzt den Wert eines Indexfelds.
void	setObjKeyValue(java.lang.String name, java.lang.String value) Setzt den Wert eines Indexfelds.
void	setSord(de.elo.ix.client.Sord data) Setzt ein SORD zur Anzeige im Dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordingAdapter

public KeywordingAdapter(de.elo.client.maindialog.Workspace workspace,
                         de.elo.client.indexdialog.IndexFieldFactory fieldFactory,
                         de.elo.client.indexdialog.FieldManager fieldManager,
                         de.elo.client.indexdialog.IndexDataIO indexDataIO,
                         de.elo.client.indexdialog.IndexFieldChecker fieldChecker,
                         de.elo.client.indexdialog.IndexDialogMode mode,
                         de.elo.client.indexdialog.IndexTabsFactory tabs,
                         java.awt.Component comp)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

fieldFactory -

fieldManager -

indexDataIO -

fieldChecker -

mode -

tabs -

comp -

Method Detail

getSord

public de.elo.ix.client.Sord getSord()
                              throws java.lang.Exception

Liefert die aktuell angezeigten Verschlagwortungsinformationen als ein SORD-Objekt.

Returns:

Sord Verschlagwortungsinformationen

Throws:

java.lang.Exception

setSord

public void setSord(de.elo.ix.client.Sord data)

Setzt ein SORD zur Anzeige im Dialog.

Parameters:

data - Verschlagwortungsinformationen eines Archivelementes

getName

public java.lang.String getName()

Liefert den Namen/die Kurzbezeichnung des Archivelementes.

Returns:

String

getId

public int getId()

Liefert die ELO Objekt-Id des Archivelements.

Returns:

ELO Objekt Id

Since:

8.01.000

setName

public void setName(java.lang.String name)

Setzt den Namen/die Kurzbezeichnung des Archivelementes.

Parameters:

name - Bezeichnung des Archivelementes

getDocMask

public de.elo.ix.client.DocMask getDocMask()

Liefert das DocMask-Objekt der derzeit im Dialog angezeigten Verschlagwortungsmaske.

Returns:

DocMask-Objekt der bereits angezeigten Verschlagwortungsmaske

Since:

6.00.090

getDocMaskName

public java.lang.String getDocMaskName()

Liefert den Namen der derzeit im Dialog angezeigten Verschlagwortungsmaske.

Returns:

String

Since:

6.00.090

getDocMaskId

public int getDocMaskId()

Liefert die Masken-ID der derzeit im Dialog angezeigten Verschlagwortungsmaske.

Returns:

int Masken-Id der angezeigten Verschlagwortungsmaske

Since:

6.00.090

getMemo

public java.lang.String getMemo()
                         throws java.lang.Exception

Liefert den Zusatztext des Archivelements zurück.

Returns:

String Zusatztext des Archivelementes

Throws:

java.lang.Exception

Since:

7.00.004

getHiddenText

public java.lang.String getHiddenText()
                               throws java.lang.Exception

Liefert den versteckten Text des Archivelements zurück.

Returns:

String Aktueller "versteckter Text"

Throws:

java.lang.Exception

Since:

7.00.008

setMemo

public void setMemo(java.lang.String memo)
             throws java.lang.Exception

Setzt den Zusatztext des Archivelements.

Parameters:

memo - Zusatztext

Throws:

java.lang.Exception

Since:

7.00.004

setHiddenText

public void setHiddenText(java.lang.String text)
                   throws java.lang.Exception

Setzt den versteckten Text des Archivelements.

Parameters:

text - Versteckter Text

Throws:

java.lang.Exception

Since:

7.00.008

getObjKeyValue

public java.lang.String getObjKeyValue(int no)
                                throws java.lang.Exception

Liefert den Wert einer Indexfelds.

Parameters:

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

Returns:

Wert des Indexfelds. Falls ein Spaltenindes vorhanden ist, sind die Werte durch ein Pilcrow (¶) getrennt.

Throws:

java.lang.Exception

setObjKeyValue

public void setObjKeyValue(int no,
                           java.lang.String value)
                    throws java.lang.Exception

Setzt den Wert eines Indexfelds. Ein Aufruf der Methode "saveSord" ist nötig um diese Änderung zu speichern.

Parameters:

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

value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindes zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.

Throws:

java.lang.Exception

getObjKeyValue

public java.lang.String getObjKeyValue(java.lang.String name)
                                throws java.lang.Exception

Liefert den Wert eines Indexfelds.

Parameters:

name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.

Returns:

Wert des Indexfelds. Falls ein Spaltenindes vorhanden ist, sind die Werte durch ein Pilcrow (¶) getrennt.

Throws:

java.lang.Exception

setObjKeyValue

public void setObjKeyValue(java.lang.String name,
                           java.lang.String value)
                    throws java.lang.Exception

Setzt den Wert eines Indexfelds. Ein saveSord ist nötig um diese Änderung zu speichern.

Parameters:

name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.

value - Der zu setzende Wert des Indexfelds. Um einen Spaltenindes zu verwenden, müssen die Werte durch ein Pilcrow (¶) getrennt sein.

Throws:

java.lang.Exception

addComponent

public void addComponent(int tabNo,
                         int x,
                         int y,
                         int w,
                         int h,
                         java.awt.Component comp)

Fügt eine Standard-Java Komponente (AWT/Swing) im Dialog "Verschlagwortung" ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1

w - Breite im Raster

h - Höhe im Raster

comp - die Komponente

Since:

7.00.010

addButton

public Button addButton(int tabNo,
                        int x,
                        int y,
                        int w,
                        java.lang.String text,
                        java.lang.String eventName)

Fügt einen Button an die angegebene Stelle im Dialog "Verschlagwortung" ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt bei 1

w - Breite im Tabellenraster

text - Text-Label der CheckBox

eventName - Ein Scripting-Event, das aufgerufen wird, wenn der Button gedrückt wird.

Returns:

Das erzeugte Button-Objekt

Since:

7.00.004

addLabel

public Label addLabel(int tabNo,
                      int x,
                      int y,
                      int w,
                      java.lang.String text)

Erzeugt einen Text (Label) und fügt ihn an der angegebenen Stelle in den Dialog ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt bei 1

w - Breite im Raster

text - der anzuzeigende Text

Returns:

Das erzeugte Label-Objekt

Since:

7.00.004

addTextArea

public TextArea addTextArea(int tabNo,
                            int x,
                            int y,
                            int w,
                            int h)

Erzeugt ein mehrzeiliges Textfeld (TextArea) und fügt ihn an der angegebenen Stelle in den Dialog ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt bei 1

w - Breite im Raster

h - Höhe im Raster

Returns:

Das erzeugte TextArea-Objekt

Since:

7.00.004

addList

public List addList(int tabNo,
                    int x,
                    int y,
                    int w,
                    int h)

Erzeugt eine Liste und fügt ihn an der angegebenen Stelle in den Dialog ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt hier bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt hier bei 1

w - Breite im Raster

h - Höhe im Raster

Returns:

das erzeugte List-Objekt

Since:

7.00.008

addTextField

public TextField addTextField(int tabNo,
                              int x,
                              int y,
                              int w)

Erzeugt ein einzeiliges Textfeld (TextField) und fügt ihn an der angegebenen Stelle in den Dialog ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt bei 1

w - Breite im Raster

Returns:

Das erzeugte TextField-Objekt

Since:

7.00.004

addCheckBox

public CheckBox addCheckBox(int tabNo,
                            int x,
                            int y,
                            int w,
                            java.lang.String text,
                            boolean checked)

Erzeugt eine CheckBox und fügt sie an der angegebenen Stelle in den Dialog ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt bei 1

w - Breite im Raster

text - Text-Label der CheckBox

checked - True, wenn die CheckBox "angehakt" sein soll

Returns:

Das erzeugte Label-Objekt

Since:

7.00.004

addComboBox

public ComboBox addComboBox(int tabNo,
                            int x,
                            int y,
                            int w,
                            java.lang.String[] values,
                            boolean editable)

Erzeugt eine ComboBox und fügt sie an der angegebenen Stelle in den Dialog ein.

Parameters:

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

x - X-Position im Raster (Spalte), Zählung beginnt bei 1

y - Y-Position im Raster (Zeile), Zählung beginnt bei 1

w - Breite im Raster

values - Die auswählbaren Werte des ComboBox

editable - True, wenn zusätzliche Eingaben möglich sein sollen, bei False ist nur eine Auswahl aus den vorhandenen Werten möglich.

Returns:

Das erzeugte Button-Objekt

Since:

7.00.004

getObjKey

public ObjKeyAdapter getObjKey(int no)
                        throws java.lang.Exception

Liefert den Adapter für ein Indexfeld.

Parameters:

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

Returns:

ObjKeyAdapter oder null, falls das Indexfeld nicht gefunden wurde.

Throws:

java.lang.Exception

getObjKey

public ObjKeyAdapter getObjKey(java.lang.String name)
                        throws java.lang.Exception

Liefert den Adapter für ein Indexfeld.

Parameters:

name - Gruppen-Name des Indexfelds, ACHTUNG: Diese Auswahl ist nicht eindeutig, bei mehreren Indexfeldern mit diesem Namen wird die erste benutzt.

Returns:

ObjKeyAdapter oder null, falls das Indexfeld nicht gefunden wurde.

Throws:

java.lang.Exception