[an error occurred while processing this directive]
ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes

Language Reference only       
Package and class filters:
Retrieving Data from Server...
Retrieving Data from Server...
Retrieving Data from Server...
Retrieving Data from Server...
flash.media 
CameraRollBrowseOptions 
Packageflash.media
Classpublic class CameraRollBrowseOptions
InheritanceCameraRollBrowseOptions Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 3

The CameraRollBrowseOptions class defines initialization options for a device's camera roll image browser. This class allows you to request specific width and height properties for the image browser dialog.

The origin property specifies a rectangular area that you do not want the image browser dialog to cover. Note that a child display object's X and Y coordinates are relative to its parent's position. To specify X and Y coordinates that are relative to the Stage, use the DisplayObject.localToGlobal() function.

To use this class, create a CameraRollBrowseOptions object, and pass the object to the CameraRoll.browseForImage() method.

Note: The CameraRollBrowseOptions class is for iOS, and only for the iPad. All other platforms and devices ignore the width, height, and origin properties.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
      height : Number
Specifies the height of the CameraRoll image browser.
CameraRollBrowseOptions
      origin : Rectangle
Specifies the bounds of a display object or screen area that should remain visible when the image browser opens.
CameraRollBrowseOptions
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
      width : Number
Specifies the width of the CameraRoll image browser.
CameraRollBrowseOptions
Public Methods
 MethodDefined By
  
Creates a CameraRollBrowseOptions object.
CameraRollBrowseOptions
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
    

height

property
height:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 3

Specifies the height of the CameraRoll image browser.

Setting this property represents a request for a particular display height. If the device cannot draw the image browser with the requested height, then the device uses the system default height instead.

This property is currently used only on iOS, on the iPad only.



Implementation
    public function get height():Number
    public function set height(value:Number):void

Throws
ArgumentError — When set to a negative value.
    

origin

property 
origin:Rectangle

Language Version: ActionScript 3.0
Runtime Versions: AIR 3

Specifies the bounds of a display object or screen area that should remain visible when the image browser opens.

This rectangle is used as a hint to the operating system for positioning the image browser so that it doesn't cover an important area of the screen. For example, you can set this property to reduce the chance that the dialog will cover a user-interface element used to launch the image browser. However, the setting is just a hint and is not honored if there isn't enough room on the screen to position the image browser without overlapping the specified area.



Implementation
    public function get origin():Rectangle
    public function set origin(value:Rectangle):void

Throws
ArgumentError — When the Rectangle width or height is negative.
    

width

property 
width:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 3

Specifies the width of the CameraRoll image browser.

Setting this property represents a request for a particular display width. If the device cannot draw the image browser with the requested width, then the device uses the system default width instead.

This property is currently used only on iOS, on the iPad only.



Implementation
    public function get width():Number
    public function set width(value:Number):void

Throws
ArgumentError — When set to a negative value.
Constructor Detail
    

CameraRollBrowseOptions

()Constructor
public function CameraRollBrowseOptions()

Language Version: ActionScript 3.0
Runtime Versions: AIR 3

Creates a CameraRollBrowseOptions object.

The default property values of the newly created object are:

  • width = 0.0
  • height = 0.0
  • origin = new Rectangle (0.0, 0.0, 0.0, 0.0)