draw_portlet_header procedure

Related topics

Contained in package wwui_api_portlet.

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

This API can be used by the provider to draw the portlet header in the Show mode of the portlet show method. It is recommended that the portlet header be drawn if the has_title property passed to the Show method is true.

Note: If you are using Oracle Portal 9.0.2 or later, it is recommended that you use render_portlet_top to draw the portlet header rather than the draw_portlet_header procedure described here.

procedure draw_portlet_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_show_details in Boolean default true,
p_show_edit in Boolean default true,
p_show_help in Boolean default true,
p_show_about in Boolean default true,
p_show_remove in Boolean default true,
p_show_collapse in Boolean default true,
p_is_collapsed in Boolean default false,
p_referencepath in varchar2,
p_back_url in varchar2 default null,
p_refresh_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.

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 an 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_show_details

Whether the portlet displays detailed information implemented by the portlet.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: TRUE

p_show_edit

Whether the portlet displays a Customize link.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: TRUE

p_show_help

Whether the portlet displays a Help link.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: TRUE

p_show_about

Whether the portlet displays an About link.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: TRUE

p_show_remove

Whether the portlet displays a Remove icon.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: TRUE

p_show_collapse

Whether the portlet displays a Collapse/Restore link.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: TRUE

p_is_collapsed

Whether the portlet content is collapsed.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in Boolean
Default: FALSE

p_referencepath

The portlet instance ID.

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

Datatype: in 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 parameter p_portlet_record.page_url passed on show method.

Datatype: in varchar2
Default: null

p_refresh_url

The URL for the calling page. The page is reloaded/built from the database, rather than from cache.

Note: This field is available with Oracle9iAS Portal 9.0.2 or later.

Datatype: in varchar2
Default: null

Exceptions:

This procedure does not raise any exceptions.

Example:

if (p_portlet_record.has_title_region) then

/*

Draw the 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_portlet_header

(

p_provider_id => p_portlet_record.provider_id,

p_portlet_id => p_portlet_record.portlet_id,

p_title => 'My Portlet 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. 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 an 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_show_details	Whether the portlet displays detailed information implemented by the portlet. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: TRUE
p_show_edit	Whether the portlet displays a Customize link. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: TRUE
p_show_help	Whether the portlet displays a Help link. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: TRUE
p_show_about	Whether the portlet displays an About link. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: TRUE
p_show_remove	Whether the portlet displays a Remove icon. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: TRUE
p_show_collapse	Whether the portlet displays a Collapse/Restore link. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: TRUE
p_is_collapsed	Whether the portlet content is collapsed. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in Boolean Default: FALSE
p_referencepath	The portlet instance ID. A portlet instance refers to the placement of an individual portlet within an individual Oracle Portal page. The value for p_reference_path passed into the Show method in the portlet record should be used for this parameter. Datatype: in 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 parameter p_portlet_record.page_url passed on show method. Datatype: in varchar2 Default: null
p_refresh_url	The URL for the calling page. The page is reloaded/built from the database, rather than from cache. Note: This field is available with Oracle9iAS Portal 9.0.2 or later. Datatype: in varchar2 Default: null
Exceptions: This procedure does not raise any exceptions. Example: if (p_portlet_record.has_title_region) then /* Draw the 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_portlet_header ( p_provider_id => p_portlet_record.provider_id, p_portlet_id => p_portlet_record.portlet_id, p_title => 'My Portlet 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