The SipButton Module is used to set the parameters of the SIP Button. The SIPButton will toggle the display of the soft input panel allowing keyboard input via a stylus.
| sipButton (Module) <META> Syntax |
|---|
<META HTTP-Equiv="SIPButton" content="[parameter]"> |
| SipButton JavaScript Object Syntax: |
|---|
| By default the JavaScript Object 'sipButton' will exist on the current page and can be used to interact directly with the sipButton. |
| To Set sipButton parameters via JavaScript use the following syntax: sipbutton.parameter = 'value'; remembering to enclose your value in quotes where appropriate. e.g. sipButton.left = 'value'; |
| To set multiple EMML parameters / events on a single line use the following syntax: sipbutton.setEMML("[Your EMML Tags]"); e.g. sipButton.setEMML("left:value"); |
| SipButton Ruby Object Syntax: |
|---|
| By default the Ruby Object 'SipButton' will exist on the current page and can be used to interact directly with the SipButton. All Methods, Parameters and Events are the same as JavaScript, however, notice 'SipButton' needs to start with an uppercase letter. Another difference in Ruby is that methods do not end in '()' |
| To Set SipButton parameters via Ruby use the following syntax: SipButton.parameter = 'value' remembering to enclose your value in quotes where appropriate. e.g. SipButton.left = 'value' |
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 SIP button. | Bottom right of the screen |
| top:[Value] | Positive number, representing pixels | Sets the Y position of the SIP button. | Bottom right of the screen |
| height:[Value] | Positive number, representing pixels | Sets the height of the SIP button. | Dependant on screen resolution |
| width:[Value] | Positive number, representing pixels | Sets the width of the SIP button. | Dependant on screen resolution |
| imageUp:[Value] | URL | Sets the image to be displayed when the SIP Button is in the up state. See Remarks. | Default image |
| imageDown:[Value] | URL | Sets the image to be displayed when the SIP Button is in the down state. See Remarks. | Default image |
| visibility:[Value] | Visible, Hidden | Sets the visibility of the SIP button. | Hidden. |
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.
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) (Not applicable to Enterprise Tablet).
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.
| 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. |
The following example shows the SIP button, sets its top and left coordinates to 50, and its width and height to 30 pixels.
<META HTTP-Equiv="SIPButton" Content="Visibility:Visible"> <META HTTP-Equiv="SIPButton" Content="Left:50"> <META HTTP-Equiv="SIPButton" Content="Top:50"> <META HTTP-Equiv="SIPButton" Content="Width:30"> <META HTTP-Equiv="SIPButton" Content="Height:30">
The following example shows the SIP button and displays the sip_up.gif / sip_down.gif image on it (resizing the image if necessary).
<META HTTP-Equiv="SIPButton" Content="ImageUp:url('http://myaddress/sip_up.gif'); ImageDown:url('http://myaddress/sip_down.gif'); Visibility:Visible">