# Titanium.UI.ScrollableView

A view that encapsulates a horizontally-scrolling set of child views, known as pages, navigable using its built-in horizontal swipe gestures.

Availability

0.8

9.2.0

Extends

Titanium.UI.View

# Overview

Android	iOS

Use the Titanium.UI.createScrollableView method or <ScrollableView> Alloy element to create a scrollable view.

The ScrollableView supports an on-screen paging control to indicate whether a previous or next page exists. When the paging control is enabled on iOS, by default it appears as small dots on the bottom of the screen, whereas Android displays arrows on the left and right-hand sides.

Use the cacheSize property to cache views inside the scrollable view. This can be required when using complex view structures in the scrollable view (e.g. map views) and the app might crash if no proper cache size is specified. See the Titanium.UI.ScrollableView.cacheSize documentation for more infos regarding view caching.

Only the scroll event exists for the ScrollableView on Android. To support others, child views may be added to pages, and event listeners added to these views instead of the pages themselves.

In a previous Titanium version for iOS, the maxZoomScale and minZoomScale properties were removed for performance and parity reasons. As they still remain in Titanium.UI.ScrollView, the equivalent functionality may be obtained by adding a ScrollView to ScrollableView. See the "Simple Scrollable View with 2 Zoomable Images" example for a demonstration.

# Examples

# Simple Scrollable View with 3 Views

Create three views and assign them as pages to a scrollable view.

var win = Ti.UI.createWindow();

var view1 = Ti.UI.createView({ backgroundColor:'#123' });
var view2 = Ti.UI.createView({ backgroundColor:'#246' });
var view3 = Ti.UI.createView({ backgroundColor:'#48b' });

var scrollableView = Ti.UI.createScrollableView({
  views:[view1,view2,view3],
  showPagingControl:true
});

win.add(scrollableView);
win.open();

# Simple Scrollable View with 2 Zoomable Images

Create two scroll views, each containing an image view, and assign them as pages to a scrollable view.

var win = Ti.UI.createWindow();
var img1 = Ti.UI.createImageView({
    image:'http://upload.wikimedia.org/wikipedia/commons/thumb/e/ec/' +
    'Mona_Lisa%2C_by_Leonardo_da_Vinci%2C_from_C2RMF_retouched.jpg/' +
    '402px-Mona_Lisa%2C_by_Leonardo_da_Vinci%2C_from_C2RMF_retouched.jpg'
});
var img1Wrapper = Ti.UI.createScrollView({
    maxZoomScale:4.0,
});
img1Wrapper.add(img1);

var img2 = Ti.UI.createImageView({
    image:'http://www.nasa.gov/images/content/' +
    '616903main_rover_comparison1600_1600-1200.jpg'
});
var img2Wrapper = Ti.UI.createScrollView({
    maxZoomScale:4.0,
});
img2Wrapper.add(img2);
var photosView = Ti.UI.createScrollableView({
    showPagingControl:true,
    views:[img1Wrapper, img2Wrapper]
});
win.add(photosView);

# Scrollable View with multiple visible views

Create three views and assign them as pages to a scrollable view. Each page is narrower than a scrollable view, so multiple views are visible at the same time.

var win = Ti.UI.createWindow();

var view1 = Ti.UI.createView({ backgroundColor:'#123' });
var view2 = Ti.UI.createView({ backgroundColor:'#246' });
var view3 = Ti.UI.createView({ backgroundColor:'#48b' });

// Common params
var params = {
  views:[view1,view2,view3],
  clipViews:false,
  showPagingControl:false,
  top: 0
};

if (Ti.Platform.name === 'android') {
  // Android specific params
  params.padding = {
    left:40,
    right:40
  };
} else {
  // iOS specific params
  params.width = '90%';
}
var scrollableView = Ti.UI.createScrollableView(params);
win.add(scrollableView);
win.open();

# Alloy XML Markup

First example as an Alloy view.

<Alloy>
    <Window id="win">
        <ScrollableView id="scrollableView" showPagingControl="true">
            <View id="view1" backgroundColor="#123">
              <Label>View 1</Label>
            </View>
            <View id="view2" backgroundColor="#246">
            <Label>View 2</Label>
            </View>
            <View id="view3" backgroundColor="#48b">
            <Label>View 3</Label>
            </View>
        </ScrollableView>
    </Window>
</Alloy>

# Scrollable View with indicator image (iOS only)

Create three views and assign them as pages to a scrollable view. Assign preferred indicator image. After window opens, update second page indicator image.

var win = Ti.UI.createWindow({ extendSafeArea: false });

