Warning Older Docs! - You are viewing documentation for a previous released version of RhoMobile Suite.

BottomCommandArea Module

The BottomCommandArea Module is used to set the parameters of the Bottom Command Area. The bottom command area is a region at the bottom of the screen designed to hold RhoElements controls such as the SIP button or Zoom button to separate them from the rest of the user application.

Syntax

bottomCommandArea (Module) <META> Syntax

<META HTTP-Equiv="BottomCommandArea" content="[parameter]">

BottomCommandArea JavaScript Object Syntax:
By default the JavaScript Object 'bottomCommandArea' will exist on the current page and can be used to interact directly with the bottomCommandArea.
To Set bottomCommandArea parameters via JavaScript use the following syntax: bottomcommandarea.parameter = 'value'; remembering to enclose your value in quotes where appropriate.

e.g. bottomCommandArea.visibility = 'value';
To set multiple EMML parameters / events on a single line use the following syntax: bottomcommandarea.setEMML("[Your EMML Tags]");

e.g. bottomCommandArea.setEMML("visibility:value");
BottomCommandArea Ruby Object Syntax:
By default the Ruby Object 'BottomCommandArea' will exist on the current page and can be used to interact directly with the BottomCommandArea. All Methods, Parameters and Events are the same as JavaScript, however, notice 'BottomCommandArea' needs to start with an uppercase letter. Another difference in Ruby is that methods do not end in '()'
To Set BottomCommandArea parameters via Ruby use the following syntax: BottomCommandArea.parameter = 'value' remembering to enclose your value in quotes where appropriate.

e.g. BottomCommandArea.visibility = 'value'

Parameters

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

Name Possible Values Description Default Value
visibility:[Value] visible, hidden Sets the Visibility of the Bottom Command area. Hidden.
height:[Value] Positive number, representing pixels Sets the height of the bottom command area Slightly greater than the height of a buttons default height, which depends on the screen resolution.
color:[Value] Color in the #RRGGBB format The color to set the bottom command area to. None. The default image is displayed by default.
image:[Value] URL Sets the image to be displayed on the bottom command area. See Remarks. Default image

Remarks

Use of Images.

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 command area. 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)

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 Version 1.0.0 or above
Supported Devices All supported 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 BottomCommandArea, sets the height to 100 pixels and background color to red.

<META HTTP-Equiv="BottomCommandArea" Content="Visibility:Visible">
<META HTTP-Equiv="BottomCommandArea" Content="Height:100">
<META HTTP-Equiv="BottomCommandArea" Content="Color:#FF0000">

The following example shows the BottomCommandArea, sets the height to 100 pixels and displays image bca.gif on it (resizing the image if necessary).

<META HTTP-Equiv="BottomCommandArea" Content="Visibility:Visible; Height:100; Image:url('http://myaddress/bca.gif')">
Back to Top