Ansicht Dokumentation

Wir wachsen stetig und suchen neue Kollegen (m/w/d)! Schauen Sie sich unsere offenen Position an, um eine passende Herausforderung zu finden!

CL_DOCUMENT_HISTORY_DV - Dokumentenviewer

CL_DOCUMENT_HISTORY_DV - Dokumentenviewer

SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up   PERFORM Short Reference  
Diese Dokumentation steht unter dem Copyright der SAP AG.
SAP E-Book

Funktionalität

Klasse ( Control) zur Anzeige von Dokumenten.

Ermöglicht es, beliebige extern abgelegte Dokumente in anwendungseigenen GUI-Containern anzuzeigen.

Methoden, die von nutzenden Applikationen aufgerufen werden können:

ADD_NEW_DOCUMENTS: Einfügen weiterer anzuzeigender Dokumenten in die History

DISPLAY: Anzeige der Dokumente der History

CLOSE_WINDOW: Schließen eines ausgewählten Dokumentes in der History und der Anzeige.

Methoden, die nicht von nutzenden Applikationen aufgerufen werden sollten:

GET_MARKED_DOCUMENT: Funktion, um ein markiertes Dokument abzufragen. Diese Funktion wird bei der Realisierung der Dokumentanzeige in einem separaten Viewer benötigt (s. Klasse CL_DOCUMENT_VIEWER).

Methoden im Einzelnen

Methode CONSTRUCTOR

- erzeugt ein Objekt der Klasse CL_DOCUMENT_HISTORY. Dem Objekt werden direkt bei der Erzeugung anzuzeigende Dokumente im Parameter DOCUMENTS übergeben. Darüberhinaus kann im Parameter VIEWERMODE spezifiziert werden, welche Funktionen (Toolbar) für den Benutzer aktiv sind.

Parameter DOCUMENTS

Die Dokumente werden als Tabelle von der Struktur TOADI übergeben:

,,TOADI-ADID: Dokumentenidentifikation

,,TOADI-AID: Identifikation des Repository, in dem die Dokumente abgelegt sind

,,TOADI-DTI: Dokumentart des Dokumentes

,,TOADI-DCL: Dokumenttyp des Dokumentes

,,TOADI-OTI: Objekttyp des Objektes, mit dem das Dokument verknüpft ist

,,TOADI-OID: Identifikation des Objektes, mit dem das Dokument verknüpft ist

,,TOADI-WID: Window-ID des Fensters, in dem das Dokument angezeigt werden soll

,,TOADI-WTI: Window-Titel des Fensters, in dem das Dokument angezeigt werden soll

Obligatorisch sind die Felder TOADI-ADID, TOADI-AID und entweder TOADI-DTI oder TOADI-DCL. Alle anderen Werte müssen nicht gefüllt sein.

TOADI-OTI und TOADI-OID können übergeben werden, um die generischen Objektdienste in der Dokumentanzeige zu aktivieren (siehe auch Parameter VIEWERMODE).

TOADI-WID und TOADI-WTI spielen nur bei der Anzeige von Dokumenten in eigenem Viewer eine Rolle und sind für die Verwendung als anwendungsintegriertes Control ohne Bedeutung.

Parameter VIEWERMODE

Mit diesem Parameter kann spezifiziert werden, welche Toolbarfunktionen zur Verfügung stehen oder nicht. Auf die Ausprägungen kann über die Typgruppe ALNK zugegriffen werden. Folgende Parameterausprägungen sind vorgesehen:

ALNK_DISPLAY_VIEWERMODE: Alle Funktionen auf Dokumenten inklusive generischer Objektdienste (wenn TOADI-OTI und TOADI-OID übergeben sind) stehen dem Benutzer zur Verfügung.

ALNK_DISPLAY_PLUGINMODE: Die generischen Objektdienste stehen dem Benutzer nicht zur Verfügung. Außerdem stehen die Funktionen, ein Dokument zu markieren bzw. zu schließen, nicht zur Verfügung. Dies ist der Defaultwert des Parameters. Mit diesem Wert sollten alle Anwendungen arbeiten, die das Control CL_DOCUMENT_HISTORY in die eigene Anwendungsoberfläche integrieren, ihr Objekt aber in der betreffenden Oberfläche selbst schon publiziert haben.

ALNK_DISPLAY_PLUGINGOSMODE: Diese Ausprägung entspricht ALNK_DISPLAY_PLUGINMODE, aber die generischen Objektdienste stehen zur Verfügung.

ALNK_DISPLAY_NOBUTTONS: Es stehen weder die generischen Objektdienste noch andere Buttons im Control zur Verfügung. Dieser Modus sollte nur in Ausnahmefällen verwendet werden, da damit dem Benutzer dokumentbezogene Funktionalität genommen wird.

Methode ADD_NEW_DOCUMENTS

Übergabe anzuzeigender Dokumente an erzeugtes Objekt. Die Dokumente werden im Parameter NEW_DOCUMENTS übergeben.

Parameter NEW_DOCUMENTS

siehe Parameterbeschreibung für den Parameter DOCUMENTS in der Construktormethode. Wenn in NEW_DOCUMENTS Dokumente übergeben werden, die das Objekt schon kennt, werden diese neuen Einträge ignoriert.

Methode DISPLAY

Anzeige des aktuellen Dokumentes im Container PARENT, der von der Anwendung übergeben wird. Sind dem Objekt mehrere Dokumente bekanntgemacht worden (über den Constuktor oder die Methode ADD_NEW_DOCUMENTS), wird das erste übergebene Dokument angezeigt.

Parameter PARENT

GUI - Container, in dem die Dokumente angezeigt werden.

Methode CLOSE_WINDOW

Schließen des durch die übergebenen Parameter WINDOW_ID, CONTREP_ID, DOCUMENT_ID und DOCUMENT_CLASS spezifierten Dokumentes. Diese Methode wird typischerweise von Anwendungsentwicklern, die die Klasse CL_DOCUMENT_HISTORY in der eigenen Anwendung als Control integrieren, nicht benötigt.

Parameter

WINDOW_ID, CONTREP_ID, DOCUMENT_ID und DOCUMENT_CLASS definieren eindeutig ein Dokument. Bezogen auf die DOCUMENTS-Struktur (siehe Parameter DOCUMENTS im Construktor) gilt folgende Beziehung:

WINDOW_ID = DOCUMENTS-WID

CONTREP_ID = DOCUMENTS-AID

DOCUMENT_ID = DOCUMENTS-ADID

DOCUMENT_CLASS = DOCUMENTS-DCL.

Beziehungen

Beispiel

siehe Programmbeispiel ARLINK_VIEWER_EXAMPLE, in dem ausgehend von einem Businessobjekt die existierenden Verknüpfungen zu Dokumenten ermittelt werden und diese Dokumente angezeigt werden.

Hinweise

Weiterführende Informationen






PERFORM Short Reference   TXBHW - Original Tax Base Amount in Local Currency  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 6055 Date: 20210512 Time: 174001     sap01-206 ( 69 ms )