var view1 = Ti.UI.createView({ backgroundColor:'#123' });
var view2 = Ti.UI.createView({ backgroundColor:'#246' });
var view3 = Ti.UI.createView({ backgroundColor:'#48b' });
var backwardImage = Ti.UI.iOS.systemImage('backward');
var scrollableView = Ti.UI.createScrollableView({
  views:[view1,view2,view3],
  showPagingControl:true,
  preferredIndicatorImage: backwardImage
});

win.add(scrollableView);
win.addEventListener('open', function () {
  var forwardImage = Ti.UI.iOS.systemImage('forward');
  scrollableView.setIndicatorImageForPage(forwardImage, 1);
});

win.open();

# Properties

# accessibilityHidden

Availability

3.0.0

9.2.0

accessibilityHidden :Boolean

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the UIAccessibility Protocol.

On Android, setting accessibilityHidden calls the native View.setImportantForAccessibility method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and later; if this property is specified on earlier versions of Android, it is ignored.

Default: false

# accessibilityHint

Availability

3.0.0

9.2.0

accessibilityHint :String

Briefly describes what performing an action (such as a click) on the view will do.

On iOS this is a direct analog of the accessibilityHint property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityValue in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default: null

# accessibilityLabel

Availability

3.0.0

9.2.0

accessibilityLabel :String

A succint label identifying the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityLabel property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityValue and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method. Defaults to Title or label of the control.

# accessibilityValue

Availability

3.0.0

9.2.0

accessibilityValue :String

A string describing the value (if any) of the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityValue property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method. Defaults to State or value of the control.

# anchorPoint

Availability

7.5.0

2.1.0

9.2.0

anchorPoint :Point

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use anchorPoint.

Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right corner.

See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration. The default is center of this view.

# animatedCenter READONLY

Availability

0.9

9.2.0

animatedCenter :Point

Current position of the view during an animation.

# apiName READONLY

Availability

3.2.0

9.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# backgroundColor

Availability

0.9

9.2.0

backgroundColor :String | Titanium.UI.Color

Background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI. Defaults to Transparent.

# backgroundDisabledColor

Availability

0.9

backgroundDisabledColor :String

Disabled background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI. Defaults to the normal background color of this view.

# backgroundDisabledImage

Availability

0.9

backgroundDisabledImage :String

Disabled background image for the view, specified as a local file path or URL.

If backgroundDisabledImage is undefined, and the normal background imagebackgroundImage is set, the normal image is used when this view is disabled.

# backgroundFocusedColor

Availability

0.9

backgroundFocusedColor :String

Focused background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

For normal views, the focused color is only used if focusable is true. Defaults to the normal background color of this view.

# backgroundFocusedImage

Availability

0.9

backgroundFocusedImage :String

Focused background image for the view, specified as a local file path or URL.

For normal views, the focused background is only used if focusable is true. If backgroundFocusedImage is undefined, and the normal background image backgroundImage is set, the normal image is used when this view is focused.

# backgroundGradient

Availability

0.9

9.2.0

backgroundGradient :Gradient

A background gradient for the view.

A gradient can be defined as either linear or radial. A linear gradient varies continuously along a line between the startPoint and endPoint.

A radial gradient is interpolated between two circles, defined by startPoint and startRadius and endPoint and endRadius respectively.

The start points, end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:

{ x: 30, y: 30 }

Or:

{ x: '50%', y: '50%' }

When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:

colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]

Android's linear gradients ignores backfillStart and backfillEnd, treating them as if they are true. Android's radial gradients ignore the endPoint property. Defaults to no gradient.

# backgroundImage

Availability

0.9

9.2.0

backgroundImage :String

Background image for the view, specified as a local file path or URL.

Default behavior when backgroundImage is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, textfields, and so on), platform-specific default images are used.

# backgroundLeftCap

Availability

0.9

9.2.0

backgroundLeftCap :Number

Size of the left end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

# backgroundRepeat

Availability

0.9

9.2.0

backgroundRepeat :Boolean

Determines whether to tile a background across a view.

Setting this to true makes the set backgroundImage repeat across the view as a series of tiles. The tiling begins in the upper-left corner, where the upper-left corner of the background image is rendered. The image is then tiled to fill the available space of the view.

Note that setting this to true may incur performance penalties for large views or background images, as the tiling must be redone whenever a view is resized.

On iOS, the following views do not currently support tiled backgrounds:

Default: false

# backgroundSelectedColor

Availability

0.9

backgroundSelectedColor :String | Titanium.UI.Color

Selected background color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

focusable must be true for normal views.

Defaults to background color of this view.

# backgroundSelectedImage

Availability

0.9

backgroundSelectedImage :String

Selected background image url for the view, specified as a local file path or URL.

For normal views, the selected background is only used if focusable is true.

If backgroundSelectedImage is undefined, and the normal background image backgroundImage is set the normal image is used when this view is selected.

