JqmOptions Method (RUNTIME)

PLB Web Only, 10.0

The JqmOptions method sets global JQuery Mobile options used by the PWS runtime to control\customize the JQuery Mobile visual properties\attributes for WINDOW objects (i.e., pages) when they are created. 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 a Numeric Variable that returns the pass\failure values for the execution of the method.

header

Optional. A Character String Variable or string or literal that specifies a html string that is used as the page header. If this parameter is not used, the default is to not have a page header.

footer

Optional. A Character String Variable or string or literal that specifies a html string that is used as the page footer. If this parameter is not used, the default is to not have a page footer.

transition

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

theme

Optional. A Character String Variable or string literal that specifies a single character of 'a' to 'z'. The single character defines the color scheme (swatch) used for the jQuery page widget.

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 which indicates that the method execution was successful. The ZERO flag is clear if the {return} value is not zero which indicates that the method execution failed.

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

3. This method only takes affect when the PWS runtime is executing in the JQuery Mobile mode. The JQuery Mobile mode is activated when the '.plm' or 'plcm' mime type starts the PL/B program in the client browser URL string.

4. The {transition} value can be one of the following words: fade, pop, flip, turn, flow, slidefade, slide, slideup, slidedown, or none.

5. A demonstration of the {transition} can be found at the following link:

 

http://demos.jquerymobile.com/1.4.5/transitions/

 

6. The Sunbelt sample program named 'jqmsamp' uses advanced PLB operations to demonstrate the PL/B jQuery Mobile Support. See the zip file named 'DemoJqmSamp.zip' found in the 'demo' directory for a PL/B Web Server as follows:

 

c:\sunbelt\plbwebsrv.10x\demo

 

7. The {options} bitmask value allows for special options to be specified when a jQuery page is created. The {options} bitmask values are described as follows:

 

Keyword	Value	Description
$JQMOPT_AUTO_ENHANCE	1	Automatically enhance basic controls. This option enhances the following objects: BUTTON, CHECKBOX, and RADIOBUTTON. Each enhanced control will have the height and fontsize properties overridden by the enhancement option.
$JQMOPT_FIXED_HDRFTR	2	Fix header and footer to top and bottom of a WINDOW.
$JQMOPT_KEEP_OPTIONS	4	Keep all JQM options through a PL/B CHAIN statement operation.
$JQMOPT_NO_BGCOLOR	8	Do not use background color properties.

 

8. The {return} value always returns the numeric result of zero when this method is executed with JQuery Mobile in use. If this method is executed when the JQuery Mobile is not used, a value of one is always returned.

 

9. Example JqmOptions Statements where R is a RUNTIME object:

 

R.JqmOptions	Using *HEADER="<a data-plbid='change'
	href='##'> Change</a>
	<h1 style='height: 2em'>
	Collapsible</h1><a data-plbid='stop'
	ref='##'>Stop</a>":
	*FOOTER="<h4>JQM Test</h4>":
	*Options=2

 

 

 

R.JqmOptions	Using *HEADER="<a data-plbid='change'
	href='##'>Change</a>
	<h1 style='height: 2em'>
	Testing</h1><a data-plbid='stop'
	href='##'>Stop</a>":
	*FOOTER="<h4>JQM4 Test</h4>":
	*Options=2

See Also: RUNTIME, RUNTIME Methods, Method Syntax