com.sapportals.portal.prt.service.document

Interface IDocumentHookListener

All Superinterfaces:

EventListener

All Known Subinterfaces:

IDocumentHookService

public interface IDocumentHookListener
extends EventListener

The positions for the hooks inside the HTML-document are defined as keys. * $File: //javabas/com.sap.portal/dev/src/prt/services/com/sapportals/portal/prt/service/document/IDocumentHookListener.java $ Created: Mar 2001 Copyright (c) SAP Portals Europe GmbH 2001 Last modified on $Date: 2001/05/28 $ by $Author: d025785 $ using $Change: 11391 $

Field Summary

static int	BODY_SECTION_BEGIN position key for the beginning of the BODY-section (position behind )
static int	BODY_SECTION_END position key for the end of the BODY-section (position before )
static int	COMPONENT_BEGIN position key for the beginning of a component-section
static int	COMPONENT_END position key for the end of a component-section
static int	DOCUMENT_BEGIN position key for the very first beginning of the document
static int	DOCUMENT_END position key for the end of the document (position behind )
static int	HEAD_SECTION_BEGIN position key for the beginning of the HEAD-section (position behind )
static int	HEAD_SECTION_END position key for the end of the HEAD-section (position before )
static int	HTML_SECTION_BEGIN position key for the beginning of the HTML-section (position behind )
static int	HTML_SECTION_END position key for the end of the HTML-section (position before )
static int	UNSPECIFIED position key for an unspecified position in the document (can be everywhere)

Method Summary

String	doDocumentHook(int documentPosition, IPortalComponentRequest request) A document hook is a method which can be called to insert additional HTML coding into an HTML page.
void	doDocumentHook(int documentPosition, IPortalComponentRequest request, IPortalComponentResponse response) A document hook is a method which can be called to insert additional HTML coding into an HTML page.

Field Detail

UNSPECIFIED

static final int UNSPECIFIED

position key for an unspecified position in the document (can be everywhere)

See Also:

Constant Field Values

DOCUMENT_BEGIN

static final int DOCUMENT_BEGIN

position key for the very first beginning of the document

See Also:

Constant Field Values

HTML_SECTION_BEGIN

static final int HTML_SECTION_BEGIN

position key for the beginning of the HTML-section (position behind )

See Also:

Constant Field Values

HEAD_SECTION_BEGIN

static final int HEAD_SECTION_BEGIN

position key for the beginning of the HEAD-section (position behind )

See Also:

Constant Field Values

HEAD_SECTION_END

static final int HEAD_SECTION_END

position key for the end of the HEAD-section (position before )

See Also:

Constant Field Values

BODY_SECTION_BEGIN

static final int BODY_SECTION_BEGIN

position key for the beginning of the BODY-section (position behind )

See Also:

Constant Field Values

COMPONENT_BEGIN

static final int COMPONENT_BEGIN

position key for the beginning of a component-section

See Also:

Constant Field Values

COMPONENT_END

static final int COMPONENT_END

position key for the end of a component-section

See Also:

Constant Field Values

BODY_SECTION_END

static final int BODY_SECTION_END

position key for the end of the BODY-section (position before )

See Also:

Constant Field Values

HTML_SECTION_END

static final int HTML_SECTION_END

position key for the end of the HTML-section (position before )

See Also:

Constant Field Values

DOCUMENT_END

static final int DOCUMENT_END

position key for the end of the document (position behind )

See Also:

Constant Field Values

Method Detail

doDocumentHook

void doDocumentHook(int documentPosition,
                    IPortalComponentRequest request,
                    IPortalComponentResponse response)

A document hook is a method which can be called to insert additional HTML coding into an HTML page. The desired HTML hook can be written into the response object.

Parameters:

documentPosition - document position (one of the position keys)

request - the portal request object

response - the portal response object

doDocumentHook

String doDocumentHook(int documentPosition,
                      IPortalComponentRequest request)

A document hook is a method which can be called to insert additional HTML coding into an HTML page. The desired HTML hook can be returned as a String

Parameters:

documentPosition - document position (one of the position keys)

request - the portal request object

Returns:

String the desired HTML hook

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._coreservicedeprecated	default	EP-PIN-PRT