Package de.elo.client.scripting.interfaces

Class ClipboardAdapter

  • public class ClipboardAdapter
extends ViewAdapter

    Überschrift: ClipboardAdapter

    Beschreibung: Kapselt den Funktionsbereich "Klemmbrett" gegenüber dem Script. Im Scripting verfügbar als "clipboard".

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

    • Constructor Detail

      • ClipboardAdapter

        public ClipboardAdapter​(Workspace workspace)
        Interner Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich

    • Method Detail

      • hasSelection

        public boolean hasSelection()
        Meldet zurück, ob mindestens ein Archivelement im Klemmbrettbaum selektiert wurde.
        Specified by:
        hasSelection in class ViewAdapter
        Returns:
        boolean

      • getSelectionCount

        public int getSelectionCount()
        Liefert die Anzahl an selektieren Archiveinträgen im Klemmbrett. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Specified by:
        getSelectionCount in class ViewAdapter
        Returns:
        int
        Since:
        7.00.004

      • getSelected

        public ArchiveElement getSelected()
        Deprecated.
        Ersetzt durch getFirstSelected()
        Liefert das erste im Klemmbrett selektierte Archivelement. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Returns:
        ArchiveElement Archivelement

      • getFirstSelected

        public ArchiveElement getFirstSelected()
        Liefert das erste im Klemmbrett selektierte Archiveintrag. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Specified by:
        getFirstSelected in class ViewAdapter
        Returns:
        Archivelement oder null, falls keine Selektion vorhanden ist
        Since:
        7.00.004

      • getAllSelected

        public Enumeration<ArchiveElement> getAllSelected()
        Liefert eine Aufzählung mit allen im Klemmbrett selektierten Archiveinträgen zurück. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
        Specified by:
        getAllSelected in class ViewAdapter
        Returns:
        Aufzählung von Archiveinträgen
        Since:
        7.00.004

      • selectId

        public void selectId​(int objId)
              throws Exception
        Selektiert das angegebene Archivelement im Klemmbrett.
        Parameters:
        objId - ObjektId des Archivelementes
        Throws:
        Exception - Wenn das Objekt nicht im Klemmbrett gefunden wird.

      • addId

        public void addId​(int objId)
           throws Exception
        Fügt das angegebene Archivelement dem Klemmbrett hinzu.
        Parameters:
        objId - ObjektId des Archivelementes
        Throws:
        Exception - Wenn das Objekt nicht hinzugefügt werden kann.

      • addElement

        public void addElement​(ArchiveElement element)
                throws Exception
        Fügt das angegebene Archivelement dem Klemmbrett hinzu.
        Parameters:
        element - Archivelement
        Throws:
        Exception - Wenn das Objekt nicht hinzugefügt werden kann.

      • getElements

        public Enumeration<ArchiveElement> getElements()
        Liefert eine Aufzählung mit allen Klemmbrett-Elementen zurück.
        Returns:
        Aufzählung von Archiveinträgen

      • getElementCount

        public int getElementCount()
        Liefert die Anzahl der Archivelemente auf dem Klemmbrett.
        Returns:
        int

      • selectRow

        public void selectRow​(int rowNo)
               throws Exception
        Selektiert die angegebene Zeile im Klemmbrett.
        Parameters:
        rowNo - Zeilennummer
        Throws:
        Exception - Wenn die Zeile nicht existiert

      • selectAll

        public void selectAll()
        Selektiert alle Archivelemente auf dem Klemmbrett.
        Since:
        7.00.004

      • removeRow

        public void removeRow​(int rowNo)
               throws Exception
        Entfernt die angebene Zeile aus dem Klemmbrett.
        Parameters:
        rowNo - Zeilennummer
        Throws:
        Exception - Wenn die Zeile nicht existiert

      • removeElement

        public void removeElement​(ArchiveElement element)
                   throws Exception
        Entfernt das angegebene Archivelement aus dem Klemmbrett.
        Parameters:
        element - Archivelement
        Throws:
        Exception - Wenn das Objekt nicht im Klemmbrett gefunden wird.

      • removeId

        public void removeId​(int objId)
              throws Exception
        Entfernt das durch die ObjId angebene Archivelement aus dem Klemmbrett.
        Parameters:
        objId - Id des Archivelementes
        Throws:
        Exception - Wenn das Objekt nicht im Klemmbrett gefunden wird.

      • getRow

        public ArchiveElement getRow​(int rowNo)
                      throws Exception
        Liefert das Dokument/Strukturelement aus der angebenen Zeile.
        Parameters:
        rowNo - Zeilennummer
        Returns:
        ArchiveElement
        Throws:
        Exception - Wenn die Zeile nicht existiert.

      • getName

        public String getName()
        Description copied from class: ViewAdapter
        Gibt den Namen der Ansicht zurück. Bei Archivansichten ist das der Name des Root-Elements, bei anderen Ansichten der Name der Ansicht "Archive: (Rootname)", "Checkout", "Clipboard", "Search", "Task", "Intray".
        Specified by:
        getName in class ViewAdapter
        Returns:
        String

      • refresh

        public void refresh()
        Description copied from class: ViewAdapter
        Aktualisiert den Inhalt dieser Ansicht.
        Specified by:
        refresh in class ViewAdapter