Oracle apex with javascript

14 APEX_JAVASCRIPT

The APEX_JAVASCRIPT package provides utility functions for adding dynamic JavaScript code to HTTP output. This package is usually used for plug-in development.

• ADD_3RD_PARTY_LIBRARY_FILE Procedure
• ADD_ATTRIBUTE Function Signature 1
• ADD_ATTRIBUTE Function Signature 2
• ADD_ATTRIBUTE Function Signature 3
• ADD_ATTRIBUTE Function Signature 4
• ADD_INLINE_CODE Procedure
• ADD_LIBRARY Procedure
• ADD_ONLOAD_CODE Procedure
• ADD_VALUE Function Signature 1
• ADD_VALUE Function Signature 2
• ADD_VALUE Function Signature 3
• ADD_VALUE Function Signature 4
• Escape Function

ADD_3RD_PARTY_LIBRARY_FILE Procedure

This procedure adds the script tag to load a 3rd party javascript library file and also takes into account the specified Content Delivery Network for the application. Supported libraries include: jQuery, jQueryUI, and jQuery Mobile.

add_3rd_party_library_file ( p_library in varchar2, p_file_name in varchar2, p_directory in varchar2 default null, p_version in varchar2 default null );

Table 14-1 describes the parameters available for the ADD_3RD_PARTY_LIBRARY_FILE procedure.

Table 14-1 ADD_3RD_PARTY_LIBRARY_FILE Parameters

Use one of the c_library_* constants

Specifies the file name without version, .min and .js

Directory where the file p_file_name is located (optional)

If no value is provided then the same version Application Express ships is used (optional)

This example loads the JavaScript file of the Draggable feature of jQuery UI.

apex_javascript.add_3rd_party_library_file ( p_library =>apex_javascript.c_library_jquery_ui, p_file_name => 'jquery.ui.draggable' )

ADD_ATTRIBUTE Function Signature 1

This function returns the attribute and the attribute’s escaped text surrounded by double quotation marks.

This function does not escape HTML tags. It only prevents HTML tags from breaking the JavaScript object attribute assignment. To prevent XSS (cross site scripting) attacks, you must also call SYS.HTF.ESCAPE_SC to prevent embedded JavaScript code from being executed when you inject the string into the HTML page.

APEX_JAVASCRIPT.ADD_ATTRIBUTE ( p_name IN VARCHAR2, p_value IN VARCHAR2, p_omit_null IN BOOLEAN:=TRUE, p_add_comma IN BOOLEAN:=TRUE) RETURN VARCHAR2;

Table 14-2 describes the parameters available in the ADD_ATTRIBUTE function signature 1.

Table 14-2 ADD_ATTRIBUTE Signature 1 Parameters

Name of the JavaScript object attribute.

Text to be assigned to the JavaScript object attribute.

If set to TRUE and p_value is empty, returns NULL.

If set to TRUE, a trailing comma is added when a value is returned.

Adds a call to the addEmployee JavaScript function and passes in a JavaScript object with different attribute values. The output of this call looks like:

As the last attribute you should use the parameter combination FALSE ( p_omit_null ), FALSE ( p_add_comma ) so that the last attribute is always generated. This avoids that you have to check for the other parameters if a trailing comma should be added or not.

apex_javascript.add_onload_code ( 'addEmployee('|| '<'|| apex_javascript.add_attribute('FirstName', sys.htf.escape_sc(l_first_name))|| apex_javascript.add_attribute('LastName', sys.htf.escape_sc(l_last_name))|| apex_javascript.add_attribute('Salary', l_salary)|| apex_javascript.add_attribute('Birthday', l_birthday)|| apex_javascript.add_attribute('isSalesman', l_is_salesman, false, false)|| '>);' );

ADD_ATTRIBUTE Function Signature 2

This function returns the attribute and the attribute’s number.

APEX_JAVASCRIPT.ADD_ATTRIBUTE ( p_name IN VARCHAR2, p_value IN NUMBER, p_omit_null IN BOOLEAN:=TRUE, p_add_comma IN BOOLEAN:=TRUE) RETURN VARCHAR2;

Table 14-3 describes the parameters available in the ADD_ATTRIBUTE function signature 2.

Table 14-3 ADD_ATTRIBUTE Signature 2 Parameters

Name of the JavaScript object attribute.

Number which should be assigned to the JavaScript object attribute.

If set to TRUE and p_value is empty, returns NULL.

If set to TRUE, a trailing comma is added when a value is returned.

