Titanium.UI.iPad.DocumentViewer

Object of Titanium.UI.iPad.

Platform	Since
iPad	1.8

Summary

A DocumentViewer provides in-app support for managing user interactions with files in the local system.

Description

For example, an email program might use this class to allow the user to preview attachments and open them in other apps. Use this class to present an appropriate user interface for previewing or printing a specified file. The DocumentViewer is created by the method Titanium.UI.iPad.createDocumentViewer.

Code Examples

Document Viewer Example

In this example, we create a document viewer with a window button and right navigation button.</p>
<p>//-----------example--------
    Titanium.UI.setBackgroundColor('#000');
    //creating the window
    var win1 = Titanium.UI.createWindow({
        title:'win 1',
        backgroundColor:'#fff'
        });
     //add window - navigation bar
     var modalWin = Ti.UI.createWindow();
     //nav bar
     var navmodal = Ti.UI.iPhone.createNavigationGroup({
        window:modalWin
        });
     win1.add(navmodal);
     //button for the nav bar
     var b2t = Titanium.UI.createButton({
       title:'Launch'
       });
     modalWin.RightNavButton = b2t;
     //button for the window
     var b1t = Titanium.UI.createButton({
       title:'Launch',
       height:40,
       width:200,
       top:270
       });
     win1.add(b1t);
     //Setting up the documentviewer
     z = Ti.UI.iPad.createDocumentViewer({url:'Example.pdf'});
     //documentviewer with animation set on and a quicklook view poping up next to a view
     b1t.addEventListener('click', function(){z.show({animated:false,view:b2t});});
     //documentviewer with animation set off
     b2t.addEventListener('click', function(){z.show();});
     win1.open();

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.
fireEvent	Fires a synthesized event to any registered listeners.
getAnchorPoint	Gets the value of the anchorPoint property.
getAnimatedCenterPoint	Gets the value of the animatedCenterPoint property.
getBackgroundColor	Gets the value of the backgroundColor property.
getBackgroundDisabledColor	Gets the value of the backgroundDisabledColor property.
getBackgroundDisabledImage	Gets the value of the backgroundDisabledImage property.
getBackgroundFocusedColor	Gets the value of the backgroundFocusedColor property.
getBackgroundFocusedImage	Gets the value of the backgroundFocusedImage property.
getBackgroundGradient	Gets the value of the backgroundGradient property.
getBackgroundImage	Gets the value of the backgroundImage property.
getBackgroundLeftCap	Gets the value of the backgroundLeftCap property.
getBackgroundSelectedColor	Gets the value of the backgroundSelectedColor property.
getBackgroundSelectedImage	Gets the value of the backgroundSelectedImage property.
getBackgroundTopCap	Gets the value of the backgroundTopCap property.
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.
getFocusable	Gets the value of the focusable property.
getHeight	Gets the value of the height property.
getKeepScreenOn	Gets the value of the keepScreenOn property.
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.
getTop	Gets the value of the top property.
getTouchEnabled	Gets the value of the touchEnabled property.
getTransform	Gets the value of the transform 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.
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.
setBackgroundColor	Sets the value of the backgroundColor property.
setBackgroundDisabledColor	Sets the value of the backgroundDisabledColor property.
setBackgroundDisabledImage	Sets the value of the backgroundDisabledImage property.
setBackgroundFocusedColor	Sets the value of the backgroundFocusedColor property.
setBackgroundFocusedImage	Sets the value of the backgroundFocusedImage property.
setBackgroundGradient	Sets the value of the backgroundGradient property.
setBackgroundImage	Sets the value of the backgroundImage property.
setBackgroundLeftCap	Sets the value of the backgroundLeftCap property.
setBackgroundSelectedColor	Sets the value of the backgroundSelectedColor property.
setBackgroundSelectedImage	Sets the value of the backgroundSelectedImage property.
setBackgroundTopCap	Sets the value of the backgroundTopCap property.
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.
setFocusable	Sets the value of the focusable property.
setHeight	Sets the value of the height property.
setKeepScreenOn	Sets the value of the keepScreenOn property.
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.
setSize	Sets the value of the size property.
setSoftKeyboardOnFocus	Sets the value of the softKeyboardOnFocus property.
setTop	Sets the value of the top property.
setTouchEnabled	Sets the value of the touchEnabled property.
setTransform	Sets the value of the transform property.
setUrl	change the url of the document viewer
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	to display the document viewer over the current view.
toImage	Returns an image of the rendered view, as a Blob.

Properties

Name	Type	Summary
anchorPoint	`Point`	Anchor point where animation should occur, relative to the view's boundaries.
animatedCenterPoint	`Point`	Current position of the view during an animation. read-only
backgroundColor	String	Background color of the view.
backgroundDisabledColor	String	Disabled background color of the view.
backgroundDisabledImage	String	Disabled background image for the view, specified as a local file path or URL.
backgroundFocusedColor	String	Focused background color of the view.
backgroundFocusedImage	String	Focused background image for the view, specified as a local file path or URL.
backgroundGradient	`Gradient`	A background gradient for the view.
backgroundImage	String	Background image for the view, specified as a local file path or URL.
backgroundLeftCap	Number	Size of the left end cap.
backgroundSelectedColor	String	Selected background color of the view.
backgroundSelectedImage	String	Selected background image url for the view, specified as a local file path or URL.
backgroundTopCap	Number	Size of the top end cap.
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.
focusable	Boolean	Whether view should be focusable while navigating with the trackball.
height	Number or String	View height, in platform-specific units.
keepScreenOn	Boolean	Whether to keep the device screen on.
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	Size of the view as a dictionary of width and height properties.
softKeyboardOnFocus	Number	Determines keyboard behavior when this view is focused.
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.
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
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.
longclick	Fired when the device detects a long click.
longpress	Fired when the device detects a long press.
pinch	Fired when the device detects a pinch gesture.
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.
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.