render_portlet_top procedure

Related topics

Contained in package wwui_api_portlet.

Call this proceure to draw the top (or header) of a portlet. The portlet Show method can call this procedure when the page calls portlet.show.

Note: Use this procedure with PDK-Java (JPDK) v2 and later. It replaces the draw_portlet_header procedure used in earlier releases of Oracle Portal.

procedure render_portlet_top
(
p_portlet_record in wwpro_api_provider.portlet_runtime_record,
p_title in varchar2 default null,
p_show_details in boolean default false,
p_show_edit in boolean default false,
p_show_help in boolean default false,
p_show_about in boolean default false
);

Version: Oracle Portal 9.0.2 or later

Parameters:

p_portlet_record

The portlet_runtime_record that was passed to the Show method of the portlet.

Datatype: in wwpro_api_provider.portlet_runtime_record

p_title

The portlet title.

Datatype: in varchar2
Default: null

p_show_details

Whether the portlet displays a Details link.

Datatype: in boolean
Default: FALSE

p_show_edit

Whether the portlet displays a Customize link.

Datatype: in boolean
Default: FALSE

p_show_help

Whether the portlet displays a Help link.

Datatype: in boolean
Default: FALSE

p_show_about

Whether the portlet displays an About link.

Datatype: in boolean
Default: FALSE

Exceptions:

This procedure does not raise any exceptions.

Example:

-- Render the top of the portlet (Open the portlet)
wwui_api_portlet.render_portlet_top(
p_portlet_record => p_portlet_record, --- pass the portlet record as is
p_title => 'My Portlet Title' --- title of portlet
p_show_details => false, --- don't display details link
p_show_edit => true, --- display customize link
p_show_help => true, --- display help link
p_show_about => true --- display about link
);

-- Render the content of your portlet (Only if portlet is not collapsed)
if not p_portlet_record.is_collapsed then

<Code to print out the content of your portlet>

end if;

Version: Oracle Portal 9.0.2 or later
Parameters:
p_portlet_record	The portlet_runtime_record that was passed to the Show method of the portlet. Datatype: in wwpro_api_provider.portlet_runtime_record
p_title	The portlet title. Datatype: in varchar2 Default: null
p_show_details	Whether the portlet displays a Details link. Datatype: in boolean Default: FALSE
p_show_edit	Whether the portlet displays a Customize link. Datatype: in boolean Default: FALSE
p_show_help	Whether the portlet displays a Help link. Datatype: in boolean Default: FALSE
p_show_about	Whether the portlet displays an About link. Datatype: in boolean Default: FALSE
Exceptions: This procedure does not raise any exceptions. Example: -- Render the top of the portlet (Open the portlet) wwui_api_portlet.render_portlet_top( p_portlet_record => p_portlet_record, --- pass the portlet record as is p_title => 'My Portlet Title' --- title of portlet p_show_details => false, --- don't display details link p_show_edit => true, --- display customize link p_show_help => true, --- display help link p_show_about => true --- display about link ); -- Render the content of your portlet (Only if portlet is not collapsed) if not p_portlet_record.is_collapsed then <Code to print out the content of your portlet> end if;

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