ADD_ATTRIBUTE Function Signature 3

This function returns the attribute and a JavaScript boolean of TRUE, FALSE, or NULL.

APEX_JAVASCRIPT.ADD_ATTRIBUTE ( p_name IN VARCHAR2, p_value IN BOLLEAN, p_omit_null IN BOOLEAN:=TRUE, p_add_comma IN BOOLEAN:=TRUE) RETURN VARCHAR2;

Table 14-4 describes the parameters available in the ADD_ATTRIBUTE function signature 3.

Table 14-4 ADD_ATTRIBUTE Signature 3 Parameters

Name of the JavaScript object attribute.

Boolean assigned to the JavaScript object attribute.

If p_omit_null is TRUE and p_value is NULL the function returns NULL.

If set to TRUE a trailing comma is added when a value is returned.

ADD_ATTRIBUTE Function Signature 4

This function returns the attribute and the attribute’s date. If p_value is null the value null is returned.

APEX_JAVASCRIPT.ADD_ATTRIBUTE ( p_name IN VARCHAR2, p_value IN DATE, p_omit_null IN BOOLEAN:=TRUE, p_add_comma IN BOOLEAN:=TRUE) RETURN VARCHAR2;

Table 14-5 describes the parameters available in the ADD_ATTRIBUTE function signature 4.

Table 14-5 ADD_ATTRIBUTE SIgnature 4 Parameters

Name of the JavaScript object attribute.

Date assigned to the JavaScript object attribute.

If p_omit_null is TRUE and p_value is NULL the function returns NULL.

If set to TRUE a trailing comma is added when a value is returned.

ADD_INLINE_CODE Procedure

This procedure adds a code snippet that is included inline into the HTML output. For example, you can use this procedure to add new functions or global variable declarations. If you want to execute code you should use ADD_ONLOAD_CODE Procedure.

APEX_JAVASCRIPT.ADD_INLINE_CODE ( p_code IN VARCHAR2, p_key IN VARCHAR2 DEFAULT NULL);

Table 14-6 describes the parameters available in the ADD_INLINE_CODE procedure.

Table 14-6 ADD_INLINE_CODE Parameters

JavaScript code snippet. For example: $s(‘P1_TEST’,123);

Identifier for the code snippet. If specified and a code snippet with the same name has already been added, the new code snippet is ignored. If p_key is NULL the snippet is always added.

The following example includes the JavaScript function initMySuperWidget in the HTML output. If the plug-in is used multiple times on the page and the add_inline_code is called multiple times, it is added once to the HTML output because all calls have the same value for p_key .

apex_javascript.add_inline_code ( p_code => 'function initMySuperWidget()<'||chr(10)|| ' // do something'||chr(10)|| '>;', p_key => 'my_super_widget_function' );

ADD_LIBRARY Procedure

This procedure adds the script tag to load a JavaScript library. If a library has been added, it is not added a second time.

APEX_JAVASCRIPT.ADD_LIBRARY ( p_name IN VARCHAR2, p_directory IN VARCHAR2, p_version IN VARCHAR2 DEFAULT NULL, p_check_to_add_minified IN BOOLEAN DEFAULT FALSE, p_skip_extension IN BOOLEAN DEFAULT FALSE, p_ie_condition IN VARCHAR2 DEFAULT NULL, p_key IN VARCHAR2 DEFAULT NULL);

Table 14-7 describes the parameters available in the ADD_LIBRARY procedure.

Table 14-7 ADD_LIBRARY Parameters

Name of the JavaScript file. Must not use .js when specifying.

Directory where JavaScript library is loaded. Must have a trailing slash.

If TRUE, the procedure tests if it is appropriate to add .min extension and add it if appropriate. This is added if an application is not running in DEBUG mode, and omitted when in DEBUG mode.

If TRUE the extension .js is NOT added.

Condition which is used as Internet Explorer condition.

Name used to indicate if the library has already been loaded. If not specified, defaults to p_directory||p_name||p_version .

The following example includes the JavaScript library file named my_library.1.2.min.js (if the application is not running in DEBUG mode), or my_library.1.2.js (if the application is running in DEBUG mode), from the directory specified by p_plugin.file_prefix . The addition of the .min extension if the application is not running in DEBUG mode is carried out because p_check_to_add_minified is set to TRUE. Since p_skip_extension is not specified, this defaults to .js . Also, since p_key is not specified, the key defaults to p_plugin.file_prefix||mylibrary.1.2 .