# backgroundTopCap

Availability

0.9

9.2.0

backgroundTopCap :Number

Size of the top end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

# borderColor

Availability

0.9

9.2.0

borderColor :String | Titanium.UI.Color

Border color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Defaults to the normal background color of this view (Android), black (iOS).

# borderRadius

Availability

0.9

9.2.0

borderRadius :Number | String | Array<Number> | Array<String>

Radius for the rounded corners of the view's border.

Each corner is rounded using an arc of a circle. Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px. Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.

If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a backgroundColor with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)".

Default: 0

# borderWidth

Availability

0.9

9.2.0

borderWidth :Number

Border width of the view.

If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.

Default: 0

# bottom

Availability

0.9

9.2.0

bottom :Number | String

View's bottom position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.

# bubbleParent

Availability

3.0.0

9.2.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# cacheSize

Availability

4.1.0

0.8

9.2.0

cacheSize :Number

Number of pages to cache (pre-render).

Pages are rendered in the range (currentPage +/- (cacheSize - 1)/2), rounded down for even values (i.e. cacheSize=4 renders 3 pages into the cache.) Keep in mind that improved performance (larger cache) will lead to faster performance, but greater memory usage.

# center

Availability

0.9

9.2.0

center :Point

View's center position, in the parent view's coordinates.

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.

# clipMode

Availability

3.3.0

9.2.0

clipMode :Number

View's clipping behavior.

Setting this to CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.

Defaults to undefined. Behaves as if set to CLIP_MODE_DEFAULT.

# clipViews CREATION ONLY

Availability

7.5.0

0.9

9.2.0

clipViews :Boolean

Determines whether the previous and next pages are clipped, so that they are not visible adjacent to the current page.

Set to false to allow the previous or next pages to be seen. Note that ScrollableView's width must be smaller than its parent view in order to make this property effective.

Default: true

# currentPage

Availability

0.8

9.2.0

currentPage :Number

Index of the active page.

Since Titanium Mobile Release 3.3.0, using this property to change current page changes the page without animation on iOS and Android.

# currentPageIndicatorColor

Availability

5.4.0

9.2.0

currentPageIndicatorColor :String | Titanium.UI.Color

Color for the current page of the paging control, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Default: undefined (system-default white)

# disableBounce

Availability

0.8

9.2.0

disableBounce :Boolean

Determines whether page bouncing effect is disabled.

Default: false

# elevation

Availability

5.0.0

elevation :Number

Base elevation of the view relative to its parent in pixels.

The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.

Note: The elevation property only works on Titanium.UI.View objects. Many Android components have a default elevation that cannot be modified. For more information, see Google design guidelines: Elevation and shadows.

# filterTouchesWhenObscured

Availability

9.3.0

filterTouchesWhenObscured :Boolean

Discards touch related events if another app's system overlay covers the view.

This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay.

Setting this property to true causes touch related events (including "click") to not be fired if a system overlay overlaps the view.

Default: false

# focusable

Availability

0.9

focusable :Boolean

Whether view should be focusable while navigating with the trackball.

Default: false

# height

Availability

0.9

9.2.0

height :Number | String

View height, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

SIZE. The view should size itself to fit its contents.
FILL. The view should size itself to fill its parent.
'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

# hiddenBehavior

Availability

6.1.0

hiddenBehavior :Number

Sets the behavior when hiding an object to release or keep the free space

If setting hiddenBehavior to HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied. For example: in a vertical layout the views below the object will move up when you hide an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE.

HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.

Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.

This API can be assigned the following constants:

# hitRect

Availability

2.1

9.2.0

hitRect :Dimension

Sets the region where this view responds to gestures.

This property is particularly useful when clipViews is set to false and the dimension of this view is small, to create a larger area for the user to perform swipe gestures against.

Note that the x and y values specified are relative to the position of the view.

Default: undefined (hit against size of view)

# horizontalMotionEffect

Availability

7.3.0

9.2.0

horizontalMotionEffect :MinMaxOptions

Adds a horizontal parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.

# horizontalWrap

Availability

2.1.0

9.2.0

horizontalWrap :Boolean

Determines whether the layout has wrapping behavior.

For more information, see the discussion of horizontal layout mode in the description of the layout property.

Default: true

# id

Availability

0.9

9.2.0

id :String

View's identifier.

The id property of the Ti.UI.View represents the view's identifier. The identifier string does not have to be unique. You can use this property with getViewById method.

# keepScreenOn

Availability

0.9

keepScreenOn :Boolean

Determines whether to keep the device screen on.

When true the screen will not power down. Note: enabling this feature will use more power, thereby adversely affecting run time when on battery. For iOS look at idleTimerDisabled.

Default: false

# layout

Availability

0.9

