SipButton Module

RhoElements 2.x API

Overview

The SipButton Module is used to set the parameters of the SIP Button, which toggles the display of the soft input panel and allows keyboard input via a stylus.

Syntax

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");

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

NamePossible ValuesDescriptionDefault Value
left:[Value] Positive number, representing pixelsSets the X position of the SIP button.Bottom right of the screen
top:[Value] Positive number, representing pixelsSets the Y position of the SIP button.Bottom right of the screen
height:[Value] Positive number, representing pixelsSets the height of the SIP button.Dependant on screen resolution
width:[Value] Positive number, representing pixelsSets the width of the SIP button.Dependant on screen resolution
imageUp:[Value] URLSets the image to be displayed when the SIP Button is in the up state. See Remarks.Default image
imageDown:[Value] URLSets the image to be displayed when the SIP Button is in the down state. See Remarks.Default image
visibility:[Value] Visible, HiddenSets the visibility of the SIP 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.

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) (Not applicable to Enterprise Tablet).

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.

Requirements

RhoElements Version1.0.0 or above
Supported DevicesAll supported touch devices.
Minimum RequirementsNone.
PersistencePersistent - Changes to this module will persist when navigating to a new page.

HTML/JavaScript Examples

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">