Package de.elo.client.scripting.interfaces

Class KeywordingAdapter

Object
KeywordingAdapter
Direct Known Subclasses:
IndexDialogAdapter
public class KeywordingAdapter extends Object

Überschrift: IndexDialogAdapter.

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

Copyright: Copyright (c) ELO Digital Office GmbH 2011-2014

See Also:

  • Constructor Details

    • KeywordingAdapter

      public KeywordingAdapter(Workspace workspace, IndexFieldFactory fieldFactory, FieldManager fieldManager, IndexDataIO indexDataIO, IndexFieldChecker fieldChecker, IndexDialogMode mode, IndexTabsFactory tabs, Container comp)
      Interner Konstruktor.
      Parameters:
      workspace - Aktueller Arbeitsbereich
      fieldFactory - Hilfsklasse für die Erstellung von Indexzeilen
      fieldManager - Verwaltet die Daten der Indexzeilen
      indexDataIO - Kapselt die Daten vom Indexdialog
      fieldChecker - Überprüft die Indexzeilen auf gültigen Inhalt
      mode - Modus vom Indexdialog
      tabs - Hilfsklasse für die Tabs im Indexdialog
      comp - Grafische Komponente

  • Method Details

    • getSord

      public Sord getSord() throws Exception
      Liefert die aktuell angezeigten Verschlagwortungsinformationen als ein SORD-Objekt.
      Returns:
      Sord Verschlagwortungsinformationen
      Throws:
      Exception - Wenn die Daten nicht vom Server oder aus der ESW Datei gelesen werden können.

    • setSord

      public void setSord(Sord data)
      Setzt ein SORD zur Anzeige im Dialog.
      Parameters:
      data - Verschlagwortungsinformationen eines Archivelementes

    • getName

      public String getName()
      Liefert den Namen/die Kurzbezeichnung des Archiveintrags.
      Returns:
      Kurzbezeichnung des Archiveintrags

    • getId

      public int getId()
      Liefert die ELO Objekt-Id des Archivelements.
      Returns:
      ELO Objekt Id
      Since:
      8.01.000

    • setName

      public void setName(String name)
      Setzt den Namen/die Kurzbezeichnung des Archivelementes.
      Parameters:
      name - Bezeichnung des Archivelementes

    • getDocMask

      public 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 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 String getMemo()
      Liefert den Zusatztext des Archivelements zurück.
      Returns:
      String Zusatztext des Archivelementes
      Since:
      7.00.004

    • getHiddenText

      public String getHiddenText()
      Liefert den versteckten Text des Archivelements zurück.
      Returns:
      String Aktueller "versteckter Text"
      Since:
      7.00.008

    • setMemo

      public void setMemo(String memo)
      Setzt den Zusatztext des Archivelements.
      Parameters:
      memo - Zusatztext
      Since:
      7.00.004

    • setHiddenText

      public void setHiddenText(String text)
      Setzt den versteckten Text des Archivelements.
      Parameters:
      text - Versteckter Text
      Since:
      7.00.008

    • getObjKeyValue

      public String getObjKeyValue(int no) throws Exception
      Deprecated.
      Ersetzen durch getObjKey(int) und ObjKeyAdapter.getValue()
      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:
      Exception - Wenn das Sord nicht gelesen werden kann oder das Indexfeld nicht gefunden wird.

    • setObjKeyValue

      public void setObjKeyValue(int no, String value) throws 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:
      Exception - Wenn das Sord nicht gelesen werden kann oder das Indexfeld nicht gefunden wird.

    • getObjKeyValue

      public String getObjKeyValue(String name) throws Exception
      Deprecated.
      Ersetzen durch getObjKey(String) und ObjKeyAdapter.getValue()
      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:
      Exception - Wenn das Sord nicht gelesen werden kann oder das Indexfeld nicht gefunden wird.

    • setObjKeyValue

      public void setObjKeyValue(String name, String value) throws 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:
      Exception - Wenn das Sord nicht gelesen werden kann oder das Indexfeld nicht gefunden wird.

    • addComponent

      public void addComponent(int tabNo, int x, int y, int w, int h, 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, String text, 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

    • addButton

      public Button addButton(int tabNo, int x, int y, int w, String text, BaseFunction callbackFunction, ScriptableObject thisScope)
      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
      callbackFunction - JavaScript Funktion, welche aufgerufen wird wenn der Button gedrückt wird.
      thisScope - "this" Scope der Funktion
      Returns:
      Das erzeugte Button-Objekt
      Since:
      10.00.000

    • addLabel

      public Label addLabel(int tabNo, int x, int y, int w, 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

    • addDateField

      public DateField addDateField(int tabNo, int x, int y, int w)
      Erzeugt ein Datumsfeld (DateField) 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 des Feldes im Raster
      Returns:
      Das erzeugte DateField-Objekt
      Since:
      8.05.000

    • addCheckBox

      public CheckBox addCheckBox(int tabNo, int x, int y, int w, 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, 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

    • getNameField

      public EditableFieldAdapter getNameField()
      Liefert den Adapter für das Feld "Kurzbezeichnung".
      Returns:
      Adapter für das Feld "Kurzbezeichnung"
      Since:
      8.03.000

    • getMemoField

      public EditableFieldAdapter getMemoField()
      Liefert den Adapter für das Feld "Zusatztext".
      Returns:
      Adapter für das Feld "Zusatztext"
      Since:
      10.01.000

    • getIDateField

      public KeywordingFieldAdapter getIDateField()
      Liefert den Adapter für das Feld "Ablagedatum".
      Returns:
      Adapter für das Feld "Ablagedatum"
      Since:
      8.03.000

    • getXDateField

      public EditableFieldAdapter getXDateField()
      Liefert den Adapter für das Feld "Datum".
      Returns:
      Adapter für das Feld "Datum"
      Since:
      8.03.000

    • getEditorField

      public KeywordingFieldAdapter getEditorField()
      Liefert den Adapter für das Feld "Bearbeiter".
      Returns:
      Adapter für das Feld "Bearbeiter"
      Since:
      8.03.000

    • getVersionField

      public KeywordingFieldAdapter getVersionField()
      Liefert den Adapter für das Feld "Aktuelle Version".
      Returns:
      Adapter für das Feld "Aktuelle Version"
      Since:
      8.03.000

    • getObjKey

      public ObjKeyAdapter getObjKey(int no) throws 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:
      Exception - Wenn das Sord nicht gelesen werden kann.

    • getObjKey

      public ObjKeyAdapter getObjKey(String name) throws 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:
      Exception - Wenn das Sord nicht gelesen werden kann.