rim:transitionEffect element

Syntax

<rim:transitionEffect type="string"
     duration="string"
     direction="string" />

Description

The <rim:transitionEffect> element specifies the type and properties of a transition effect that appears when the BlackBerry WebWorks app transitions between screens. The transition effect is not used for the initial loading screen, but you must define it within the <rim:loadingScreen> element.

This element is optional.

Comptibility note

If you port your app to BlackBerry 10, you will need to use the <rim:splash> and <param> elements instead.

Parent elements

<rim:loadingScreen>

Child elements

None

Occurrences

Zero or one

Attributes

You can use the following attributes in this element:

Attribute

Description

type

The type attribute specifies the transition effect to use between screens in the app.

You can specify the following values for this attribute:
  • slideOver
  • fadeIn
  • fadeOut
  • wipeIn
  • wipeOut
  • zoomIn
  • slidePush
  • zoomOut

Note that slideOver, wipeIn, and wipeOut behave the same. fadeIn and fadeOut also behave the same.

This attribute is required.

duration

The duration attribute specifies the time it takes, in milliseconds, to complete the transition.

The value for this attribute must be an integer between 250 and 1000. If you specify a value greater than 1000, the value is set to 1000. If you specify a value less than 250, the value is set to 250.

If you do not specify a value, the value is set to 250.

This attribute is optional.

direction

The direction attribute specifies the direction of the screen effect. Values for this attribute include left, right, up, and down. This attribute is valid for the following effects:
  • wipeIn
  • wipeOut
  • slideIn
  • slideOut

If you do not specify a direction, the transition moves toward the left side of the screen.

This attribute is optional.

Example: Specifying a transition effect

<rim:loadingScreen backgroundColor="#AAA000" onLocalPageLoad="true">
   <rim:transitionEffect type="zoomIn" />
</rim:loadingScreen>

Last modified: 2013-10-02