| Platform | Since |
|---|---|
| Android | 0.9 |
| iPhone | 0.9 |
| iPad | 0.9 |
| Mobile Web | 1.8 |
A Scroll View is used to create a scrollable region of content.
Views added to the Scroll View will be scrolled based on the content size of the
Scroll View. The Scroll View is created by the method Titanium.UI.createScrollView.
If your scrollable region fits within the size of the content area the scroll view will not scroll.
In Android, Scroll Views can only scroll in one direction, either vertical
or horizontal, but not both at the same time. Use the Titanium.UI.ScrollView.scrollType
property to set the scroll direction explicitly.
If the scrollType property is not set, the scroll view
attempts to deduce the scroll direction based on some of the other
properties that have been set. Specifically, if contentWidth and width
are both set and are equal to each other, or if they are both set and
showVerticalScrollIndicator is set to true, then the scroll direction
is set to "vertical". If contentHeight and height are both set and are
equal, or if they are both set and showHorizontalScrollIndicator is set
to true, then the scroll direction is set to "horizontal". If
scrollType is set, it overrides the deduced setting.
Create a scroll view with content.
var scrollView = Titanium.UI.createScrollView({ contentWidth:'auto', contentHeight:'auto', top:0, showVerticalScrollIndicator:true, showHorizontalScrollIndicator:true }); var view = Ti.UI.createView({ backgroundColor:'#336699', borderRadius:10, width:300, height:2000, top:10 }); scrollView.add(view); Titanium.UI.currentWindow.add(scrollView);
| Name | Summary |
|---|---|
| add |
Adds a child to this view's hierarchy. |
| addEventListener |
Adds the specified callback as an event listener for the named event. |
| animate |
Animates this view. |
| convertPointToView |
Translates a point from this view's coordinate system to another view's coordinate system. (Android, iPhone, iPad only.) |
| fireEvent |
Fires a synthesized event to any registered listeners. |
| getAnchorPoint |
Gets the value of the anchorPoint property. (iPhone, iPad only.) |
| getAnimatedCenterPoint |
Gets the value of the animatedCenterPoint property. (Android, iPhone, iPad only.) |
| getBackgroundColor |
Gets the value of the backgroundColor property. |
| getBackgroundDisabledColor |
Gets the value of the backgroundDisabledColor property. (Android only.) |
| getBackgroundDisabledImage |
Gets the value of the backgroundDisabledImage property. (Android only.) |
| getBackgroundFocusedColor |
Gets the value of the backgroundFocusedColor property. (Android only.) |
| getBackgroundFocusedImage |
Gets the value of the backgroundFocusedImage property. (Android only.) |
| getBackgroundGradient |
Gets the value of the backgroundGradient property. (iPhone, iPad, Mobile Web only.) |
| getBackgroundImage |
Gets the value of the backgroundImage property. |
| getBackgroundLeftCap |
Gets the value of the backgroundLeftCap property. (iPhone, iPad only.) |
| getBackgroundSelectedColor |
Gets the value of the backgroundSelectedColor property. (Android, Mobile Web only.) |
| getBackgroundSelectedImage |
Gets the value of the backgroundSelectedImage property. (Android, Mobile Web only.) |
| getBackgroundTopCap |
Gets the value of the backgroundTopCap property. (iPhone, iPad only.) |
| getBorderColor |
Gets the value of the borderColor property. |
| getBorderRadius |
Gets the value of the borderRadius property. |
| getBorderWidth |
Gets the value of the borderWidth property. |
| getBottom |
Gets the value of the bottom property. |
| getCanCancelEvents |
Gets the value of the canCancelEvents property. (iPhone, iPad, Mobile Web only.) |
| getCenter |
Gets the value of the center property. |
| getContentHeight |
Gets the value of the contentHeight property. |
| getContentOffset |
Gets the value of the contentOffset property. |
| getContentWidth |
Gets the value of the contentWidth property. |
| getDisableBounce |
Gets the value of the disableBounce property. (iPhone, iPad only.) |
| getFocusable |
Gets the value of the focusable property. (Android only.) |
| getHeight |
Gets the value of the height property. |
| getHorizontalBounce |
Gets the value of the horizontalBounce property. (iPhone, iPad only.) |
| getKeepScreenOn |
Gets the value of the keepScreenOn property. (Android only.) |
| getLayout |
Gets the value of the layout property. |
| getLeft |
Gets the value of the left property. |
| getMaxZoomScale |
Gets the value of the maxZoomScale property. (iPhone, iPad only.) |
| getMinZoomScale |
Gets the value of the minZoomScale property. (iPhone, iPad only.) |
| getOpacity |
Gets the value of the opacity property. |
| getRight |
Gets the value of the right property. |
| getScrollType |
Gets the value of the scrollType property. (Android only.) |
| getShowHorizontalScrollIndicator |
Gets the value of the showHorizontalScrollIndicator property. |
| getShowVerticalScrollIndicator |
Gets the value of the showVerticalScrollIndicator property. |
| getSize |
Gets the value of the size property. |
| getSoftKeyboardOnFocus |
Gets the value of the softKeyboardOnFocus property. (Android only.) |
| getTop |
Gets the value of the top property. |
| getTouchEnabled |
Gets the value of the touchEnabled property. |
| getTransform |
Gets the value of the transform property. (Android, iPhone, iPad only.) |
| getVerticalBounce |
Gets the value of the verticalBounce property. (iPhone, iPad only.) |
| getVisible |
Gets the value of the visible property. |
| getWidth |
Gets the value of the width property. |
| getZIndex |
Gets the value of the zIndex property. |
| getZoomScale |
Gets the value of the zoomScale property. (iPhone, iPad only.) |
| hide |
Hides this view. |
| remove |
Removes a child view from this view's hierarchy. |
| removeEventListener |
Removes the specified callback as an event listener for the named event. |
| scrollTo |
scrollTo a particular point |
| setAnchorPoint |
Sets the value of the anchorPoint property. (iPhone, iPad only.) |
| setBackgroundColor |
Sets the value of the backgroundColor property. |
| setBackgroundDisabledColor |
Sets the value of the backgroundDisabledColor property. (Android only.) |
| setBackgroundDisabledImage |
Sets the value of the backgroundDisabledImage property. (Android only.) |
| setBackgroundFocusedColor |
Sets the value of the backgroundFocusedColor property. (Android only.) |
| setBackgroundFocusedImage |
Sets the value of the backgroundFocusedImage property. (Android only.) |
| setBackgroundGradient |
Sets the value of the backgroundGradient property. (iPhone, iPad, Mobile Web only.) |
| setBackgroundImage |
Sets the value of the backgroundImage property. |
| setBackgroundLeftCap |
Sets the value of the backgroundLeftCap property. (iPhone, iPad only.) |
| setBackgroundSelectedColor |
Sets the value of the backgroundSelectedColor property. (Android, Mobile Web only.) |
| setBackgroundSelectedImage |
Sets the value of the backgroundSelectedImage property. (Android, Mobile Web only.) |
| setBackgroundTopCap |
Sets the value of the backgroundTopCap property. (iPhone, iPad only.) |
| setBorderColor |
Sets the value of the borderColor property. |
| setBorderRadius |
Sets the value of the borderRadius property. |
| setBorderWidth |
Sets the value of the borderWidth property. |
| setBottom |
Sets the value of the bottom property. |
| setCanCancelEvents |
Sets the value of the canCancelEvents property. (iPhone, iPad, Mobile Web only.) |
| setCenter |
Sets the value of the center property. |
| setContentHeight |
Sets the value of the contentHeight property. |
| setContentOffset |
Sets the value of the contentOffset property. |
| setContentWidth |
Sets the value of the contentWidth property. |
| setDisableBounce |
Sets the value of the disableBounce property. (iPhone, iPad only.) |
| setFocusable |
Sets the value of the focusable property. (Android only.) |
| setHeight |
Sets the value of the height property. |
| setHorizontalBounce |
Sets the value of the horizontalBounce property. (iPhone, iPad only.) |
| setKeepScreenOn |
Sets the value of the keepScreenOn property. (Android only.) |
| setLayout |
Sets the value of the layout property. |
| setLeft |
Sets the value of the left property. |
| setMaxZoomScale |
Sets the value of the maxZoomScale property. (iPhone, iPad only.) |
| setMinZoomScale |
Sets the value of the minZoomScale property. (iPhone, iPad only.) |
| setOpacity |
Sets the value of the opacity property. |
| setRight |
Sets the value of the right property. |
| setScrollType |
Sets the value of the scrollType property. (Android only.) |
| setShowHorizontalScrollIndicator |
Sets the value of the showHorizontalScrollIndicator property. |
| setShowVerticalScrollIndicator |
Sets the value of the showVerticalScrollIndicator property. |
| setSize |
Sets the value of the size property. |
| setSoftKeyboardOnFocus |
Sets the value of the softKeyboardOnFocus property. (Android only.) |
| setTop |
Sets the value of the top property. |
| setTouchEnabled |
Sets the value of the touchEnabled property. |
| setTransform |
Sets the value of the transform property. (Android, iPhone, iPad only.) |
| setVerticalBounce |
Sets the value of the verticalBounce property. (iPhone, iPad only.) |
| setVisible |
Sets the value of the visible property. |
| setWidth |
Sets the value of the width property. |
| setZIndex |
Sets the value of the zIndex property. |
| setZoomScale |
Sets the value of the zoomScale property. (iPhone, iPad only.) |
| show |
Makes this view visible. |
| toImage |
Returns an image of the rendered view, as a Blob. (Android, iPhone, iPad only.) |
| Name | Type | Summary |
|---|---|---|
| anchorPoint | Point |
Anchor point where animation should occur, relative to the view's boundaries. (iPhone, iPad only.) |
| animatedCenterPoint | Point |
Current position of the view during an animation. (Android, iPhone, iPad only.) read-only |
| backgroundColor | String |
Background color of the view. |
| backgroundDisabledColor | String |
Disabled background color of the view. (Android only.) |
| backgroundDisabledImage | String |
Disabled background image for the view, specified as a local file path or URL. (Android only.) |
| backgroundFocusedColor | String |
Focused background color of the view. (Android only.) |
| backgroundFocusedImage | String |
Focused background image for the view, specified as a local file path or URL. (Android only.) |
| backgroundGradient | Gradient |
A background gradient for the view. (iPhone, iPad, Mobile Web only.) |
| backgroundImage | String |
Background image for the view, specified as a local file path or URL. |
| backgroundLeftCap | Number |
Size of the left end cap. (iPhone, iPad only.) |
| backgroundSelectedColor | String |
Selected background color of the view. (Android, Mobile Web only.) |
| backgroundSelectedImage | String |
Selected background image url for the view, specified as a local file path or URL. (Android, Mobile Web only.) |
| backgroundTopCap | Number |
Size of the top end cap. (iPhone, iPad only.) |
| borderColor | String |
Border color of the view. |
| borderRadius | Number |
Border radius of the view. |
| borderWidth | Number |
Border width of the view. |
| bottom | Number or String |
View's bottom position, in platform-specific units. |
| canCancelEvents | Boolean |
boolean to indicate if the scroll view can cancel subview touches in order to scroll instead. Default of true (iPhone, iPad, Mobile Web only.) |
| center | Point |
View's center position, in the parent view's coordinates. |
| contentHeight | Number |
the height of the scrollable area |
| contentOffset | Object |
an object (with x and y properties) to indicate the offset of the content area |
| contentWidth | Number |
the width of the scrollable area |
| disableBounce | Boolean |
disable view bouncing. (iPhone, iPad only.) |
| focusable | Boolean |
Whether view should be focusable while navigating with the trackball. (Android only.) |
| height | Number or String |
View height, in platform-specific units. |
| horizontalBounce | Boolean |
boolean to control the horizontal bounce during scrolling (iPhone, iPad only.) |
| keepScreenOn | Boolean |
Whether to keep the device screen on. (Android only.) |
| layout | String |
Specifies how the view positions its children. One of: 'absolute', 'vertical', or 'horizontal'. |
| left | Number or String |
View's left position, in platform-specific units. |
| maxZoomScale | Number |
the maximum scale of the content (iPhone, iPad only.) |
| minZoomScale | Number |
the minimum scale of the content (iPhone, iPad only.) |
| opacity | Number |
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). |
| right | Number or String |
View's right position, in platform-specific units. |
| scrollType | String |
For explicitly setting the direction -- "vertical" or "horizontal" -- in which the ScrollView will scroll. See also the documentation notes for more information concerning how Android deduces the scroll direction when this property is not set. (Android only.) |
| showHorizontalScrollIndicator | Boolean |
boolean to indicate whether the horizontal scroll indicator is visible |
| showVerticalScrollIndicator | Boolean |
boolean to indicate whether the vertical scroll indicator is visible |
| size | Object |
Size of the view as a dictionary of width and height properties. |
| softKeyboardOnFocus | Number |
Determines keyboard behavior when this view is focused. (Android only.) |
| top | Number or String |
The view's top position. |
| touchEnabled | Boolean |
Whether view should receive touch events. |
| transform | Titanium.UI.2DMatrix or Titanium.UI.iOS.3DMatrix |
Transformation matrix to apply to the view. (Android, iPhone, iPad only.) |
| verticalBounce | Boolean |
boolean to control the vertical bounce during scrolling (iPhone, iPad only.) |
| visible | Boolean |
Boolean value indicating whether the view is visible. |
| width | Number or String |
View's width, in platform-specific units. |
| zIndex | Number |
Z index position relative to other sibling views. |
| zoomScale | Number |
set the zoom scale for the current content area (iPhone, iPad only.) |
| Name | Summary |
|---|---|
| click |
Fired when the device detects a click against the view. |
| dblclick |
Fired when the device detects a double click against the view. |
| doubletap |
Fired when the device detects a double tap against the view. (Android, iPhone, iPad only.) |
| dragEnd |
fired when when dragging ended in the scroll view. (iPhone, iPad only.) |
| dragStart |
fired when the scroll view is about to start scrolling the content. (iPhone, iPad only.) |
| longclick |
Fired when the device detects a long click. (Android only.) |
| longpress |
Fired when the device detects a long press. (Android, iPhone, iPad only.) |
| pinch |
Fired when the device detects a pinch gesture. |
| scale |
fired when the zoom scale factor changes (Android, iPhone, iPad only.) |
| scroll |
fired when the view is scrolled |
| singletap |
Fired when the device detects a single tap against the view. |
| swipe |
Fired when the device detects a swipe gesture (left or right) against the view. (iPhone, iPad, Mobile Web only.) |
| touchcancel |
Fired when a touch event is interrupted by the device. |
| touchend |
Fired when a touch event is completed. |
| touchmove |
Fired as soon as the device detects movement of a touch. |
| touchstart |
Fired as soon as the device detects a touch gesture. |
| twofingertap |
Fired when the device detects a two-finger tap against the view. |
