draw_xml_header procedure

Related topics

Contained in package wwui_api_portlet.

This procedure draws the header for XML portlets. The portlet Show method can call this procedure when the page calls portlet.show.

This procedure generates HTML that follows the XML standard.

Note: It is recommended that the portlet header be drawn if the has_title property passed to the Show method is TRUE.

procedure draw_xml_header
(
p_provider_id in integer,
p_portlet_id in integer,
p_title in varchar2,
p_has_details in boolean default FALSE,
p_has_edit in Boolean default FALSE,
p_has_edit_defaults in Boolean default FALSE,
p_has_help in Boolean default FALSE,
p_has_about in Boolean default FALSE,
p_referencepath varchar2,
p_back_url in varchar2 default NULL
);

Version: Oracle Portal 3.0.6.6.5 or later

Parameters:

p_provider_id

The ID of the provider to which the portlet belongs.

Datatype: in integer

p_portlet_id

The portlet ID.

Datatype: in integer

p_title

The portlet title.

Datatype: in varchar2

p_has_details

Whether the portlet implements mode_show_details.

MODE_SHOW_DETAILS is one of the display modes of the show_portlet method (database provider) and of PortletRenderer.render (Web provider). It displays detailed information implemented by the portlet.

Datatype: in Boolean
Default: FALSE

p_has_edit

Whether the portlet implements mode_show_edit.

MODE_SHOW_EDIT is one of the display modes of the show_portlet method (database provider) and of PortletRenderer.render (Web provider). It implements an interface for user customizations for an individual instance of a portlet.

Notes:

A portlet instance refers to the placement of an individual portlet on a Oracle Portal page.

User customizations are values that a user can modify to change the appearance/content of individual portlet.

Datatype: in Boolean
Default: FALSE

p_has_edit_
defaults

Whether the portlet implements mode_show_edit_defaults.

MODE_SHOW_EDIT_DEFAULTS is one of the display modes of the show_portlet method (database provider) and of PortletRenderer.render (Web provider). It implements an interface for default customizations for a individual instance of a portlet.

Notes:

A portlet instance refers to the placement of an individual portlet on a Oracle Portal page.

Default customizations are values that can be modified to change the appearance and content of a portlet for all users.

Datatype: in Boolean
Default: FALSE

p_has_help

Whether the portlet implements mode_show_help, i.e. can display help information about the portlet.

Datatype: in Boolean
Default: FALSE

p_has_about

Whether the portlet implements mode_show_about, i.e. can display information such as that found in the About box of any application.

Datatype: in Boolean
Default: FALSE

p_referencepath

The portlet instance ID.

A portlet instance refers to the instantiation of an individual portlet on a Portal page. The value for p_reference_path passed into the Show method in the portlet record should be used for this parameter.

Datatype: varchar2

p_back_url

The URL for the calling page passed through the links generated in the portlet header.

The value for the p_back_url parameter should be set to the value of the p_portlet_record.page_url, passed on the Show method.

Datatype: in varchar2
Default: null

Exceptions:

This procedure does not raise any exceptions.

Example:

if (p_portlet_record.has_title_region) then

/*

Draw the XML portlet header and specify what links are available

from that header (i.e. details, customize, help, and about).

The has_title property is set at the page region level.

*/

wwui_api_portlet.draw_xml_header(

p_provider_id => p_portlet_record.provider_id,

p_portlet_id => p_portlet_record.portlet_id,

p_title => 'Title',

p_has_details => true,

p_has_edit => true,

p_has_help => true,

p_has_about => true,

p_referencepath => p_portlet_record.reference_path,

p_back_url => p_portlet_record.page_url);

end if;

Version: Oracle Portal 3.0.6.6.5 or later
Parameters:
p_provider_id	The ID of the provider to which the portlet belongs. Datatype: in integer
p_portlet_id	The portlet ID. Datatype: in integer
p_title	The portlet title. Datatype: in varchar2
p_has_details	Whether the portlet implements mode_show_details. MODE_SHOW_DETAILS is one of the display modes of the show_portlet method (database provider) and of PortletRenderer.render (Web provider). It displays detailed information implemented by the portlet. Datatype: in Boolean Default: FALSE
p_has_edit	Whether the portlet implements mode_show_edit. MODE_SHOW_EDIT is one of the display modes of the show_portlet method (database provider) and of PortletRenderer.render (Web provider). It implements an interface for user customizations for an individual instance of a portlet. Notes: A portlet instance refers to the placement of an individual portlet on a Oracle Portal page. User customizations are values that a user can modify to change the appearance/content of individual portlet. Datatype: in Boolean Default: FALSE
p_has_edit_ defaults	Whether the portlet implements mode_show_edit_defaults. MODE_SHOW_EDIT_DEFAULTS is one of the display modes of the show_portlet method (database provider) and of PortletRenderer.render (Web provider). It implements an interface for default customizations for a individual instance of a portlet. Notes: A portlet instance refers to the placement of an individual portlet on a Oracle Portal page. Default customizations are values that can be modified to change the appearance and content of a portlet for all users. Datatype: in Boolean Default: FALSE
p_has_help	Whether the portlet implements mode_show_help, i.e. can display help information about the portlet. Datatype: in Boolean Default: FALSE
p_has_about	Whether the portlet implements mode_show_about, i.e. can display information such as that found in the About box of any application. Datatype: in Boolean Default: FALSE
p_referencepath	The portlet instance ID. A portlet instance refers to the instantiation of an individual portlet on a Portal page. The value for p_reference_path passed into the Show method in the portlet record should be used for this parameter. Datatype: varchar2
p_back_url	The URL for the calling page passed through the links generated in the portlet header. The value for the p_back_url parameter should be set to the value of the p_portlet_record.page_url, passed on the Show method. Datatype: in varchar2 Default: null
Exceptions: This procedure does not raise any exceptions. Example: if (p_portlet_record.has_title_region) then /* Draw the XML portlet header and specify what links are available from that header (i.e. details, customize, help, and about). The has_title property is set at the page region level. */ wwui_api_portlet.draw_xml_header( p_provider_id => p_portlet_record.provider_id, p_portlet_id => p_portlet_record.portlet_id, p_title => 'Title', p_has_details => true, p_has_edit => true, p_has_help => true, p_has_about => true, p_referencepath => p_portlet_record.reference_path, p_back_url => p_portlet_record.page_url); end if;

Related topics
UI portlet API package	PDK PL/SQL API Reference - Home