9.2.0

layout :String

Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.

There are three layout options:

composite (or absolute). Default layout. A child view is positioned based on its positioning properties or "pins" (top, bottom, left, right and center). If no positioning properties are specified, the child is centered.

The child is always sized based on its width and height properties, if these are specified. If the child's height or width is not specified explicitly, it may be calculated implicitly from the positioning properties. For example, if both left and center.x are specified, they can be used to calculate the width of the child control.

Because the size and position properties can conflict, there is a specific precedence order for the layout properties. For vertical positioning, the precedence order is: height, top, center.y, bottom.

The following table summarizes the various combinations of properties that can be used for vertical positioning, in order from highest precedence to lowest. (For example, if height, center.y and bottom are all specified, the height and center.y values take precedence.)

Scenario	Behavior
`height` & `top` specified	Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored.
`height` & `center.y` specified	Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored.
`height` & `bottom` specified	Child positioned `bottom` units from parent's bottom, using specified `height`.
`top` & `center.y` specified	Child positioned with top edge `top` units from parent's top and center at `center.y`. Height is determined implicitly; any `bottom` value is ignored.
`top` & `bottom` specified	Child positioned with top edge `top` units from parent's top and bottom edge `bottom` units from parent's bottom. Height is determined implicitly.
Only `top` specified	Child positioned `top` units from parent's top, and uses the default height calculation for the view type.
`center.y` and `bottom` specified	Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly.
Only `center.y` specified	Child positioned with center at `center.y`, and uses the default height calculation for the view type.
Only `bottom` specified	Child positioned with bottom edge `bottom` units from parent's bottom, and uses the default height calculation for the view type.
`height`, `top`, `center.y`, and `bottom` unspecified	Child entered vertically in the parent and uses the default height calculation for the child view type.

Horizontal positioning works like vertical positioning, except that the precedence is width, left, center.x, right.

For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.

vertical. Children are laid out vertically from top to bottom. The first child is laid out top units from its parent's bounding box. Each subsequent child is laid out below the previous child. The space between children is equal to the upper child's bottom value plus the lower child's top value.

Each child is positioned horizontally as in the composite layout mode.
horizontal. Horizontal layouts have different behavior depending on whether wrapping is enabled. Wrapping is enabled by default (the horizontalWrap property is true).

With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.

Wrapping behavior is available on iOS and Android. When the horizontalWrap property is set to true, the first row is placed at the top of the parent view, and successive rows are placed below the first row. Each child is positioned vertically within its row somewhat like composite layout mode. In particular:
- If neither top or bottom is specified, the child is centered in the row.
- If either top or bottom is specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding.
- If both top and bottom is specified for a given child, the properties are both treated as padding.
If the horizontalWrap property is false, the behavior is more equivalent to a vertical layout. Children are laid or horizontally from left to right in a single row. The left and right properties are used as padding between the children, and the top and bottom properties are used to position the children vertically.

Defaults to Composite layout.

# left

Availability

0.9

9.2.0

left :Number | String

View's left position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.

# lifecycleContainer

Availability

3.6.0

lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# opacity

Availability

0.9

9.2.0

opacity :Number

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). Defaults to 1.0 (opaque).

# overlayEnabled

Availability

2.1.0

9.2.0

overlayEnabled :Boolean

Determines whether the paging control is added as an overlay to the view.

If this property is set to true, the view takes up the entire height available in the parent view and the paging control is placed over the view. It is advisable to set an appropriate value for pagingControlAlpha along with this property, so that the underlying view content may be seen properly.

Default: false

# overrideCurrentAnimation CREATION ONLY

Availability

3.3.0

overrideCurrentAnimation :Boolean

When on, animate call overrides current animation if applicable.

If this property is set to false, the animate call is ignored if the view is currently being animated.

Defaults to undefined but behaves as false

# overScrollMode

Availability

3.1.0

overScrollMode :Number

Determines the behavior when the user overscolls the view.

This API can be assigned the following constants:

Default: Titanium.UI.Android.OVER_SCROLL_ALWAYS

# padding

Availability

7.5.0

padding :Padding

The padding applied to the scrollable view.

# pageIndicatorColor

Availability

5.4.0

9.2.0

pageIndicatorColor :String | Titanium.UI.Color

Color of the paging control, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Default: undefined (system-default gray)

# pagingControlAlpha

Availability

2.1.0

9.2.0

pagingControlAlpha :Number

Alpha value of the paging control.

Default: 1

# pagingControlColor

Availability

0.8

9.2.0

pagingControlColor :String | Titanium.UI.Color

Color of the paging control, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Default: black

# pagingControlHeight

Availability

0.8

9.2.0

pagingControlHeight :Number

Height of the paging control, in pixels.

