JqmPage Method (RUNTIME)

PLB Web Only, 10.0

The JqmPage method manipulates the PWS RUNTIME page stack used to manage the forward and backward jQuery Mobile paging. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A RUNTIME object that has been previously declared.

return

Optional. A Numeric Variable whose value depends on the specific {action} being performed.

action

Required. A Numeric Variable or decimal number that specifies a numeric value that gives the action to be performed using the runtime page stack.

position

Optional. A Numeric Variable or decimal number that specifies a numeric value that gives the one based position value used for the {action} being performed.

transition

Optional. A Character String Variable or string or literal that specifies the default transition effect on page navigation.

options

Optional. A Numeric Variable or decimal number that specifies a bit mask value that defines jQuery options used by jQuery pages.

Flags Affected: OVER, ZERO

Note the following:

1. The ZERO flag is always set when the {return} value is zero.

2. The OVER flag is set if the {return} variable is too small to receive the numeric result.

3. The {return} values are described as follows:

 

Action	Meaning
All Actions	Zero is always returned if the JQuery Mobile mode is not being used.
$JQMPAGE_BACK	Zero is returned if the action position does not exist in the runtime page stack. Otherwise, the stack position is returned after the action is completed.
$JQMPAGE_COUNT	Return the current count of pages.
$JQMPAGE_OBJECTID	Zero is returned if the action position does not exist in the runtime page stack. Otherwise, the OBJECTID of the last or given position page is returned.
$JQMPAGE_WEBID	Zero is returned if the action position does not exist in the runtime page stack. Otherwise, the WEBID number of the last or given position page is returned. This WEBID number can be combined in a format of as "CnnnD" which is the same expected format as retrieved by the 'GetWebId' method for PWS WINDOW.
$JQMPAGE_REMOVE	Zero is always returned.
$JQMPAGE_REMOVEALL	Zero is always returned.

 

4. The required {action} values are defined as follows:

 

Action	Value	Meaning
$JQMPAGE_BACK	1	Zero is always returned if the JQuery Mobile mode is not being used.
$JQMPAGE_COUNT	2	Return the current count of pages.
$JQMPAGE_OBJECTID	3	Return the OBJECTID of the last or given position page.
$JQMPAGE_WEBID	4	Return the WEBID of the last or given position page.
$JQMPAGE_REMOVE	5	Remove the last or given position page from the runtime page stack.
$JQMPAGE_REMOVEALL	6	Clear the runtime page stack.

 

5. The optional {position} is a one based value that gives the PWS runtime page stack position used when performing the {action} operation. If the {position} parameter is not used for this method, the default position depends on the {action} being used.

 

Action	Value	Meaning
$JQMPAGE_BACK	1	On a $JQMPAGE_BACK action, the {position} gives the page to go back to. If the {position} parameter is not used, the action goes to a position that is one less than the last active position.
$JQMPAGE_COUNT	2	The {position} parameter is ignored for this action.
$JQMPAGE_OBJECTID	3	The {position} value gives the page from which the OBJECTID is retrieved. If the {position} parameter is not used, the last active page position is used from which the OBJECTID is retrieved.
$JQMPAGE_WEBID	4	The {position} value gives the page from which the WEBID is retrieved. If the {position} parameter is not used, the last active page position is used from which the WEBID is retrieved.
$JQMPAGE_REMOVE	5	The {position} value gives the page position that is removed from the runtime page stack. If the {position} parameter is not used, the last active page position is removed.
$JQMPAGE_REMOVEALL	6	The {position} parameter is ignored for this action.

 

6. When using JQuery Mobile mode, the PWS TOOLBAR and standard MENUs are not supported.

See Also: RUNTIME, RUNTIME Methods, Method Syntax