Package wwui_api_portlet_dialog

This package contains methods for opening/closing dialogs and creating dialog buttons.

Scope:

Public

Since:

Oracle Portal 3.0.6.6.5

button

type button is record (
    button_name varchar2(2000),
    button_url varchar2(2000)
)

A record structure containing details of a single button.

Fields:

button_name - the display name for a button on a dialog

button_url - the URL associated with the button

Since:

Oracle Portal 3.0.6.6.5

button_list

type button_list is table of button index by binary_integer

An array containing a list of buttons.

Since:

Oracle Portal 3.0.6.6.5

close_dialog

procedure close_dialog(
    p_contenttable in boolean default true,
    p_width in varchar2 default null
) 

Closes a dialog previously opened using the open_dialog procedure.

Example:

  wwui_api_portlet_dialog.close_dialog;
 

Parameters:

p_contenttable - indicates to closeout the user content table

p_width - width of table in which buttons are rendered

Since:

Oracle Portal 3.0.8

create_apply_button

function create_apply_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Apply' given a button URL.

Example:

  wwui_api_portlet_dialog.create_apply_button
  (
   p_button_url    => 'Save(''apply'')',
   p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_button

function create_button(
    p_button_name in varchar2 default null,
    p_button_url in varchar2 default null
) return button

Creates a button record given a button name and URL.

Example:

  wwui_api_portlet_dialog.create_button
  (
       p_button_name   => 'Preview',
       p_button_url    => 'preview_portlet()'
  );
 

Parameters:

p_button_name - the title to be displayed on the button

p_button_url - the URL associated with the button

Returns:

a button

Since:

Oracle Portal 3.0.8

create_cancel_button

function create_cancel_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Cancel' given a button URL.

Example:

  wwui_api_portlet_dialog.create_cancel_button
  (
   p_button_url    => 'Save(''cancel'')',
   p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_close_button

function create_close_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Close' given a button URL.

Example:

  wwui_api_portlet_dialog.create_close_button
  (
       p_button_url    => 'wizard(''close'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_create_button

function create_create_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Create' given a button URL.

Example:

  wwui_api_portlet_dialog.create_create_button
  (
       p_button_url    => 'wizard(''create'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_delete_button

function create_delete_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Delete' given a button URL.

Example:

  wwui_api_portlet_dialog.create_delete_button
  (
       p_button_url    => 'wizard(''delete'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_next_button

function create_next_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Next' given a button URL.

Example:

  wwui_api_portlet_dialog.create_next_button
  (
       p_button_url    => 'wizard(''next'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_no_button

function create_no_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'No' given a button URL.

Example:

  wwui_api_portlet_dialog.create_no_button
  (
       p_button_url    => 'confirmation(''no'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_ok_button

function create_ok_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'OK' given a button URL.

Example:

  wwui_api_portlet_dialog.create_ok_button
  (
   p_button_url    => 'Save(''finish'')',
   p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_preview_button

function create_preview_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Preview' given a button URL.

Example:

  wwui_api_portlet_dialog.create_preview_button
  (
       p_button_url    => 'wizard(''preview'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_previous_button

function create_previous_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Previous' given a button URL.

Example:

  wwui_api_portlet_dialog.create_previous_button
  (
       p_button_url    => 'wizard(''previous'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_reset_button

function create_reset_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Reset' given a button URL.

Example:

  wwui_api_portlet_dialog.create_reset_button
  (
       p_button_url    => 'wizard(''reset'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_reset_default_button

function create_reset_default_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Reset to Default' given given a button URL.

Example:

  wwui_api_portlet_dialog.create_reset_default_button
  (
       p_button_url    => 'wizard(''reset_to_def'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

create_yes_button

function create_yes_button(
    p_button_url in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language
) return button

Creates a button record with the translatable title 'Yes' given a button URL.

Example:

  wwui_api_portlet_dialog.create_yes_button
  (
       p_button_url    => 'confirmation(''yes'')',
       p_language      => 'us'
  );
 

Parameters:

p_button_url - the URL associated with the button

p_language - the language in which the button title is displayed

Returns:

a button

Since:

Oracle Portal 3.0.8

open_dialog

procedure open_dialog(
    p_title in varchar2,
    p_sec_title in varchar2 default null,
    p_dialog_image in varchar2 default null,
    p_help_url in varchar2 default null,
    p_subheader_text in varchar2 default null,
    p_help_text in varchar2 default null,
    p_buttons in button_list,
    p_path_text in varchar2 default null,
    p_language in varchar2 default wwctx_api . get_nls_language,
    p_contenttable in boolean default true,
    p_width in varchar2 default null
) 

Opens a dialog.

Example:

  wwui_api_dialog.open_dialog
   (
     p_title           => 'Dialog',
     p_dialog_image    => dialog.gif,
     p_help_url        => 'javascript:show_context_sens_help()',
     p_subheader_text  => 'SubHeader'
     p_help_text       => 'This is the help text for dialog',
     p_buttons         => l_button_list,
     p_path_text       => 'Path:/Folder1/Folder2');
  end;
 

Parameters:

p_title - the main title for the dialog

p_sec_title - the secondary title displayed below the main title

p_dialog_image - an image to be displayed below the title area

p_help_url - a valid URL for the Help icon (displayed on the title bar)

p_subheader_text - subheader text displayed below the title bar and image

p_help_text - help text (hint text) displayed below the subheader

p_buttons - list of button names and URLs to be displayed on the dialog

p_path_text - the path to be displayed, for example the Folder Path

p_language - the language in which the strings are displayed

p_contenttable - indicates to closeout the user content table

p_width - width of table in which buttons are rendered.

Since:

Oracle Portal 3.0.8