de.elo.client.scripting.interfaces
Class IntrayAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.ViewAdapter
      de.elo.client.scripting.interfaces.IntrayAdapter

public class IntrayAdapter
extends ViewAdapter

Überschrift: IntrayAdapter

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

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

Constructor Summary

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

Method Summary

java.util.Enumeration<IntrayDocument>	getAllSelected() Liefert eine Aufzählung mit den selektierten Postbox-Dokumenten.
java.io.File	getDirectory() Liefert das Postbox-Verzeichnis aus dem lokalen Dateisystem.
int	getDocumentCount() Liefert die Anzahl der Postbox-Dokumente zurück.
java.util.Enumeration<IntrayDocument>	getDocuments() Liefert eine Aufzählung mit den vorhandenen Postbox-Dokumenten zurück.
IntrayDocument	getFirstSelected() Liefert das erste selektierte Postbox-Dokument.
java.lang.String	getName() Gibt den Namen der Ansicht zurück.
IntrayDocument	getOcrDocument() Liefert das gerade von der OCR bearbeitete Postbox-Dokument.
java.lang.String	getScanProfileName() Liefert den Namen des aktuell aktiven Scan-Profiles.
java.util.Enumeration<IntrayDocument>	getSelected() Deprecated.
int	getSelectionCount() Liefert die Anzahl der selektieren Postbox-Dokumente zurück.
boolean	hasSelection() Prüft, ob in der Postbox mindestens ein Dokument selektiert wurde.
IntrayDocument	insertFile(java.io.File file) Fügt eine Dokument-Datei in die Postbox ein.
void	refresh() Aktualisiert den Inhalt dieser Ansicht.
void	selectDocument(IntrayDocument document) Selektiert das angegebene Dokument in der Postbox.
void	selectDocuments(IntrayDocument[] documents) Selektiert die angegebenen Dokumente in der Postbox.
void	selectRow(int rowNo) Selektiert die angebene Zeile in der Postbox-Tabelle.
void	selectRows(int[] rowNos) Selektiert die angebenen Zeilen in der Postbox.

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

show

Methods inherited from class java.lang.Object

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

Constructor Detail

IntrayAdapter

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

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

selectRow

public void selectRow(int rowNo)

Selektiert die angebene Zeile in der Postbox-Tabelle.

Parameters:

rowNo - Zu selektierende Tabellenzeile, angefangen bei 0

selectRows

public void selectRows(int[] rowNos)

Selektiert die angebenen Zeilen in der Postbox.

Parameters:

rowNos - Liste mit zu selektierenden Tabellenzeilen, angefangen bei 0

Since:

7.00.004

selectDocument

public void selectDocument(IntrayDocument document)
                    throws java.lang.Exception

Selektiert das angegebene Dokument in der Postbox.

Parameters:

document - Postbox-Dokument

Throws:

java.lang.Exception

selectDocuments

public void selectDocuments(IntrayDocument[] documents)
                     throws java.lang.Exception

Selektiert die angegebenen Dokumente in der Postbox.

Parameters:

documents - Liste mit Postbox-Dokumenten

Throws:

java.lang.Exception - - falls eines der Dokumente nicht gefunden wird, bleibt die Selektion unverändert und es wird eine Exception geworfen

Since:

6.00.092

getDocumentCount

public int getDocumentCount()

Liefert die Anzahl der Postbox-Dokumente zurück.

Returns:

Anzahl der Dokumente in der Postbox

getDocuments

public java.util.Enumeration<IntrayDocument> getDocuments()

Liefert eine Aufzählung mit den vorhandenen Postbox-Dokumenten zurück.

Returns:

Enumeration

hasSelection

public boolean hasSelection()

Prüft, ob in der Postbox mindestens ein Dokument selektiert wurde.

Specified by:

hasSelection in class ViewAdapter

Returns:

True wenn eine Selektion vorhanden ist, sonst False

getSelectionCount

public int getSelectionCount()

Liefert die Anzahl der selektieren Postbox-Dokumente zurück.

Specified by:

getSelectionCount in class ViewAdapter

Returns:

int

Since:

7.00.004

getSelected

public java.util.Enumeration<IntrayDocument> getSelected()

Deprecated.

Liefert eine Aufzählung mit den in der Postbox selektierten Elementen.

Returns:

Enumeration

getAllSelected

public java.util.Enumeration<IntrayDocument> getAllSelected()

Liefert eine Aufzählung mit den selektierten Postbox-Dokumenten.

Specified by:

getAllSelected in class ViewAdapter

Returns:

Aufzählung von Postbox-Dokumenten

Since:

7.00.004

getFirstSelected

public IntrayDocument getFirstSelected()

Liefert das erste selektierte Postbox-Dokument.

Specified by:

getFirstSelected in class ViewAdapter

Returns:

IntrayDocument Das erste Dokument oder null, falls kein Dokument selektiert ist

Since:

7.00.004

getOcrDocument

public IntrayDocument getOcrDocument()

Liefert das gerade von der OCR bearbeitete Postbox-Dokument.

Returns:

Das aktuell von der OCR bearbeitete Dokument oder null, fall kein Dokument von der OCR bearbeitet wird

Since:

7.00.008

getName

public java.lang.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", "Tasks", "Intray".

Specified by:

getName in class ViewAdapter

Returns:

String

getDirectory

public java.io.File getDirectory()

Liefert das Postbox-Verzeichnis aus dem lokalen Dateisystem.

Returns:

File

Since:

6.00.100

refresh

public void refresh()

Description copied from class: ViewAdapter

Aktualisiert den Inhalt dieser Ansicht.

Specified by:

refresh in class ViewAdapter

getScanProfileName

public final java.lang.String getScanProfileName()

Liefert den Namen des aktuell aktiven Scan-Profiles.

Returns:

Name des Scan-Profiles. Falls kein Scan-Profile definiert oder selektiert wurde, wird ein Leerstring zurückgegeben.

Since:

7.00.000

insertFile

public IntrayDocument insertFile(java.io.File file)
                          throws java.io.IOException

Fügt eine Dokument-Datei in die Postbox ein. Die Originaldatei wird dabei kopiert.

Parameters:

file - Originaldatei

Returns:

IntrayDocument Kopiertes Postbox-Dokument

Throws:

java.io.IOException

Since:

7.00.004