apex_javascript.add_library ( p_name => 'mylibrary.1.2', p_directory => p_plugin.file_prefix, p_check_to_add_minified => true );

ADD_ONLOAD_CODE Procedure

This procedure adds a javascript code snippet to the HTML output which is executed by the onload event. If an entry with the same key exists it is ignored. If p_key is NULL the snippet is always added.

APEX_JAVASCRIPT.ADD_ONLOAD_CODE ( p_code IN VARCHAR2, p_key IN VARCHAR2 DEFAULT NULL);

Table 14-8 describes the parameters available in the ADD_ONLOAD_CODE procedure.

Table 14-8 ADD_ONLOAD_CODE Parameters

Javascript code snippet to be executed during the onload event.

Any name to identify the specified code snippet. If specified, the code snippet is added if there has been no other call with the same p_key . If p_key is NULL the code snippet is always added.

Adds the JavaScript call initMySuperWidget() to the onload buffer. If the plug-in is used multiple times on the page and the add_onload_code is called multiple times, it is added once to the HTML output because all calls have the same value for p_key

apex_javascript.add_onload_code ( p_code => 'initMySuperWidget();' p_key => 'my_super_widget' );

ADD_VALUE Function Signature 1

This function returns the escaped text surrounded by double quotation marks. For example, this string could be returned «That\’s a test» .

This function does not escape HTML tags. It only prevents HTML tags from breaking the JavaScript object attribute assignment. To prevent XSS (cross site scripting) attacks, you must also call SYS.HTF.ESCAPE_SC to prevent embedded JavaScript code from being executed when you inject the string into the HTML page.

APEX_JAVASCRIPT.ADD_VALUE ( p_value IN VARCHAR2, p_add_comma IN BOOLEAN :=TRUE) RETURN VARCHAR2;

Table 14-9 describes the parameters available in the ADD_VALUE signature 1 function.

Table 14-9 ADD_VALUE Signature 1 Parameters

Text to be escaped and wrapped by double quotation marks.

If p_add_comma is TRUE a trailing comma is added.

This example adds some JavaScript code to the onload buffer. The value of p_item.attribute_01 is first escaped with htf.escape_sc to prevent XSS attacks and then assigned to the JavaScript variable lTest by calling apex_javascript.add_value . Add_value takes care of properly escaping the value and wrapping it with double quotation marks. Because commas are not wanted, p_add_comma is set to FALSE.

apex_javascript.add_onload_code ( 'var lTest = '||apex_javascript.add_value(sys.htf.escape_sc(p_item.attribute_01), FALSE)||';'||chr(10)|| 'showMessage(lTest);' );

ADD_VALUE Function Signature 2

This function returns p_value as JavaScript number, if p_value is NULL the value null is returned.

APEX_JAVASCRIPT.ADD_VALUE ( p_value IN NUMBER, p_add_comma IN BOOLEAN :=TRUE) RETURN VARCHAR2;

Table 14-9 describes the parameters available in the ADD_VALUE signature 2 function.

Table 14-10 ADD_VALUE Signature 2 Parameters

Number which should be returned as JavaScript number.

If p_add_comma is TRUE a trailing comma is added. Default is TRUE.

ADD_VALUE Function Signature 3

This function returns p_value as JavaScript boolean. If p_value is NULL the value null is returned.

APEX_JAVASCRIPT.ADD_VALUE ( p_value IN BOOLEAN, p_add_comma IN BOOLEAN :=TRUE) RETURN VARCHAR2;

Table 14-11 describes the parameters available in the ADD_VALUE signature 3 function.

Table 14-11 ADD_VALUE Signature 3 Parameters

Boolean which should be returned as JavaScript boolean.

If p_add_comma is TRUE a trailing comma is added. Default is TRUE.

ADD_VALUE Function Signature 4

This function returns p_value as JavaScript date object, if p_value is NULL the value null is returned.

APEX_JAVASCRIPT.ADD_VALUE ( p_value IN NUMBER, p_add_comma IN BOOLEAN :=TRUE) RETURN VARCHAR2;

Table 14-12 describes the parameters available in the ADD_VALUE signature 4 function.

Table 14-12 ADD_VALUE Signature 4 Parameters

Date which should be returned as JavaScript date object.

If p_add_comma is TRUE a trailing comma is added. Default is TRUE.

Escape Function

This function escapes text to be used in JavaScript. This function makes the following repl a cements:

Table 14-13 Table of Replacement Values

Источник