Package de.elo.client.scripting.interfaces

Class PreviewAdapter

  • public class PreviewAdapter
extends Object

    Überschrift: PreviewAdapter.

    Beschreibung: Kapselt den Preview (EView) gegenüber dem Script. Im Scripting verfügbar als "preview".

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

    • Constructor Summary

      Constructors 
      Constructor Description
      PreviewAdapter​(Workspace workspace)
      Interner Konstruktor.

    • Method Summary

      Modifier and Type Method Description
      void clear()
      Löscht die aktuelle Anzeige der Dokumentenvorschau.
      void deactivate()
      Deaktiviert die Dokumentenvorschau.
      String getClickedOcrWord()
      Das zuletzt geklickte OCR-Wort.
      Rectangle getClickedOcrWordBounds()
      Position und Größe des zuletzt geklickten OCR-Wortes.
      String getHighlightText()
      Liest das Eingabefeld für den Hervorhebungstext aus.
      CONSTANTS.PREVIEW_CLASS getPreviewClassNameForFileExtension​(String fileExtension)
      Liefert die eingestellte Vorschauklasse für eine bestimmte Dateiendung (z.B. einen TextViewer für "txt" Dateien).
      String getProfile()
      Liefert den Namen des momentan verwendeten Vorschauprofils.
      ViewerAdapter getViewer()
      Liefert einen Zugriff für die Steuerung der aktiven Vorschau.
      boolean isAfterButtonForFileExtension​(String fileExtension)
      Gibt an, ob statt der Vorschau zunächst nur eine Meldung angezeigt wird.
      boolean isMinimized()
      Gibt an, ob der Vorschaubereich gerade minimiert ist.
      void reactivate()
      Reaktiviert die Dokumentenvorschau.
      void setClickedOcrWord​(String newValue)
      Verändert das zuletzt geklickte OCR Wort indem es mit dem neuen Wert überschrieben wird.
      void setDocumentComponent​(JComponent component)
      Zeigt eine Swing Komponente in der Dokumentvorschau an.
      void setDocumentFile​(File file)
      Zeigt eine Datei in der Dokumentvorschau an.
      void setExternalWindowVisible​(boolean visible)
      Steuert die Sichtbarkeit des Zusatzfensters für Vorschaukomponenten.
      void setHighlightText​(String text)
      Ändert den Hervorhebungstext.
      void setMinimized​(boolean minimized)
      Minimiert den Vorschaubereich oder zeigt diesen wieder normal an.
      void setPdfPreference​(boolean preferBrowser)
      Legt fest ob der Browser für die PDF-Vorschau verwendet werden soll.
      boolean setPreviewClassNameForFileExtension​(String fileExtension, CONSTANTS.PREVIEW_CLASS previewClass, boolean afterButton)
      Die Methode weist einer Dateiendung (z.B.
      boolean setProfile​(String profileName)
      Lädt das angegebene Vorschauprofil.
      void showComponent​(PreviewToolbar toolbar, JComponent component)
      Zeigt die Komponente im Bereich der Vorschau an und setzt eine Toolbar in den Titelbereich der Vorschau.
      void showComponent​(String titel, JComponent component)
      Zeigt die Komponente im Bereich der Vorschau an und setzt den Titel des Vorschaubereichs.
      void showId​(int objId)
      Zeigt den Eintrag (Ordner oder Dokument) zu der angegebenen ObjektID im Vorschaubereich an.
      boolean showIdInSidebar​(int objId)
      Zeigt die Randnotizen, Verlinkung, Signatur etc. zu dem Eintrag in der Seitenleiste der Vorschau an.
      void showInTrayFile​(String filename)
      Deprecated.
      Es sollte IntrayAdapter.selectDocument(de.elo.client.scripting.items.IntrayDocument) verwendet werden.
      void showMessage​(String messageText)
      Zeigt eine Meldung im Bereich der Dokumentenvorschau an.
      boolean switchToTab​(CONSTANTS.PREVIEW_CONTENT contentType)
      Falls der Vorschauinhalt in einem Tab liegt, wird auf dieses Tab gewechselt.

      • Methods inherited from class Object

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

    • Constructor Detail

      • PreviewAdapter

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

    • Method Detail

      • showId

        public void showId​(int objId)
        Zeigt den Eintrag (Ordner oder Dokument) zu der angegebenen ObjektID im Vorschaubereich an. Beinhaltet die Funktionalität von "showIdInSidebar",
        Parameters:
        objId - Objekt Id des anzuzeigenden Eintrags.

      • showIdInSidebar

        public boolean showIdInSidebar​(int objId)
        Zeigt die Randnotizen, Verlinkung, Signatur etc. zu dem Eintrag in der Seitenleiste der Vorschau an.
        Parameters:
        objId - Objekt Id des anzuzeigenden Eintrags
        Returns:
        True bei erfolgreicher Anzeige, False sonst.
        Since:
        8.01.000

      • deactivate

        public void deactivate()
        Deaktiviert die Dokumentenvorschau.

      • reactivate

        public void reactivate()
        Reaktiviert die Dokumentenvorschau. Das vor der Deaktivierung angezeigte Dokument wird wieder angezeigt.

      • clear

        public void clear()
        Löscht die aktuelle Anzeige der Dokumentenvorschau.

      • showMessage

        public void showMessage​(String messageText)
        Zeigt eine Meldung im Bereich der Dokumentenvorschau an. Diese Meldungen sind vor allem für Hinweise zur aktuellen Auswahl wie z.B. "Kein Dokument ausgewählt" oder "Mehrfachauswahl (3 Aufgaben)" gedacht.
        Parameters:
        messageText - Anzuzeigende Meldung
        Since:
        8.01.000

      • showComponent

        public void showComponent​(String titel,
                          JComponent component)
        Zeigt die Komponente im Bereich der Vorschau an und setzt den Titel des Vorschaubereichs.
        Parameters:
        titel - Bezeichnung des Vorschaubereichs
        component - Java Komponente, welche im Bereich der Vorschau angezeigt werden soll
        Since:
        8.01.000

      • showComponent

        public void showComponent​(PreviewToolbar toolbar,
                          JComponent component)
        Zeigt die Komponente im Bereich der Vorschau an und setzt eine Toolbar in den Titelbereich der Vorschau.
        Parameters:
        toolbar - Toolbar für den Vorschaubereich
        component - Java Komponente, welche im Bereich der Vorschau angezeigt werden soll
        Since:
        8.01.000

      • getClickedOcrWord

        public String getClickedOcrWord()
        Das zuletzt geklickte OCR-Wort.
        Returns:
        OCR-Wort

      • setClickedOcrWord

        public void setClickedOcrWord​(String newValue)
        Verändert das zuletzt geklickte OCR Wort indem es mit dem neuen Wert überschrieben wird.
        Parameters:
        newValue - Neuer Inhalte des markierten OCR Wortes.

      • getClickedOcrWordBounds

        public Rectangle getClickedOcrWordBounds()
        Position und Größe des zuletzt geklickten OCR-Wortes.
        Returns:
        Position und Größe

      • getProfile

        public String getProfile()
        Liefert den Namen des momentan verwendeten Vorschauprofils.
        Returns:
        Name des Vorschauprofils.
        Since:
        9.00.000

      • setProfile

        public boolean setProfile​(String profileName)
        Lädt das angegebene Vorschauprofil.
        Parameters:
        profileName - Name des Vorschauprofils.
        Returns:
        True, wenn ein Profil mit diesem Namen gefunden und geladen wurde.
        Since:
        9.00.000

      • switchToTab

        public boolean switchToTab​(CONSTANTS.PREVIEW_CONTENT contentType)
        Falls der Vorschauinhalt in einem Tab liegt, wird auf dieses Tab gewechselt.
        Parameters:
        contentType - Vorschauinhalt
        INDEX_PREVIEW Verschlagwortungsvorschau
        DOCUMENT_PREVIEW Dokument/Ordner Vorschau
        FEED Dokumentfeed
        FORMULAR Formular
        FULLTEXT Volltextinhalt
        Returns:
        True, wenn der Vorschauinhalt nun sichtbar ist. False wenn dies nicht möglich ist, da dieser nicht im Profil vorhanden ist oder der Vorschaubereich nicht sichtbar ist.
        Since:
        9.02.000

      • setMinimized

        public void setMinimized​(boolean minimized)
        Minimiert den Vorschaubereich oder zeigt diesen wieder normal an.
        Parameters:
        minimized - Vorschau minimieren
        Since:
        9.00.000

      • isMinimized

        public boolean isMinimized()
        Gibt an, ob der Vorschaubereich gerade minimiert ist.
        Returns:
        True, wenn der Vorschaubereich gerade minimiert ist.
        Since:
        9.00.000

      • setDocumentFile

        public void setDocumentFile​(File file)
        Zeigt eine Datei in der Dokumentvorschau an. Nur zur Verwendung im Event "eloPreviewAvailable".
        Parameters:
        file - Datei für die Dokumentvorschau
        Since:
        9.00.000

      • setDocumentComponent

        public void setDocumentComponent​(JComponent component)
        Zeigt eine Swing Komponente in der Dokumentvorschau an. Nur zur Verwendung im Event "eloPreviewAvailable".
        Parameters:
        component - Swing Komponente
        Since:
        9.00.000

      • getViewer

        public ViewerAdapter getViewer()
        Liefert einen Zugriff für die Steuerung der aktiven Vorschau.
        Returns:
        Viewer der Vorschau
        Since:
        9.02.000

      • setExternalWindowVisible

        public void setExternalWindowVisible​(boolean visible)
        Steuert die Sichtbarkeit des Zusatzfensters für Vorschaukomponenten.
        Parameters:
        visible - bei TRUE anzeige, FALSE schließt das Fenster
        Since:
        9.03.000

      • getHighlightText

        public String getHighlightText()
        Liest das Eingabefeld für den Hervorhebungstext aus. Dieses Feld wird nur für PDF und Tiff Dokumente angezeigt und ausgewertet.
        Returns:
        aktueller Text
        Since:
        9.03.000

      • setHighlightText

        public void setHighlightText​(String text)
        Ändert den Hervorhebungstext. Dieses Feld wird nur für PDF und Tiff Dokumente angezeigt und ausgewertet.
        Parameters:
        text - Neuer Text
        Since:
        9.03.000

      • setPdfPreference

        public void setPdfPreference​(boolean preferBrowser)
        Legt fest ob der Browser für die PDF-Vorschau verwendet werden soll. Gilt nur für die aktuelle Sitzung.
        Parameters:
        preferBrowser - Browser-Vorschau verwenden
        Since:
        10.03.000

      • getPreviewClassNameForFileExtension

        public CONSTANTS.PREVIEW_CLASS getPreviewClassNameForFileExtension​(String fileExtension)
        Liefert die eingestellte Vorschauklasse für eine bestimmte Dateiendung (z.B. einen TextViewer für "txt" Dateien).
        Parameters:
        fileExtension - Dateiendung (z.B. "txt")
        Returns:
        Vorschauklasse
        Since:
        10.03.000

      • setPreviewClassNameForFileExtension

        public boolean setPreviewClassNameForFileExtension​(String fileExtension,
                                                   CONSTANTS.PREVIEW_CLASS previewClass,
                                                   boolean afterButton)
        Die Methode weist einer Dateiendung (z.B. "txt") eine Vorschauklasse zu. Dadurch kann bestimmt werden, welcher Viewer für einen Dateityp verwendet werden soll.
        Parameters:
        fileExtension - Dateiendung (z.B. "txt")
        previewClass - Die zu verwendende Vorschauklasse für diese Dateiendung (z.B. CONSTANTS.PREVIEW_CLASS.TextPreview)
        afterButton - Vorschau erst nach einem Buttonklick anzeigen
        Returns:
        True wenn das Mapping funktioniert hat, False bei Fehler
        Since:
        10.03.000

      • isAfterButtonForFileExtension

        public boolean isAfterButtonForFileExtension​(String fileExtension)
        Gibt an, ob statt der Vorschau zunächst nur eine Meldung angezeigt wird.
        Parameters:
        fileExtension - Dateiendung (z.B. "txt")
        Returns:
        True bei "Vorschau auf Nachfrage", False bei direkter Vorschau
        Since:
        10.03.000