Overview
The StopButton Module is used to set the parameters of the Stop Button, which is displayed only while a page is loading. When clicked, the Stop Button ceases the current navigation and brings up the badlink page (if defined), preventing partially rendered pages being displayed in the browser.
Syntax
| stopButton (Module) <META> Syntax |
|---|
<META HTTP-Equiv="StopButton" content="[parameter]"> |
| StopButton JavaScript Object Syntax: |
|---|
| By default the JavaScript Object 'stopButton' will exist on the current page and can be used to interact directly with the stopButton. |
|
To Set stopButton parameters via JavaScript use the following syntax: stopbutton.parameter = 'value'; remembering to enclose your value in quotes where appropriate.
e.g. stopButton.left = 'value'; |
|
To set multiple EMML parameters / events on a single line use the following syntax: stopbutton.setEMML("[Your EMML Tags]");
e.g. stopButton.setEMML("left:value"); |
Parameters
Items listed in this section indicate parameters, or attributes which can be set.
| Name | Possible Values | Description | Default Value |
|---|---|---|---|
| left:[Value] | Positive number, representing pixels | Sets the X position of the Stop button. | Same location as the 'Go' Button |
| top:[Value] | Positive number, representing pixels | Sets the Y position of the Stop button. | Same location as the 'Go' Button |
| height:[Value] | Positive number, representing pixels | Sets the height of the Stop button. | Dependant on screen resolution |
| width:[Value] | Positive number, representing pixels | Sets the width of the Stop button. | Dependant on screen resolution |
| imageUp:[Value] | URL | Sets the image to be displayed when the Stop Button is in the up state. See Remarks. | Default image |
| imageDown:[Value] | URL | Sets the image to be displayed when the Stop Button is in the down state. See Remarks. | Default image |
| visibility:[Value] | Visible, Hidden | Sets the visibility of the Stop button. | Hidden. |
Remarks
Use of Images on Buttons.
Images can be specified as local to the device or on an HTTP / FTP server, just specify the required protocol as part of your URL (file://, HTTP:// and FTP://). Image will be scaled to the size of the button. JPEG and GIF images are only supported on WM devices. Both CE and WM support BMP files.
Default Positions
By default this control will be placed a the top of the screen. On Windows Mobile if the 'FullScreen' configuration setting is disabled the control will need to be moved, otherwise it will appear beneath the task bar.
Switching to Other Applications
All controls are designed to be shown on top of RhoElements. If you require to switch to an application other than RhoElements you should minimize RhoElements to ensure the buttons do not remain shown. (Not applicable to Enterprise Tablet)
Visibility of Stop Button
Depending on how quickly the navigation is completed, whether the target page is cached, and what operating system the device is using, the stop button may not be visible immediately after starting navigation.
Screen Orientation
When the screen orientation changes, either using the ScreenOrientation tag or by rotating a device with hardware support, the command areas will automatically move and resize to fit the new layout. However the buttons themselves are not moved and in some cases this may result in them being off the screen or not in the expected position. If so they must be moved manually by detecting the ScreenOrientationEvent.
Use in Production
This API is designed for debugging your application only and should not be used in production
Requirements
| RhoElements Version | 1.0.0 or above |
|---|---|
| Supported Devices | All supported touch devices. |
| Minimum Requirements | None. |
| Persistence | Persistent - Changes to this module will persist when navigating to a new page. |
HTML/JavaScript Examples
The following example shows the Stop button and sets the left and top coordinates to 50.
<META HTTP-Equiv="StopButton" Content="Visibility:Visible">
<META HTTP-Equiv="StopButton" Content="Left:50">
<META HTTP-Equiv="StopButton" Content="Top:50">
The following example shows the Stop button and displays the stop_up.gif / stop_down images on it (resizing the images if necessary).
<META HTTP-Equiv="StopButton" Content="ImageUp:url('http://myaddress/stop_up.gif'); ImageDown:url('http://myaddress/stop_down.gif'); Visibility:Visible">