Interface if_ixml_renderer
Interface if_ixml_renderer
The iXMLRenderer interface provides access to the iXML libraries rendering functionality.
The iXMLRenderer supports - in contradiction to the iXMLParser interface - only one mode of operation:
DOM-based rendering: In this mode of operation, the XML renderer builds an XML byte-stream representation of the given DOM tree by traversing the tree's nodes.
specializes
enumerations
methods
method is_normalizing
Tests if this renderer is normalizing the document representation of the rendered XML output. When running in normalize mode, the renderer inserts whitespace characters to format the XML document according to the hierarchical structure of its content.
interface
if_ixml_renderer
return value
Returns true if this renderer runs in normalize mode, false otherwise.
abap signature
method is_normalizing
returning
value(rval) type boolean.
method render
This method implements the DOM-based interface to the renderer.
render() returns if the complete DOM-tree has been serialized into the associated output stream or an error occured.
interface
if_ixml_renderer
return value
Returns one of the following return codes:
ixml_mr_renderer_ok = 0
The document was rendered successfully.
ixml_mr_renderer_error = 0x00040004L
A rendering error was encountered while rendering the document.
ixml_mr_renderer_fatal_error = 0x00040005L
A fatal rendering error was encountered while rendering the document.
abap signature
method render
returning
value(rval) type I.
method set_no_escaping
Specifies which special characters this renderer is supposed to reproduce in its output without escaping.
interface
if_ixml_renderer
parameters
no_escaping
The non-escaping special characters as a string. Special characters are: < > & " ' (when rendering HTML with embedded script, declare " and ' as non-escaping).
abap signature
method set_no_escaping
importing
no_escaping type string.
method set_normalizing
Specifies whether this renderer is supposed to normalize the XML output when rendering. When running in normalize mode, the renderer inserts whitespace characters to format the XML document according to the hierarchical structure of its content.
interface
if_ixml_renderer
parameters
is_normalizing
[ default 'X' ]True, if the renderer is supposed to normalize the XML output, false otherwise.
return value
Returns true if this renderer is in normalizing mode, false otherwise.
abap signature
method set_normalizing
importing
is_normalizing type boolean default 'X'
returning
value(rval) type boolean.
method query_interface
Queries the specified interface.
interface
if_ixml_renderer
parameters
iid
The interface ID of the interface to query.
return value
Returns a reference to the queried interface or null if no such interface is supported.
abap signature
method query_interface
importing
iid type I
returning
value(rval) type I.