Default: 20

# pagingControlOnTop

Availability

2.1.0

9.2.0

pagingControlOnTop :Boolean

Determines whether the paging control is displayed at the top or bottom of the view.

Set to true for the paging control at the top.

Default: false

# pagingControlTimeout CREATION ONLY

Availability

0.8

pagingControlTimeout :Number

Number of milliseconds to wait before hiding the paging control.

Set to less than or equal to 0 to disable timeout, to keep controls displayed.

Default: 3000

# preferredIndicatorImage

Availability

9.2.0

preferredIndicatorImage :String | Titanium.Blob

The preferred image for indicators, defined using a local filesystem path, or a Blob object containing image data.

Symbol images are recommended. Use systemImage to get system-supplied symbol images. See examples section for usage.

# previewContext

Availability

5.1.0

previewContext :Titanium.UI.iOS.PreviewContext

The preview context used in the 3D-Touch feature "Peek and Pop".

Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.

Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using forceTouchSupported.

# pullBackgroundColor

Availability

3.3.0

9.2.0

pullBackgroundColor :String | Titanium.UI.Color

Background color of the wrapper view when this view is used as either pullView or headerPullView.

Defaults to undefined. Results in a light grey background color on the wrapper view.

# rect READONLY

Availability

2.0.0

9.2.0

rect :DimensionWithAbsolutes

The bounding box of the view relative to its parent, in system units.

The view's bounding box is defined by its size and position.

The view's size is rect.width x rect.height. The view's top-left position relative to its parent is (rect.x , rect.y).

On Android it will also return rect.absoluteX and 'rect.absoluteY' which are relative to the main window.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

# right

Availability

0.9

9.2.0

right :Number | String

View's right position, in platform-specific units.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

Defaults to undefined.

# rotation

Availability

5.4.0

12.3.0

rotation :Number

Clockwise 2D rotation of the view in degrees.

Translation values are applied to the static post layout value.

# rotationX

Availability

5.4.0

rotationX :Number

Clockwise rotation of the view in degrees (x-axis).

Translation values are applied to the static post layout value.

# rotationY

Availability

5.4.0

rotationY :Number

Clockwise rotation of the view in degrees (y-axis).

Translation values are applied to the static post layout value.

# scaleX

Availability

5.4.0

scaleX :Number

Scaling of the view in x-axis in pixels.

Translation values are applied to the static post layout value.

# scaleY

Availability

5.4.0

scaleY :Number

Scaling of the view in y-axis in pixels.

Translation values are applied to the static post layout value.

# scrollingEnabled

Availability

2.1.0

2.0.0

9.2.0

scrollingEnabled :Boolean

Determines whether scrolling is enabled for the view.

If this property is unset or true, scrolling is enabled.

Default: undefined (scrolling enabled)

# showPagingControl

Availability

0.8

9.2.0

showPagingControl :Boolean

Determines whether the paging control is visible.

Set to true to show paging control.

Default: false

# size READONLY

Availability

0.9

9.2.0

size :Dimension

The size of the view in system units.

Although property returns a Dimension dictionary, only the width and height properties are valid. The position properties--x and y--are always 0.

To find the position and size of the view, use the rect property instead.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

# softKeyboardOnFocus

Availability

0.9

softKeyboardOnFocus :Number

Determines keyboard behavior when this view is focused. Defaults to SOFT_KEYBOARD_DEFAULT_ON_FOCUS.

This API can be assigned the following constants:

# tintColor

Availability

3.1.3

9.2.0

tintColor :String | Titanium.UI.Color

The view's tintColor

This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, the tintColor of the View is inherited from its superview.

Default: null

tooltip :String

The default text to display in the control's tooltip.

Assigning a value to this property causes the tool tip to be displayed for the view. Setting the property to null cancels the display of the tool tip for the view. Note: This property is only used for apps targeting macOS Catalyst.

# top

Availability

0.9

9.2.0

top :Number | String

The view's top position.

This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

# touchEnabled

Availability

0.9

9.2.0

touchEnabled :Boolean

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

# touchFeedback

Availability

6.1.0

touchFeedback :Boolean

A material design visual construct that provides an instantaneous visual confirmation of touch point.

Touch feedback is only applied to a view's background. It is never applied to the view's foreground content such as a Titanium.UI.ImageView's image.

For Titanium versions older than 9.1.0, touch feedback only works if you set the backgroundColor property to a non-transparent color.

Default: false

# touchFeedbackColor

Availability

6.1.0

touchFeedbackColor :String

Optional touch feedback ripple color. This has no effect unless touchFeedback is true.

Defaults to provided theme color.

# transform

Availability

0.9

9.2.0

transform :Titanium.UI.Matrix2D | Titanium.UI.Matrix3D

