Show TOC

XHTMLB TransformerLocate this document in the navigation structure

Use

The XHTMLB transformer is a SAX transformer that transforms between XHTMLB (see the XHTMLB Specification for details about the format) and HTMLB DOM. The result of the transformation is a set of HTMLB objects ready to be rendered or to be included to other HTMLB objects. If you provide an HTMLB container it will contain the created HTMLB objects. If no container is provided, the transformer will create an HTMLB form document. The component Id is generated when the ID attribute for the XHTMLB element is not specified.

Caution

This transformer must be the last one in the transformer list.

The attributes of the XHTMLB transformer are as follows:

Attribute

Value

Name

XHTMLBSAXHandler

Version

1.0

From scheme

XHTMLB

To scheme

HTML

Parameters

The parameters have the format:

ITransformerService.BUILT_IN_TRANSFORMERS_KEY.<parameter>

Following parameters are available:

Parameter

Type (Default value)

Description

DebugMode

Boolean (false)

In DebugMode (value set to true), debug logs and traces are appended at the end of the top container. The logs include error notifications, trace of every component that was created and general status information.

An enabled DebugMode slows down the transformation process.

HTMLBTopContainer

Inherited from com.sapportals.htmlb. Container

Top container that contains all the HTMLB objects that are created in the transformation process of the XHTMLB document.

When no value is specified, the transformer will try to get the HTMLB document from the page context. If no document can be found, it will create a form document as the top container. You can get the created document from the page context object (method IPageContext.getDocument() ).

HTMLBDeclaredComponents

java.util.Map (null)

This parameter specified a Map object that receives the components with a given ID. The Map object can be used to get the objects and manipulate them.

When no Map is specified, the declared components are treated as any other component.

HTMLBRenderAtEnd

Boolean (true)

This flag defines if the created document to the response is rendered when the transformation is finished.

Error Handling

When the DebugMode is enabled, all error and trace messages are placed as plain HTML text at the end of the top container. No exception is thrown when a method or parameter is used that do not exist.

Not Supported HTMLB Components:

Following HTMLB components are not supported:

  • MenuBar

  • MenuItem

  • Chart

  • FormLayout

  • DragSource

  • DropTarget

  • EventValidationComponent

  • EventValidationContainer

  • JavaScriptFragment

  • PopupTrigger

  • RoadMap

  • RoadMapItem