Class ComponentImage

java.lang.Object
com.codename1.ui.Image
com.codename1.ui.ComponentImage
All Implemented Interfaces:
ActionSource
public class ComponentImage extends Image
A utility wrapper that allows a Component to be used as an Image so that it can be set as the icon for a Label or button.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    ComponentImage.EncodedWrapper
    A wrapper for ComponentImage to convert it to an EncodedImage.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ComponentImage(Component cmp, int w, int h)
    Creates a new image that renders the given component.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    animate()
    Advances this image's animation state, if it is animated.
    Image
    applyMask(Object mask)
    Applies the given alpha mask onto this image and returns the resulting image see the createMask method for indication on how to convert an image into an alpha mask.
    void
    disablePulsingAnimation()
    Disables the pulsing animation.
    protected void
    drawImage(Graphics g, Object nativeGraphics, int x, int y)
    Draws the image.
    protected void
    drawImage(Graphics g, Object nativeGraphics, int x, int y, int w, int h)
    Callback invoked internally by Codename One to draw the image/frame onto the display.
    void
    enablePulsingAnimation(double currStep, double stepSize, double minAlpha, double maxAlpha)
    Enables a pulsing animation on the image.
    Image
    fill(int width, int height)
    Resizes/crops the image so that its center fills the given dimensions.
    Component
    getComponent()
    Gets the wrapped component that is rendered by this image.
    int
    getHeight()
    Returns the height of the image
    int
    getWidth()
    Returns the width of the image
    boolean
    isAnimation()
    Checks if this is an animation.
    boolean
    isPulsingAnimationEnabled()
    Checks if pulsing animation is enabled.
    boolean
    requiresDrawImage()
    Overridden to always return true so that the paint() method is called on this image.
    void
    scale(int width, int height)
    Scale the image to the given width and height, this is a fast algorithm that preserves translucent information
    Image
    scaled(int width, int height)
    Returns a scaled version of this image image using the given width and height, this is a fast algorithm that preserves translucent information.
    void
    setAnimation(boolean anim)
    Sets whether this in an animation.
    EncodedImage
    toEncodedImage()
    Converts to an encoded image.

    Methods inherited from class Image

    addActionListener, applyMask, applyMaskAutoScale, asyncLock, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createIndexed, createMask, createSVG, dispose, exifRotation, exifRotation, exifRotation, fireChangedEvent, flipHorizontally, flipVertically, getExifOrientationTag, getExifOrientationTag, getGraphics, getImage, getImageName, getRGB, getRGB, getRGBCached, getSVGDocument, isAlphaMutableImageSupported, isJPEG, isLocked, isOpaque, isPNG, isSVG, isSVGSupported, lock, mirror, modifyAlpha, modifyAlpha, modifyAlphaWithTranslucency, removeActionListener, rotate, rotate180Degrees, rotate270Degrees, rotate90Degrees, scaledHeight, scaledLargerRatio, scaledSmallerRatio, scaledWidth, setImageName, subImage, toRGB, unlock
    Modifier and Type
    Method
    Description
    void
    addActionListener(ActionListener l)
    Adds ActionListener to receive action events form this source.
    Image
    applyMask(Object mask, int x, int y)
    Applies the given alpha mask onto this image and returns the resulting image see the createMask method for indication on how to convert an image into an alpha mask.
    Image
    applyMaskAutoScale(Object mask)
    Applies the given alpha mask onto this image and returns the resulting image see the createMask method for indication on how to convert an image into an alpha mask.
    void
    asyncLock(Image internal)
    Async lock is the equivalent of a lock operation, however it uses the given image as the hard cache and performs the actual image loading asynchronously.
    static Image
    createImage(byte[] bytes, int offset, int len)
    creates an image from a given byte array data
    static Image
    createImage(int[] rgb, int width, int height)
    creates an image from an RGB image
    static Image
    createImage(int width, int height)
    Creates a white opaque mutable image that may be manipulated using #getGraphics().
    static Image
    createImage(int width, int height, int fillColor)
    Creates a mutable image that may be manipulated using #getGraphics().
    static Image
    createImage(InputStream stream)
    creates an image from an InputStream
    static Image
    createImage(Object nativeImage)
    creates an image from the given native image (e.g. MIDP image object)
    static Image
    createImage(String path)
    Creates an image from a path.
    static Image
    createIndexed(int width, int height, int[] palette, byte[] data)
    Creates an indexed image with byte data this method may return a native indexed image rather than an instance of the IndexedImage class
    Object
    createMask()
    Creates a mask from the given image, a mask can be used to apply an arbitrary alpha channel to any image.
    static Image
    createSVG(String baseURL, boolean animated, byte[] data)
    Creates an SVG Image from the given byte array data and the base URL, this method will throw an exception if SVG is unsupported.
    void
    dispose()
    DO NOT CALL THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING, IT WILL CAUSE PLATFORM SPECIFC CRASHES OTHERWISE! Images dispose automatically for most cases except for very rare special cases.
    static Image
    exifRotation(String capturedImage)
    The main use case of this method is the automatic rotation and flipping of an image returned from the camera or from the gallery, preserving the original format (jpeg or png); it detects the Exif Orientation Tag, if available (all the possible Exif Orientation Tag values are supported); transparency is not preserved.
    static Image
    exifRotation(String capturedImage, String rotatedImage)
    The main use case of this method is the automatic rotation and flipping of an image returned from the camera or from the gallery, preserving the original format (jpeg or png); it detects the Exif Orientation Tag, if available (all the possible Exif Orientation Tag values are supported); transparency is not preserved.
    static Image
    exifRotation(String capturedImage, String rotatedImage, int maxSize)
    The main use case of this method is the automatic rotation and flipping of an image returned from the camera or from the gallery, preserving the original format (jpeg or png); it detects the Exif Orientation Tag, if available (all the possible Exif Orientation Tag values are supported); transparency is not preserved.
    void
    fireChangedEvent()
     
    Image
    flipHorizontally(boolean maintainOpacity)
    Flips this image on the horizontal axis
    Image
    flipVertically(boolean maintainOpacity)
    Flips this image on the vertical axis
    static int
    getExifOrientationTag(InputStream is)
    Gets the EXIF orientation tag of an image, if it's available.
    static int
    getExifOrientationTag(String path)
    Gets the EXIF orientation tag of an image if it's available.
    Graphics
    getGraphics()
    If this is a mutable image a graphics object allowing us to draw on it is returned.
    Object
    getImage()
    Returns the platform specific image implementation, warning the implementation class can change between revisions of Codename One and platforms.
    String
    getImageName()
    The name of the image is set for some images mostly to ease the debugging of Codename One application
    int[]
    getRGB()
    Returns the content of this image as a newly created ARGB array.
    void
    getRGB(int[] rgbData)
    Returns the content of this image in the supplied ARGB array.
    int[]
    getRGBCached()
    Returns the content of this image as a newly created ARGB array or a cached instance if possible.
    Object
    getSVGDocument()
    Returns a platform specific DOM object that can be manipulated by the user to change the SVG Image
    static boolean
    isAlphaMutableImageSupported()
    Returns true if mutable images support alpha transparency
    static boolean
    isJPEG(InputStream inputStream)
    Very fast method to detect if the given inputStream is a JPEG image (according to its guessed mime type)
    boolean
    isLocked()
    Returns true if the image is locked
    boolean
    isOpaque()
    Indicates whether this image is opaque or not
    static boolean
    isPNG(InputStream inputStream)
    Very fast method to detect if the given inputStream is a PNG image (according to its guessed mime type)
    boolean
    isSVG()
    Indicates if this image represents an SVG file or a bitmap file
    static boolean
    isSVGSupported()
    Indicates whether the underlying platform supports creating an SVG Image
    void
    lock()
    This callback indicates that a component pointing at this image is initialized, this allows an image to make performance sensitive considerations e.g.
    Image
    mirror()
    Creates a mirror image for the given image which is useful for some RTL scenarios.
    Image
    modifyAlpha(byte alpha)
    Creates a new image instance with the alpha channel of opaque/translucent pixels within the image using the new alpha value.
    Image
    modifyAlpha(byte alpha, int removeColor)
    Creates a new image instance with the alpha channel of opaque/translucent pixels within the image using the new alpha value.
    Image
    modifyAlphaWithTranslucency(byte alpha)
    Creates a new image instance with the alpha channel of opaque pixels within the image using the new alpha value.
    void
    removeActionListener(ActionListener l)
    Removes ActionListener so that it will no longer receive events from this source.
    Image
    rotate(int degrees)
    Returns an instance of this image rotated by the given number of degrees.
    Image
    rotate180Degrees(boolean maintainOpacity)
    Rotates the image by 180 degrees
    Image
    rotate270Degrees(boolean maintainOpacity)
    Rotates the image by 270 degrees while changing the ratio of the picture
    Image
    rotate90Degrees(boolean maintainOpacity)
    Rotates this image by 90 degrees while changing the ratio of the picture
    Image
    scaledHeight(int height)
    Scales the image to the given height while updating the width based on the aspect ratio of the height
    Image
    scaledLargerRatio(int width, int height)
    Scales the image while maintaining the aspect ratio to the larger size image
    Image
    scaledSmallerRatio(int width, int height)
    Scales the image while maintaining the aspect ratio to the smaller size image
    Image
    scaledWidth(int width)
    Scales the image to the given width while updating the height based on the aspect ratio of the width
    void
    setImageName(String imageName)
    The name of the image is set for some images mostly to ease the debugging of Codename One application
    Image
    subImage(int x, int y, int width, int height, boolean processAlpha)
    Extracts a subimage from the given image allowing us to breakdown a single large image into multiple smaller images in RAM, this actually creates a standalone version of the image for use.
    void
    toRGB(RGBImage image, int destX, int destY, int x, int y, int width, int height)
    Extracts data from this image into the given RGBImage
    void
    unlock()
    This callback indicates that a component pointing at this image is now deinitilized This method may be invoked multiple times.

    Methods inherited from class Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
     
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    final Class
    getClass()
    Returns the runtime class of an object.
    int
    hashCode()
    Returns a hash code value for the object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    String
    toString()
    Returns a string representation of the object.
    final void
    wait()
    Causes current thread to wait until another thread invokes the method or the method for this object.
    final void
    wait(long timeout)
    Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
    final void
    wait(long timeout, int nanos)
    Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

  • Constructor Details

    • ComponentImage

      public ComponentImage(Component cmp, int w, int h)

      Creates a new image that renders the given component.

      Parameters

      • cmp: The component to render.

      • w: The width of the image.

      • h: The height of the image.

  • Method Details

    • getComponent

      public Component getComponent()
      Gets the wrapped component that is rendered by this image.

    • enablePulsingAnimation

      public void enablePulsingAnimation(double currStep, double stepSize, double minAlpha, double maxAlpha)

      Enables a pulsing animation on the image.

      Parameters

      • currStep: The current step.

      • stepSize: The step size.

      • minAlpha: The min alpha

      • maxAlpha: The max alpha

    • disablePulsingAnimation

      public void disablePulsingAnimation()
      Disables the pulsing animation.

    • isPulsingAnimationEnabled

      public boolean isPulsingAnimationEnabled()
      Checks if pulsing animation is enabled.

    • getWidth

      public int getWidth()

      Returns the width of the image

      Returns

      the width of the image

      Overrides:
      getWidth in class Image

    • getHeight

      public int getHeight()

      Returns the height of the image

      Returns

      the height of the image

      Overrides:
      getHeight in class Image

    • scale

      public void scale(int width, int height)

      Scale the image to the given width and height, this is a fast algorithm that preserves translucent information

      Parameters

      • width: width for the scaling

      • height: height of the scaled image

      Deprecated
      Parameters

      • width

      • height

      Overrides:
      scale in class Image

    • fill

      public Image fill(int width, int height)
      Description copied from class: Image

      Resizes/crops the image so that its center fills the given dimensions. This is similar to com.codename1.ui.plaf.Style#BACKGROUND_IMAGE_SCALED_FILL

      Parameters

      • width: the width to fill

      • height: the height to fill

      Returns

      a new image (or the same image if dimensions happen to match) filling the width/height

      Overrides:
      fill in class Image

    • applyMask

      public Image applyMask(Object mask)

      Applies the given alpha mask onto this image and returns the resulting image see the createMask method for indication on how to convert an image into an alpha mask.

      Parameters
      • mask: mask object created by the createMask() method.
      Returns

      image masked based on the given object

      Throws
      • IllegalArgumentException: if the image size doesn't match the mask size
      Parameters
      • mask
      Overrides:
      applyMask in class Image

    • isAnimation

      public boolean isAnimation()
      Checks if this is an animation.
      Overrides:
      isAnimation in class Image

    • setAnimation

      public void setAnimation(boolean anim)

      Sets whether this in an animation.

      Parameters
      • anim: True to make this an animated image

    • requiresDrawImage

      public boolean requiresDrawImage()
      Overridden to always return true so that the paint() method is called on this image.
      Overrides:
      requiresDrawImage in class Image

    • drawImage

      protected void drawImage(Graphics g, Object nativeGraphics, int x, int y)

      Draws the image.

      Parameters

      • g: The graphics context

      • nativeGraphics: The native graphics context

      • x: The x coordinate at which to draw the image.

      • y: The y coordinate at which to draw the image.

      Overrides:
      drawImage in class Image

    • drawImage

      protected void drawImage(Graphics g, Object nativeGraphics, int x, int y, int w, int h)

      Callback invoked internally by Codename One to draw the image/frame onto the display. Image subclasses can override this method to perform drawing of custom image types.

      Parameters

      • g: the graphics object

      • nativeGraphics: the underlying native graphics which might be essential for some image types

      • x: the x coordinate

      • y: the y coordinate

      • w: the width to occupy

      • h: the height to occupy

      Overrides:
      drawImage in class Image

    • scaled

      public Image scaled(int width, int height)

      Returns a scaled version of this image image using the given width and height, this is a fast algorithm that preserves translucent information. The method accepts -1 to preserve aspect ratio in the given axis.

      Parameters

      • width: width for the scaling

      • height: height of the scaled image

      Returns

      new image instance scaled to the given height and width

      Overrides:
      scaled in class Image

    • animate

      public boolean animate()

      Advances this image's animation state, if it is animated.

      Returns

      true if the animation state changed.

      Overrides:
      animate in class Image

    • toEncodedImage

      public EncodedImage toEncodedImage()
      Converts to an encoded image.