Transformation matrix to apply to the view.

Android only supports Matrix2D transforms.

Default: Identity matrix

# transitionName

Availability

5.0.2

transitionName :String

A name to identify this view in activity transition.

Name should be unique in the View hierarchy.

# translationX

Availability

5.0.0

translationX :Number

Horizontal location of the view relative to its left position in pixels.

Translation values are applied to the static post layout value.

# translationY

Availability

5.0.0

translationY :Number

Vertical location of the view relative to its top position in pixels.

Translation values are applied to the static post layout value.

# translationZ

Availability

5.0.0

translationZ :Number

Depth of the view relative to its elevation in pixels.

Translation values are applied to the static post layout value.

# verticalMotionEffect

Availability

7.3.0

9.2.0

verticalMotionEffect :MinMaxOptions

Adds a vertical parallax effect to the view

Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator. To clear all motion effects, use the <Titanium.UI.clearMotionEffects> method.

# views

Availability

0.8

9.2.0

views :Array<Titanium.UI.View>

Sets the pages within this Scrollable View.

# viewShadowColor

Availability

11.1.0

3.3.0

9.2.0

viewShadowColor :String | Titanium.UI.Color

Determines the color of the shadow.

iOS Defaults to undefined. Behaves as if transparent. Android default is black. On Android you can set <item name="android:ambientShadowAlpha">0.5</item> and <item name="android:spotShadowAlpha">0.5</item> in your theme to change the opacity.

# viewShadowOffset

Availability

3.3.0

9.2.0

viewShadowOffset :Point

Determines the offset for the shadow of the view.

Defaults to undefined. Behaves as if set to (0,-3)

# viewShadowRadius

Availability

3.3.0

9.2.0

viewShadowRadius :Number | String

Determines the blur radius used to create the shadow.

Defaults to undefined. Behaves as if set to 3. Accepts density units as of 10.0.1.

# visible

Availability

0.9

9.2.0

visible :Boolean

Determines whether the view is visible.

Default: true

# width

Availability

0.9

9.2.0

width :Number | String

View's width, in platform-specific units.

Defaults to: If undefined, defaults to either FILL or SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

SIZE. The view should size itself to fit its contents.
FILL. The view should size itself to fill its parent.
'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.

This API can be assigned the following constants:

# zIndex

Availability

0.9

9.2.0

zIndex :Number

Z-index stack order position, relative to other sibling views.

A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.

Defaults to undefined.

# Methods

# addEventListener

Availability

0.8

9.2.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# addView

Availability

0.8

9.2.0

addView(view) → void

Adds a new page to this Scrollable View.

Parameters

Name	Type	Description
`view`	Titanium.UI.View	The page to add.

Returns

Type: void

# animate

Availability

0.9

9.2.0

animate(animation[, callback]) → void

Animates this view.

The Titanium.UI.Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.

Note that on SDKs older than 9.1.0 - if you use animate to move a view, the view's actual position is changed, but its layout properties, such as top, left, center and so on are not changed--these reflect the original values set by the user, not the actual position of the view.

As of SDK 9.1.0, the final values of the animation will be set on the view just before the complete event and/or the callback is fired.

The rect property can be used to determine the actual size and position of the view.

Parameters

Name	Type	Description
`animation`	Titanium.UI.Animation \| Dictionary<Titanium.UI.Animation>	Either a dictionary of animation properties or an Titanium.UI.Animation object.
`callback`	Callback<Object>	Function to be invoked upon completion of the animation.

Returns

Type: void

# applyProperties

Availability

3.0.0

9.2.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# clearMotionEffects

Availability

8.2.0

9.2.0

clearMotionEffects() → void

Removes all previously added motion effects.

Use this method together with <Titanium.UI.horizontalMotionEffect> and <Titanium.UI.verticalMotionEffect>.

Returns

Type: void

# convertPointToView

Availability

1.8

9.2.0

convertPointToView(point, destinationView) → Point

Translates a point from this view's coordinate system to another view's coordinate system.

Returns null if either view is not in the view hierarchy.

Keep in mind that views may be removed from the view hierarchy if their window is blurred or if the view is offscreen (such as in some situations with Titanium.UI.ScrollableView).

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are subtracted from the return value.

Parameters

Name	Type	Description
`point`	Point	A point in this view's coordinate system. If this argument is missing an `x` or `y` property, or the properties can not be converted into numbers, an exception will be raised.
`destinationView`	Titanium.UI.View	View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.

Returns

Type: Point

# fireEvent

Availability

0.8

9.2.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`event`	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type: void

# getViewById

Availability

6.1.0

9.2.0

getViewById(id) → Titanium.UI.View

Returns the matching view of a given view ID.

Parameters

