UIImage (cmioslayer 3.4.0 API)

java.lang.Object
- crossmobile.ios.foundation.NSObject
- - crossmobile.ios.uikit.UIImage

All Implemented Interfaces:

NSSecureCoding
```
public class UIImage
extends NSObject
implements NSSecureCoding
```
UIImage class defines an object that represents images in an application.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static UIImage`	`animatedImageNamed(String name, double duration)` Returns a special animated image based on a image sequence, starting to name0 up to name1024.
`static UIImage`	`animatedImageWithImages(List<UIImage> images, double duration)`
`CGImage`	`CGImage()` Returns the underlying image data.
`void`	`drawAtPoint(CGPoint point)` Draws this image using the specified benchmark point.
`void`	`drawInRect(CGRect rect)` Draws this image within the specified rectangle.
`double`	`duration()` The duration of the animated image, or 0 if it is not animated.
`static UIImage`	`imageNamed(String filename)` Returns the image that corresponds to the specified filename.
`int`	`imageOrientation()`
`List<UIImage>`	`images()` In case this is an animated image, the list of the animated images, or null otherwise.
`static UIImage`	`imageWithCGImage(CGImage img)` Returns an image using the given Core Graphics image.
`static UIImage`	`imageWithCGImage(CGImage img, double scale, int UIImageOrientation)` Returns an image using the given Core Graphics image with the specified scale and orientation factors.
`static UIImage`	`imageWithContentsOfFile(String filename)` Returns an image that is created using the image data of the specified file.
`static UIImage`	`imageWithData(NSData data)` Returns an image that is created using the specified image data.
`UIImage`	`imageWithRenderingMode(int UIImageRenderingMode)` Return a new image, based on the current image, with different rendering mode
`NSData`	`JPEGRepresentation(double compressionQuality)` Returns JPEG encoded data for this image.
`NSData`	`PNGRepresentation()` Returns PNG encoded data for this image.
`int`	`renderingMode()` Retreive the rendering mode of this image.
`UIImage`	`resizableImageWithCapInsets(UIEdgeInsets capInsets)` Returns an image with the specified cap insets.
`UIImage`	`resizableImageWithCapInsets(UIEdgeInsets capInsets, int UIImageResizingMode)` Returns an image with the specified cap insets and resizing mode.
`double`	`scale()` The scaling of this image: this is used for high resolution images to display correctly.
`CGSize`	`size()` Returns the dimensions of this image.
`UIImage`	`stretchableImageWithLeftCapWidth(int leftCapWidth, int topCapHeight)` Deprecated.
`String`	`toString()`
`void`	`writeToSavedPhotosAlbum(UIImageWriteToPhotoAlbumHandler callback, Object contextInfo)` Adds this image to the user’s photo album.

Methods inherited from class crossmobile.ios.foundation.NSObject
addObserver, observeValueForKeyPath, performSelector, performSelectorOnMainThread, release, removeObserver, removeObserver, retain, setValueForKey, setValueForUndefinedKey, valueForKey, valueForUndefinedKey

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface crossmobile.ios.foundation.NSSecureCoding
supportsSecureCoding

- Method Detail
  - imageWithCGImage
```
public static UIImage imageWithCGImage(CGImage img)
```
    Returns an image using the given Core Graphics image.
    
    Parameters:
    
    img - The Core Graphics image used.
    
    Returns:
    
    The new image.
  - imageWithCGImage
```
public static UIImage imageWithCGImage(CGImage img,
                                       double scale,
                                       int UIImageOrientation)
```
    Returns an image using the given Core Graphics image with the specified scale and orientation factors.
    
    Parameters:
    
    img - The Core Graphics image used.
    
    scale - The scale of the new image.
    
    UIImageOrientation - The orientation of the image.
    
    Returns:
    
    The new image.
    
    See Also:
    
    UIImageOrientation
  - imageNamed
```
public static UIImage imageNamed(String filename)
```
    Returns the image that corresponds to the specified filename.
    
    Parameters:
    
    filename - The filename for which the image is requested.
    
    Returns:
    
    The image that corresponds to the specified filename.
  - imageWithData
```
public static UIImage imageWithData(NSData data)
```
    Returns an image that is created using the specified image data.
    
    Parameters:
    
    data - The image data for the new image.
    
    Returns:
    
    The new image created by the specified image data.
  - imageWithContentsOfFile
```
public static UIImage imageWithContentsOfFile(String filename)
```
    Returns an image that is created using the image data of the specified file.
    
    Parameters:
    
    filename - The file name containing the image data of the new image.
    
    Returns:
    
    The new image created using the image data of the file.
  - animatedImageNamed
```
public static UIImage animatedImageNamed(String name,
                                         double duration)
