Titanium.UI.ImageView

Object of Titanium.UI.
Platform Since
Android 0.9
iPhone 0.9
iPad 0.9
Mobile Web 1.8

Summary

An Image View is used to display an image or a series of images in an animation.

Description

If you specify a width and/or height property for the image view, the image will be scaled to fit into this space while maintaining its original aspect ratio.

Use the Titanium.UI.createImageView method to create an image view.

Code Examples

Basic Image View

In this example, we create a simple image view:

var image = Titanium.UI.createImageView({url:'myimage.png'});
view.add(image);

Methods

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

getAnimating

Gets the value of the animating property.

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.

getCanScale

Gets the value of the canScale property. (Android only.)

getCenter

Gets the value of the center property.

getDecodeRetries

Gets the value of the decodeRetries property. (Android only.)

getDefaultImage

Gets the value of the defaultImage property.

getDuration

Gets the value of the duration property.

getEnableZoomControls

Gets the value of the enableZoomControls property. (Android only.)

getFocusable

Gets the value of the focusable property. (Android only.)

getHeight

Gets the value of the height property.

getHires

Gets the value of the hires property. (iPhone, iPad, Mobile Web only.)

getImage

Gets the value of the image property.

getImages

Gets the value of the images property.

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.

getOpacity

Gets the value of the opacity property.

getPaused

Gets the value of the paused property.

getPreventDefaultImage

Gets the value of the preventDefaultImage property.

getRepeatCount

Gets the value of the repeatCount property.

getReverse

Gets the value of the reverse property.

getRight

Gets the value of the right 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.)

getUrl

Gets the value of the url property.

getVisible

Gets the value of the visible property.

getWidth

Gets the value of the width property.

getZIndex

Gets the value of the zIndex property.

hide

Hides this view.

pause

Pause a running animation. (Android, iPhone, iPad only.)

remove

Removes a child view from this view's hierarchy.

removeEventListener

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

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.

setCanScale

Sets the value of the canScale property. (Android only.)

setCenter

Sets the value of the center property.

setDecodeRetries

Sets the value of the decodeRetries property. (Android only.)

setDefaultImage

Sets the value of the defaultImage property.

setDuration

Sets the value of the duration property.

setEnableZoomControls

Sets the value of the enableZoomControls property. (Android only.)

setFocusable

Sets the value of the focusable property. (Android only.)

setHeight

Sets the value of the height property.

setHires

Sets the value of the hires property. (iPhone, iPad, Mobile Web only.)

setImage

Sets the value of the image property.

setImages

Sets the value of the images property.

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.

setOpacity

Sets the value of the opacity property.

setPreventDefaultImage

Sets the value of the preventDefaultImage property.

setRepeatCount

Sets the value of the repeatCount property.

setReverse

Sets the value of the reverse property.

setRight

Sets the value of the right 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.)

setUrl

Sets the value of the url property.

setVisible

Sets the value of the visible property.

setWidth

Sets the value of the width property.

setZIndex

Sets the value of the zIndex property.

show

Makes this view visible.

start

Start the image animation. This method only works if you set multiple images. (Android, iPhone, iPad only.)

stop

Stop a running animation and reset the index to the first image. (Android, iPhone, iPad only.)

toBlob

Return the image as a Blob object. (Android, iPhone, iPad only.)

toImage

Returns an image of the rendered view, as a Blob. (Android, iPhone, iPad only.)

Properties

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

animating Boolean

true if the animation is running. 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.

canScale Boolean

Allow the user to scale the image (using pinch-zoom or the optional zoom controls). (Android only.)

center Point

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

decodeRetries Number

Number of times to retry decoding the bitmap at this URL. (Android only.)

defaultImage String

url to the default image to display while loading a remote image

duration Number

amount of time in milliseconds to animate one cycle

enableZoomControls Boolean

Show zoom controls when the user touches the image view. (Android 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.

hires Boolean

Indicates whether or not the source image is in 2x resolution for Retina displays. Use for remote images ONLY. (iPhone, iPad, Mobile Web only.)

image String or Titanium.Blob or Titanium.Filesystem.File

Image to display. Specify using a local file path or URL, or pass a Blob or File object containing image data.

images Array<Object>

Array of images to display in an animation. Accepts the same types as image.

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.

opacity Number

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

paused Boolean

Boolean value indicating if the animation is paused. read-only

preventDefaultImage Boolean

Set to true to disable display of the default image while loading a remote image.

repeatCount Number

Number of times to repeat the image animation.

reverse Boolean

Boolean value indicating if the animation should happen in reverse (from last to first).

right Number or String

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

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

url String

Deprecated URL to the image to display. Deprecated: use image instead.

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.

Events

Name Summary
change

Fired for each frame changed during an animation.

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

error

Fired when an image fails to load.

load

Fired when either the initial image and/or all of the images in an animation are loaded.

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.

singletap

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

start

Fired when the animation starts.

stop

Fired when the animation stops.

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.