Ansicht
Dokumentation

/IPRO/EDITOR - Replace Editor

/IPRO/EDITOR - Replace Editor

CPI1466 during Backup   General Material Data  
This documentation is copyright by SAP AG.
SAP E-Book

Use

Implement this Business Add-In to replace the BTF editor in SAP Document Builder with another.

The Business Add-In consists of the methods described below, which can be used to override the display and data capturing of the editor.

RENDER

This method is used to render the editor in the browser.

The following parameters are available:

  • IV_ID
    ID of this HTML tag in the browser.
  • IO_DATA
    Reference to the text object that contains the text to be displayed in the browser.
  • IV_DISABLED
    Set to 'X' if the editor should be disabled. This is used when the parent document is read-only.
  • IV_SOURCEVIEW
    If set, indicates that the editor should if possible display the source window instead of the WYSIWYG view.
  • IV_OUTPUT_TYPE
    Determines the output type of the element to be rendered. This allows the editor to edit different output types.
  • VALUE
    Location where the HTML to be rendered must be stored. This contains all the coding to render the editor.

GET_DATA

This method is used to retrieve the data from the HTTP request for editor.

The following parameters are available:

  • IO_DOC_TEXT
    Reference to the text object that contains the text. This must be updated with the data received from the request.
  • IO_REQUEST
    Reference to the request object. The data entered in the editor can be retrieved from the form fields in this object using the ID of the hidden data field. The ID is the value of IV_ID with '_DATA' appended.
  • IV_ID
    ID of the editor tag in the browser.
  • VALUE
    Received data as an HTML string to be returned.

Requirements

Standard settings

Activities

After calling up the IMG activity, a dialog box appears, in which you can enter a name for the implementation.

If you have already made other implementations for this BAdI, another dialog box appears, in which the existing implementations are displayed. In this case, choose Create, and proceed as follows:

1. In the dialog box, enter a name for the BAdI implementation in the Implementation field, and choose Create.

The screen for creating BAdI implementations is now displayed.

2. Enter a short text for the implementation in the Short text for implementation field.

3. From the tab index, choose Interface.

The Name of implemented class field is already filled on the tab page, as a class name was automatically assigned to the implementation when you named it.

4. Save your entries, and assign the implementation to a development class.

5. Place the cursor on the method, and double-click to enter method processing.

6. Enter the coding for the implementation between the statements method ~ and endmethod.

7. Save and implement your coding. Return to the Edit Implementation screen.

8. Save the entries on the Edit Implementation screen.

Note: You can also create an implementation, and then activate it at a later time. In such a case, end the processing stage at this point.

9. Choose Activate.

The coding you stored in the methods will be run when the application program is executed.






Addresses (Business Address Services)   CPI1466 during Backup  
This documentation is copyright by SAP AG.

Length: 3937 Date: 20240328 Time: 094444     sap01-206 ( 49 ms )