Name	Type	Description
`id`	String	The ID of the view that should be returned. Use the `id` property in your views to enable it for indexing in this method.

Returns

Type: Titanium.UI.View

# hide

Availability

0.9

9.2.0

hide([options]) → void

Hides this view.

Parameters

Name	Type	Description
`options`	AnimatedOptions	Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`

Returns

Type: void

# insertAt

Availability

3.3.0

9.2.0

insertAt(params) → void

Inserts a view at the specified position in the children array.

Useful if the layout property is set to horizontal or vertical.

Parameters

Name	Type	Description
`params`	ViewPositionOptions	Pass an object that specifies the view to insert and optionally at which position (defaults to end)

Returns

Type: void

# insertViewsAt

Availability

5.4.0

9.2.0

insertViewsAt(position, views) → void

Inserts views at the specified position in the views array.

Parameters

Name	Type	Description
`position`	Number	Position(index) in the views array to insert the view
`views`	Array<Titanium.UI.View>	Views to insert.

Returns

Type: void

# moveNext

Availability

0.8

3.3.0

9.2.0

moveNext() → void

Sets the current page to the next consecutive page in views.

Since Titanium Mobile Release 3.3.0, using this method to change current page animates the change on iOS and Android.

Returns

Type: void

# movePrevious

Availability

0.8

3.3.0

9.2.0

movePrevious() → void

Sets the current page to the previous consecutive page in views.

Since Titanium Mobile Release 3.3.0, using this method to change current page animates the change on iOS and Android.

Returns

Type: void

# removeEventListener

Availability

0.8

9.2.0

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# removeView

Availability

0.8

9.2.0

removeView(view) → void

Removes an existing page from this Scrollable View.

On Android, does nothing if the page does not exist in views.

On iOS, throws an exception if the page does not exist in views or the index is invalid.

Parameters

Name	Type	Description
`view`	Number \| Titanium.UI.View	A Titanium.UI.View object (all platforms) or integer index (Android and iOS only) of the page to remove.

Returns

Type: void

# scrollToView

Availability

0.8

9.2.0

scrollToView(view) → void

Scrolls to the specified page in views.

Parameters

Name	Type	Description
`view`	Number \| Titanium.UI.View	An integer index or Titanium.UI.View object to set as the current page.

Returns

Type: void

# setIndicatorImageForPage

Availability

9.2.0

setIndicatorImageForPage(image, pageNo) → void

Sets the indicator image for the specified page.

Override the indicator image for a specific page. Symbol images are recommended. Use systemImage to get system-supplied symbol images. See examples section for usage.

Parameters

Name	Type	Description
`image`	String \| Titanium.Blob	The image for the indicator, defined using a local filesystem path, or a `Blob` object containing image data. Resets to the default if image is null.
`pageNo`	Number	Page number to set the image.

Returns

Type: void

# show

Availability

0.9

9.2.0

show([options]) → void

Makes this view visible.

Parameters

Name	Type	Description
`options`	AnimatedOptions	Animation options for Android only. Since SDK 5.1.0 and only used on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in `{ animated: false }`

Returns

Type: void

# stopAnimation

Availability

12.1.0

stopAnimation() → void

Stops a running animation.

Stops a running view Titanium.UI.Animation.

Returns

Type: void

# toImage

Availability

0.9

9.2.0

toImage([callback[, honorScaleFactor]]) → Titanium.Blob

Returns an image of the rendered view, as a Blob.

The honorScaleFactor argument is only supported on iOS.

Parameters

Name	Type	Description
`callback`	Callback<Titanium.Blob>	Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
`honorScaleFactor`	Boolean	Determines whether the image is scaled based on scale factor of main screen. (iOS only) When set to true, image is scale factor is honored. When set to false, the image in the blob has the same dimensions for retina and non-retina devices.

Returns

Type: Titanium.Blob

# Events

# dblclick

Availability

0.9

9.2.0

Fired when the device detects a double click against the view.

Properties

Name	Type	Description
x	Number	X coordinate of the event from the `source` view's coordinate system.
y	Number	Y coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# doubletap

Availability

0.9

9.2.0

Fired when the device detects a double tap against this page.

Properties

Name	Type	Description
x	Number	X coordinate of the event from the `source` view's coordinate system.
y	Number	Y coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# focus

Availability

0.9

Fired when the view element gains focus.

This event only fires when using the trackball to navigate.

# keypressed

Availability

3.1.0

5.4.0

9.2.0

Fired when a hardware key is pressed in the view.

A keypressed event is generated by pressing a hardware key. On Android, this event can only be fired when the property focusable is set to true. On iOS the event is generated only when using Titanium.UI.TextArea, Titanium.UI.TextField and Titanium.UI.SearchBar.

Properties

Name	Type	Description
keyCode	Number	The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# longpress

Availability

0.9

9.2.0

Fired when the device detects a long press against this view.

Generated by touching and holding on a touchscreen, this event occurs before the finger is lifted again. Note that longpress cannot be generated with a trackball.

Properties

Name	Type	Description
x	Number	X coordinate of the event from the `source` view's coordinate system.
y	Number	Y coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# postlayout

Availability

2.0.0

9.2.0

Fired when a layout cycle is finished.

This event is fired when the view and its ancestors have been laid out. The rect and size values should be usable when this event is fired.

This event is typically triggered by either changing layout properties or by changing the orientation of the device. Note that changing the layout of child views or ancestors can also trigger a relayout of this view.

Note that altering any properties that affect layout from the postlayout callback may result in an endless loop.

# singletap

Availability

0.9

9.2.0

Fired when the device detects a single tap against this view.

Properties

Name	Type	Description
x	Number	X coordinate of the event from the `source` view's coordinate system.
y	Number	Y coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# touchcancel

Availability

0.9

9.2.0

Fired when a touch gesture is interrupted by the device.

Generated in various circumstances, including an incoming call to allow the UI to clean up state.

Properties

Name	Type	Description
x	Number	X coordinate of the event from the `source` view's coordinate system.
y	Number	Y coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# touchstart

Availability

0.9

9.2.0

Fired as soon as the device detects a touch gesture against this view.

Properties

Name	Type	Description
x	Number	X coordinate of the event from the `source` view's coordinate system.
y	Number	Y coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# twofingertap

Availability

0.9

9.2.0

Fired when the device detects a two-finger tap against the view.

Properties

Name	Type	Description
y	Number	Y coordinate of the event from the `source` view's coordinate system.
x	Number	X coordinate of the event from the `source` view's coordinate system.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# scroll

Availability

0.8

9.2.0

Fired repeatedly as the view is being scrolled.

Prior to 2.1, the scroll event did not fire consistently on all platforms. On iOS, it fired when scrolling ended, and on Android, it fired when drag ended. You can restore the pre-2.1 behavior by listening for the scrollEnd or dragEnd events instead.

Properties

Name	Type	Description
currentPage	Number	Index of the currently visible view of views.
currentPageAsFloat	Number	Current page index that the view is scrolled to as a float. For example, if the user is holding the `ScrollableView` in between the first and second page, this will have a value of 0.5.
view	Titanium.UI.View	The currently visible view.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# scrollend

Availability

3.0.0

9.2.0

Fired when the view has stopped moving completely.

Properties

Name	Type	Description
currentPage	Number	Index of the currently visible view of views.
view	Titanium.UI.View	The currently visible view.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# dragend

Availability

3.0.0

Fired when the scrolling drag gesture on the view has been completed.

Properties

Name	Type	Description
currentPage	Number	Index of the currently visible view of views.
view	Titanium.UI.View	The currently visible view.
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# Titanium.UI.ScrollableView

# Overview

# Examples

# Simple Scrollable View with 3 Views

# Simple Scrollable View with 2 Zoomable Images

# Scrollable View with multiple visible views

# Alloy XML Markup

# Scrollable View with indicator image (iOS only)

# Properties

# accessibilityHidden

# accessibilityHint

# accessibilityLabel

# accessibilityValue

# anchorPoint

# animatedCenter READONLY

# apiName READONLY

# backgroundColor

# backgroundDisabledColor

# backgroundDisabledImage

# backgroundFocusedColor

# backgroundFocusedImage

# backgroundGradient

# backgroundImage

# backgroundLeftCap

# backgroundRepeat

# backgroundSelectedColor

# backgroundSelectedImage

# backgroundTopCap

# borderColor

# borderRadius

# borderWidth

# bottom

# bubbleParent

# cacheSize

# center

# clipMode

# clipViews CREATION ONLY

# currentPage

# currentPageIndicatorColor

# disableBounce

# elevation

# filterTouchesWhenObscured

# focusable

# height

# hiddenBehavior

# hitRect

# horizontalMotionEffect

# horizontalWrap

# id

# keepScreenOn

# layout

# left

# lifecycleContainer

# opacity

# overlayEnabled

# overrideCurrentAnimation CREATION ONLY

# overScrollMode

# padding

# pageIndicatorColor

# pagingControlAlpha

# pagingControlColor

# pagingControlHeight

# pagingControlOnTop

# pagingControlTimeout CREATION ONLY

# preferredIndicatorImage

# previewContext

# pullBackgroundColor

# rect READONLY

# right

# rotation

# rotationX

# rotationY

# scaleX

# scaleY

# scrollingEnabled

# showPagingControl

# size READONLY

# softKeyboardOnFocus

# tintColor

# tooltip