| Platform | Since |
|---|---|
| Android | 0.8 |
| iPhone | 0.8 |
| iPad | 0.8 |
| Mobile Web | 1.8 |
An on/off switch control.
On Android, a switch can have text associated with it, and appears as either a checkbox or toggle button.
On iOS, the switch appears as an iOS on/off switch and doesn't have any text associated with it.
Use the Titanium.UI.createSwitch method to create a switch.
The following is a simple example of a switch and receiving change events.
var basicSwitch = Titanium.UI.createSwitch({ value:false }); basicSwitch.addEventListener('change',function(e) { Titanium.API.info('Basic Switch value = ' + e.value + ' act val ' + basicSwitch.value); });
| 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.) |
| getBackgroundRepeat |
Gets the value of the backgroundRepeat 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. |
| getCenter |
Gets the value of the center property. |
| getChildren |
Gets the value of the children property. |
| getColor |
Gets the value of the color property. (Android only.) |
| getEnabled |
Gets the value of the enabled property. |
| getFocusable |
Gets the value of the focusable property. (Android only.) |
| getFont |
Gets the value of the font property. (Android only.) |
| getHeight |
Gets the value of the height 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. |
| 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.) |
| getStyle |
Gets the value of the style property. (Android only.) |
| getTextAlign |
Gets the value of the textAlign property. (Android only.) |
| getTitle |
Gets the value of the title property. (Android only.) |
| getTitleOff |
Gets the value of the titleOff property. (Android only.) |
| getTitleOn |
Gets the value of the titleOn 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. |
| getValue |
Gets the value of the value property. |
| getVerticalAlign |
Gets the value of the verticalAlign property. (Android 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. |
| 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. |
| 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.) |
| setBackgroundRepeat |
Sets the value of the backgroundRepeat 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. |
| setCenter |
Sets the value of the center property. |
| setColor |
Sets the value of the color property. (Android only.) |
| setEnabled |
Sets the value of the enabled property. |
| setFocusable |
Sets the value of the focusable property. (Android only.) |
| setFont |
Sets the value of the font property. (Android only.) |
| setHeight |
Sets the value of the height 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. |
| setRight |
Sets the value of the right property. |
| setSoftKeyboardOnFocus |
Sets the value of the softKeyboardOnFocus property. (Android only.) |
| setStyle |
Sets the value of the style property. (Android only.) |
| setTextAlign |
Sets the value of the textAlign property. (Android only.) |
| setTitle |
Sets the value of the title property. (Android only.) |
| setTitleOff |
Sets the value of the titleOff property. (Android only.) |
| setTitleOn |
Sets the value of the titleOn 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. |
| setValue |
Sets the value of the value property. |
| setVerticalAlign |
Sets the value of the verticalAlign property. (Android 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. |
| 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.) |
| backgroundRepeat | Boolean |
Toggle for whether or not to tile a background across a view. (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. |
| center | Point |
View's center position, in the parent view's coordinates. |
| children | Array<Titanium.UI.View> |
Array of this view's child views. read-only |
| color | String |
Color to use for switch text. (Android only.) |
| enabled | Boolean |
Set to |
| focusable | Boolean |
Whether view should be focusable while navigating with the trackball. (Android only.) |
| font | Font |
Font to use for the switch text. (Android only.) |
| height | Number or String |
View height, in platform-specific units. |
| 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). |
| right | Number or String |
View's right position, in platform-specific units. |
| size | Object |
Rendered size of the view as a dictionary of width and height properties. read-only |
| softKeyboardOnFocus | Number |
Determines keyboard behavior when this view is focused. (Android only.) |
| style | Number |
Style of the switch, either checkbox or toggle button. (Android only.) |
| textAlign | String or Number |
Text alignment, specified using one of the |
| title | String |
text to display with checkbox. Used if style is |
| titleOff | String |
Text to display when a toggle button-style switch is toggled on. (Android only.) |
| titleOn | String |
Text to display when a toggle button-style switch is toggled off. (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. |
| value | Boolean |
Current switch value, |
| verticalAlign | Number or String |
Vertical alignment for the text field, specified using one of the
vertical alignment constants from |
| 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. |
| Name | Summary |
|---|---|
| change |
Fired when the switch value changes. |
| 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.) |
| 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. (iPhone, iPad only.) |
| 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. |