```
    Returns a special animated image based on a image sequence, starting to name0 up to name1024.
    
    Parameters:
    
    name - The base name of this image
    
    duration - the duration of the animation
    
    Returns:
    
    The animated image
  - animatedImageWithImages
```
public static UIImage animatedImageWithImages(List<UIImage> images,
                                              double duration)
```
  - stretchableImageWithLeftCapWidth
```
@Deprecated
public UIImage stretchableImageWithLeftCapWidth(int leftCapWidth,
                                                            int topCapHeight)
```
    Deprecated.
    
    Returns a stretchable image with the specified cap insets.
    
    Parameters:
    
    leftCapWidth - The width of the cap.
    
    topCapHeight - The height of the cap.
    
    Returns:
    
    The new image object.
  - resizableImageWithCapInsets
```
public UIImage resizableImageWithCapInsets(UIEdgeInsets capInsets)
```
    Returns an image with the specified cap insets.
    
    Parameters:
    
    capInsets - The cap insets of the new image.
    
    Returns:
    
    The new image with the specified cap insets.
  - resizableImageWithCapInsets
```
public UIImage resizableImageWithCapInsets(UIEdgeInsets capInsets,
                                           int UIImageResizingMode)
```
    Returns an image with the specified cap insets and resizing mode.
    
    Parameters:
    
    capInsets - The cap insets of the new image.
    
    UIImageResizingMode - The resizing mode of the new image.
    
    Returns:
    
    The new image with the specified parameters.
  - imageWithRenderingMode
```
public UIImage imageWithRenderingMode(int UIImageRenderingMode)
```
    Return a new image, based on the current image, with different rendering mode
    
    Parameters:
    
    UIImageRenderingMode - the new rendering mode
    
    Returns:
    
    the new reference image
  - imageOrientation
```
public int imageOrientation()
```
  - scale
```
public double scale()
```
    The scaling of this image: this is used for high resolution images to display correctly.
    
    Returns:
    
    the image scaling
  - renderingMode
```
public int renderingMode()
```
    Retreive the rendering mode of this image. To change the rendering mode, use the method #imageWithRenderingMode(int)
    
    Returns:
    
    the current unmutable rendering mode
  - CGImage
```
public CGImage CGImage()
```
    Returns the underlying image data.
    
    Returns:
    
    The underlying image data.
  - drawInRect
```
public void drawInRect(CGRect rect)
```
    Draws this image within the specified rectangle.
    
    Parameters:
    
    rect - The rectangle into which the image is drawn.
  - drawAtPoint
```
public void drawAtPoint(CGPoint point)
```
    Draws this image using the specified benchmark point.
    
    Parameters:
    
    point - The benchmark point of the image.
  - size
```
public CGSize size()
```
    Returns the dimensions of this image.
    
    Returns:
    
    The dimensions of the image.
  - images
```
public List<UIImage> images()
```
    In case this is an animated image, the list of the animated images, or null otherwise.
    
    Returns:
    
    List of animated images
  - duration
```
public double duration()
```
    The duration of the animated image, or 0 if it is not animated.
    
    Returns:
    
    The animated image duration
  - PNGRepresentation
```
public NSData PNGRepresentation()
```
    Returns PNG encoded data for this image.
    
    Returns:
    
    The data of this png image.
  - JPEGRepresentation
```
public NSData JPEGRepresentation(double compressionQuality)
```
    Returns JPEG encoded data for this image.
    
    Parameters:
    
    compressionQuality - The quality of the image.
    
    Returns:
    
    The data of this JPEG image
  - writeToSavedPhotosAlbum
```
public void writeToSavedPhotosAlbum(UIImageWriteToPhotoAlbumHandler callback,
                                    Object contextInfo)
```
    Adds this image to the user’s photo album.
    
    Parameters:
    
    callback - The callback handler.
    
    contextInfo - The context info.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UIImage

Method Summary

Methods inherited from class crossmobile.ios.foundation.NSObject

Methods inherited from class java.lang.Object

Methods inherited from interface crossmobile.ios.foundation.NSSecureCoding

Method Detail

imageWithCGImage

imageWithCGImage

imageNamed

imageWithData

imageWithContentsOfFile

animatedImageNamed

animatedImageWithImages

stretchableImageWithLeftCapWidth

resizableImageWithCapInsets

resizableImageWithCapInsets

imageWithRenderingMode

imageOrientation

scale

renderingMode

CGImage

drawInRect

drawAtPoint

size

images

duration

PNGRepresentation

JPEGRepresentation

writeToSavedPhotosAlbum

toString