BBXImage

java.lang.Object
- BBXImage.BBXImage

```
public class BBXImage
extends Object
```
In BBj 9.00 and higher, the BBXImage utility provides an object-oriented way to manipulate an image in a variety of ways. Obtain the BBXImage from a BBjImage, from a file on the server, or from a URL such as an HTTP URL that retrieves an image from the Internet. You can then modify the BBXImage in a number of ways and affect its scale (as a percentage or proportional to width or height), rotation, and opacity. It is also possible to add borders, drop shadows, reflections, and even crop the corners of the image. After manipulating the BBXImage, the class offers methods to save it out as a PNG or JPG file with a configurable compression percentage.
In BBj 15.0 and higher, the BBXImage Utility provides filtering methods to
- Adjust the brightness of the image
- Adjust the contrast of the image
- Blur the image
- Sharpen the image
- Convert the image to grayscale
In BBj 16.0 and higher, the BBXImage Utility provides methods to
- Modify the canvas size and facilitate scaling an image while maintaining the original aspect ratio
- Create an image object by drawing text on a graphics context with customized fonts, colors, and alignment
In BBj 17.0 and higher, the BBXImage Utility provides a method to
- Get a base64-encoded ASCII string version of an image
In BBj 18.0 and higher, the BBXImage Utility provides methods to
- Crop an image to a specified rectangular region
- Return a subimage defined by a specified rectangular region
- Draw bordered or filled rectangles and ovals in a specified color
- Add borders to the image
- Resize the image's canvas
- Add a color overlay to the image
In BBj 19.0 and higher, the BBXImage Utility provides methods to
- Save the image in the GIF, BMP, and TIFF image formats
Here's a quick rundown of what you need to do to use it in your program:
1. Ensure the <bbjhome>/utils/ directory is in your prefix. The BBXImage.bbj source program is located there, so if that directory is in your prefix then the utility will be accessible in your applications.
2. Add a USE statement for the utility so that your application can reference the custom class and provide code completion for its methods. The USE statement should look like this:
  USE ::BBXImage.bbj::BBXImage
To use the BBXImage class in your application, the process goes something like this:
1. Create a BBXImage object from something like a BBjImage, a Java Image or ImageIcon, URL, etc:
```
declare BBXImage xImage!
xImage! = new BBXImage(mySource!)
```
2. Manipulate the image in some way, such as resizing the image using one of the scale methods:
```
xImage!.scaleProportionally(maxWidth, maxHeight)
```
3. Do something with the resultant image, like setting the contents of a BBjImageCtrl or saving it out as a compressed JPG file:
```
myImageCtrl!.setImage(xImage!.getBBjImage())
xImage!.saveAsJPG(fullPathToJpgFile$, compressionLevel75)
```
THROWn Error Codes:
- 313: Invalid color specified. The specified string for a hex color description was invalid. It should in a format like #fafbfc or #f0c.
- 400: Invalid image source provided or missing file.
Since:

BBj 9.00

See Also:

The source file for a small sample program at the beginning of the file

Field Summary

Fields
Modifier and Type Field and Description

BBjNumber Height

BBjNumber Width

Fields
Modifier and Type	Field and Description
`BBjNumber`	`Height`
`BBjNumber`	`Width`

Constructor Summary

Constructors
Constructor and Description
`BBXImage(BBjImage p_image!)` BBXImage Constructor specifying a BBjImage for the source image
`BBXImage(BBjString p_imageFile!)` BBXImage Constructor specifying a string for the source image's file path
`BBXImage(BBjString p_text$, BBjString p_foreColor$, BBjNumber p_foreOpacity, BBjString p_backColor$, BBjNumber p_backOpacity, Font p_font!, BBjNumber p_width, BBjNumber p_height, BBjNumber p_hAlign, BBjNumber p_vAlign, BBjNumber p_hPadding, BBjNumber p_vPadding)` BBXImage Constructor that creates a BBXImage object by drawing text on a graphics context.
`BBXImage(BBXImage p_bbximage!)` BBXImage Constructor specifying another BBXImage for the source image
`BBXImage(File p_imageFile!)` BBXImage Constructor specifying a Java File object for the source image's file path
`BBXImage(Image p_image!)` BBXImage Constructor specifying a Java Image object for the source image
`BBXImage(ImageIcon p_imageIcon!)` BBXImage Constructor specifying an ImageIcon for the source image
`BBXImage(URL p_imageURL!)` BBXImage Constructor specifying a Java URL object for the source image

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColorOverlay(BBjColor p_color!)` Method to overlay the BBXImage with a BBjColor (which usually has an alpha component)
`void`	`addColorOverlay(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to overlay the BBXImage with a color (which usually has an alpha component)
`BBXImage`	`clone()` Method to get a copy of the BBXImage
`void`	`crop(BBjNumber p_x, BBjNumber p_y, BBjNumber p_w, BBjNumber p_h)` Method to crop the BBXImage to a specified rectangular region
`void`	`cropBackground()` Method to return the smallest image possible by cropping out the background of the original image using the top left pixel's color as the base background color to crop out.
`void`	`cropTransparent()` Method to return the smallest image possible by cropping out the transparent edges of the original image
`void`	`drawFilledOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_outlineColor!, BBjColor p_fillColor!, BBjNumber p_rotation)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawFilledOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawFilledOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!, BBjNumber p_rotation)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawFilledRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_outlineColor!, BBjColor p_fillColor!, BBjNumber p_rotation)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawFilledRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawFilledRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_outlineColor!, Color p_fillColor!, BBjNumber p_rotation)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_color!)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity, BBjNumber p_rotation)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawOval(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_color!)` Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjColor p_color!)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity, BBjNumber p_rotation)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`void`	`drawRect(BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjNumber p_thickness, Color p_color!)` Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
`BBjNumber`	`exists()` Method to determine whether the BBXImage exists or not
`void`	`flipHorizontally()` Method to flip the BBXImage horizontally
`void`	`flipVertically()` Method to flip the BBXImage vertically
`BBjString`	`getBase64()` Method to return the BBXImage out to an Image Output Stream 32-bit converted to a Base64 ASCII Stream
`BBjImage`	`getBBjImage()` Method to get a BBjImage for the BBXImage
`BufferedImage`	`getBufferedImage()` Method to get a BufferedImage of type BufferedImage.TYPE_INT_ARGB from the BBXImage
`BufferedImage`	`getBufferedImage(BBjNumber p_bufferedImageType!)` Method to get a BufferedImage from the BBXImage
`static Color`	`getColorWithAlphaFromHexString(BBjString p_colorHexString$, BBjNumber p_opacity)` Method to create a Java Color with an alpha channel from a hex string
`BBjString`	`getDescription()` Method to get the description of the BBXImage
`BBjNumber`	`getHeight()` Method to get the height of the BBXImage
`static BBjString`	`getHexStringFromColor(Color p_color!)` Method to get a hex representation of a Java Color with an alpha channel
`Image`	`getImage()` Method to get an ImageIcon from the BBXImage
`ImageIcon`	`getImageIcon()` Method to get an ImageIcon from the BBXImage
`BBXImage`	`getSubimage(BBjNumber p_x, BBjNumber p_y, BBjNumber p_w, BBjNumber p_h)` Method to return a BBXImage that is a subimage defined by a specified rectangular region
`BBjNumber`	`getWidth()` Method to get the width of the BBXImage
`void`	`rotate(BBjNumber p_degrees)` Method to rotate the BBXImage
`void`	`roundBottomCorners(BBjNumber arcWidth, BBjNumber arcHeight)` Method to round the bottom corners (knockout) of the BBXImage given a cornerRadius
`void`	`roundCorners(BBjNumber arcWidth, BBjNumber arcHeight)` Method to round the corners (knockout) of the BBXImage given a cornerRadius
`void`	`roundTopCorners(BBjNumber arcWidth, BBjNumber arcHeight)` Method to round the top corners (knockout) of the BBXImage given a cornerRadius
`void`	`saveAsBMP(BBjString p_imageFile$)` Method to save the BBXImage out to a .bmp file
`void`	`saveAsGIF(BBjString p_imageFile$)` Method to save the BBXImage out to a .gif file
`void`	`saveAsJPG(BBjString p_imageFile$, BBjNumber p_compressionLevelPercentage)` Method to save the BBXImage out to a .jpg file
`void`	`saveAsPNG(BBjString p_imageFile$)` Method to save the BBXImage out to a 32-bit .png file with transparency
`void`	`saveAsTIFF(BBjString p_imageFile$)` Method to save the BBXImage out to a .tiff file
`void`	`scale(BBjNumber p_percentage)` Method to scale the BBXImage given a percentage
`void`	`scale(BBjNumber p_width, BBjNumber p_height)` Method to scale the BBXImage given a width and height
`void`	`scaleHeight(BBjNumber p_width)` Method to scale the BBXImage preserving the aspect ratio given the width
`void`	`scaleProportionally(BBjNumber p_maxDimension)` Method to scale the BBXImage preserving the aspect ratio given the maximum width or height dimension.
`void`	`scaleProportionally(BBjNumber p_maxWidth, BBjNumber p_maxHeight)` Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions.
`void`	`scaleProportionallyAndResizeCanvas(BBjNumber p_maxWidth, BBjNumber p_maxHeight)` Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions, and then resize the canvas so that the image will be resized to the specified width and height.
`void`	`scaleProportionallyResizeCanvasAndSetImage(BBjNumber p_maxWidth, BBjNumber p_maxHeight, BBjImageCtrl p_imgCtrl!)` Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions, then resize the canvas so that the image will be resized to the specified width and height.
`void`	`scaleWidth(BBjNumber p_height)` Method to scale the BBXImage preserving the aspect ratio given the height
`void`	`scaleWithHints(BBjNumber p_width, BBjNumber p_height, HashMap p_renderingHintsMap!)` Method to scale the BBXImage given a width and height and HashMap of Graphics2D rendering hints
`void`	`setBorder(BBjNumber borderSize, BBjColor color!)` Method to add a border to the BBXImage
`void`	`setBorder(BBjNumber borderSize, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to add a border to the BBXImage
`void`	`setCanvasSize(BBjNumber p_width, BBjNumber p_height)` Method to resize the BBXImage's canvas, specifying transparent for the fill color.
`void`	`setCanvasSize(BBjNumber p_width, BBjNumber p_height, BBjColor p_color!)` Method to resize the BBXImage's canvas.
`void`	`setCanvasSize(BBjNumber p_width, BBjNumber p_height, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to resize the BBXImage's canvas.
`void`	`setCornerWaterMark(BBXImage watermarkImage!, BBjNumber opacity, BBjNumber width, BBjNumber height, BBjNumber anchorPoint)` Method to add a watermark logo to the BBXImage
`BBjString`	`setDescription(BBjString p_description$)` Method to set the description of the BBXImage
`void`	`setDropShadow(BBjNumber shadowSize, BBjNumber shadowOpacity, BBjNumber xOffset, BBjNumber yOffset)` Method to add a drop shadow to the BBXImage
`void`	`setFilterBlur(BBjNumber p_blurAmount)` Method to filter the BBXImage and increase the blurriness
`void`	`setFilterBrightness(BBjNumber p_fraction)` Method to adjust the brightness of the BBXImage
`void`	`setFilterContrast(BBjNumber p_fraction)` Method to adjust the contrast of the BBXImage
`void`	`setFilterGrayscale()` Method to filter the BBXImage and convert it to grayscale (completely desaturated)
`void`	`setFilterSharpen(BBjNumber p_sharpenAmount)` Method to filter the BBXImage and increase the sharpness
`void`	`setImageIcon(ImageIcon p_imageIcon!)` Method to set the ImageIcon for the BBXImage
`void`	`setOpacity(BBjNumber p_percentTransparent)` Method to set the transparency of the BBXImage
`void`	`setReflection(BBjNumber reflectionLength, BBjNumber reflectionOpacity, BBjNumber blurred, BBjNumber verticalSpace)` Method to add a reflection to the BBXImage

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

- Field Detail
  - Width
```
public BBjNumber Width
```
  - Height
```
public BBjNumber Height
```
- Constructor Detail
  - BBXImage
```
public BBXImage(BBXImage p_bbximage!)
```
    BBXImage Constructor specifying another BBXImage for the source image
    
    Since:
    
    In BBj 15.10 and higher
  - BBXImage
```
public BBXImage(ImageIcon p_imageIcon!)
```
    BBXImage Constructor specifying an ImageIcon for the source image
  - BBXImage
```
public BBXImage(Image p_image!)
```
    BBXImage Constructor specifying a Java Image object for the source image
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/awt/Image.html
  - BBXImage
```
public BBXImage(URL p_imageURL!)
```
    BBXImage Constructor specifying a Java URL object for the source image
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/net/URL.html
  - BBXImage
```
public BBXImage(File p_imageFile!)
```
    BBXImage Constructor specifying a Java File object for the source image's file path
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/io/File.html
  - BBXImage
```
public BBXImage(BBjString p_imageFile!)
```
    BBXImage Constructor specifying a string for the source image's file path
  - BBXImage
```
public BBXImage(BBjImage p_image!)
```
    BBXImage Constructor specifying a BBjImage for the source image
  - BBXImage
```
public BBXImage(BBjString p_text$,
BBjString p_foreColor$,
BBjNumber p_foreOpacity,
BBjString p_backColor$,
BBjNumber p_backOpacity,
Font p_font!,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_hAlign,
BBjNumber p_vAlign,
BBjNumber p_hPadding,
BBjNumber p_vPadding)
```
    BBXImage Constructor that creates a BBXImage object by drawing text on a graphics context. Multi-line strings are denoted by including a linebreak ($0A$) between the lines of text.
    
    Parameters:
    
    p_text$ - The text string to draw
    
    p_foreColor$ - The foreground color of the resultant text specified as a hex color string. An example would be "#ff00cc"
    
    p_foreOpacity - The desired opacity value (0-1) of the foreground color. 0 = Fully Transparent, 1 = Fully Opaque.
    
    p_backColor$ - The background color of the resultant text specified as a hex color string. An example would be "#ff00cc"
    
    p_backOpacity - The desired opacity value (0-1) of the background color. 0 = Fully Transparent, 1 = Fully Opaque.
    
    p_font! - The Java Font used to draw the text
    
    p_width - The width of the resultant Image (0 to automatically determine the width)
    
    p_height - The height of the resultant Image (0 to automatically determine the height)
    
    p_hAlign - The horizontal text alignment: 0 = Left, 1 = Center, 2 = Right
    
    p_vAlign - The vertical text alignment: 0 = Top, 1 = Middle, 2 = Bottom
    
    p_hPadding - The number of pixels of padding to be added horizontally (added to the left and right sides)
    
    p_vPadding - The number of pixels of padding to be added vertically (added to the top and bottom sides)
    
    Since:
    
    In BBj 15.10 and higher
- Method Detail
  - clone
```
public BBXImage clone()
```
    Method to get a copy of the BBXImage
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A cloned version of the BBXImage
    
    Since:
    
    In BBj 15.0 and higher
  - getBufferedImage
```
public BufferedImage getBufferedImage()
```
    Method to get a BufferedImage of type BufferedImage.TYPE_INT_ARGB from the BBXImage
    
    Returns:
    
    A BufferedImage representation of the BBXImage
    
    Since:
    
    In BBj 15.0 and higher
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html
  - getBufferedImage
```
public BufferedImage getBufferedImage(BBjNumber p_bufferedImageType!)
```
    Method to get a BufferedImage from the BBXImage
    
    Parameters:
    
    p_bufferedImageType! - The type of BufferedImage to return, such as BufferedImage.TYPE_INT_ARGB
    
    Returns:
    
    A BufferedImage representation of the BBXImage
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html
  - getImage
```
public Image getImage()
```
    Method to get an ImageIcon from the BBXImage
    
    Returns:
    
    An Image representation of the BBXImage
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/awt/image/package-summary.html
  - getImageIcon
```
public ImageIcon getImageIcon()
```
    Method to get an ImageIcon from the BBXImage
    
    Returns:
    
    An Image representation of the BBXImage
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/javax/swing/ImageIcon.html
  - setImageIcon
```
public void setImageIcon(ImageIcon p_imageIcon!)
```
    Method to set the ImageIcon for the BBXImage
    
    Parameters:
    
    An - ImageIcon containing the desired contents of the BBXImage
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/javax/swing/ImageIcon.html
  - getBBjImage
```
public BBjImage getBBjImage()
```
    Method to get a BBjImage for the BBXImage
    
    Returns:
    
    A BBjImage version of the the BBXImage
    
    See Also:
    
    http://documentation.basis.com/BASISHelp/WebHelp/gridctrl/bbjimage.htm
  - getBase64
```
public BBjString getBase64()
```
    Method to return the BBXImage out to an Image Output Stream 32-bit converted to a Base64 ASCII Stream
    
    Since:
    
    In BBj 16.20 and higher
  - getWidth
```
public BBjNumber getWidth()
```
    Method to get the width of the BBXImage
    
    Returns:
    
    The width in pixels of the BBXImage
  - getHeight
```
public BBjNumber getHeight()
```
    Method to get the height of the BBXImage
    
    Returns:
    
    The height in pixels of the BBXImage
  - getDescription
```
public BBjString getDescription()
```
    Method to get the description of the BBXImage
    
    Returns:
    
    Gets the description of the image. This is meant to be a brief textual description of the object. For example, it might be presented to a blind user to give an indication of the purpose of the image. The description may be null.
  - getSubimage
```
public BBXImage getSubimage(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_w,
BBjNumber p_h)
```
    Method to return a BBXImage that is a subimage defined by a specified rectangular region
    
    Parameters:
    
    p_x - The X coordinate of the upper-left corner of the specified rectangular region
    
    p_y - The Y coordinate of the upper-left corner of the specified rectangular region
    
    p_w - The width of the specified rectangular region
    
    p_h - height of the specified rectangular region
    
    Returns:
    
    A BBXImage that is a subimage of the original BBXImages
    
    Since:
    
    In BBj 18.10 and higher
  - crop
```
public void crop(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_w,
BBjNumber p_h)
```
    Method to crop the BBXImage to a specified rectangular region
    
    Parameters:
    
    p_x - The X coordinate of the upper-left corner of the specified rectangular region
    
    p_y - The Y coordinate of the upper-left corner of the specified rectangular region
    
    p_w - The width of the specified rectangular region
    
    p_h - height of the specified rectangular region
    
    Since:
    
    In BBj 18.10 and higher
  - setDescription
```
public BBjString setDescription(BBjString p_description$)
```
    Method to set the description of the BBXImage
    
    Parameters:
    
    The - description of the BBXImage. This is meant to be a brief textual description of the object. For example, it might be presented to a blind user to give an indication of the purpose of the image.
  - setFilterBrightness
```
public void setFilterBrightness(BBjNumber p_fraction)
```
    Method to adjust the brightness of the BBXImage
    
    Parameters:
    
    p_fraction - The amount to lighten or darken the image. A positive number will lighten the image, a negative number will darken the image. For example, providing a value of 0.5 will make the image 50% brighter. Values range from -1.0 to 1.0.
    
    Since:
    
    In BBj 15.0 and higher
  - setFilterContrast
```
public void setFilterContrast(BBjNumber p_fraction)
```
    Method to adjust the contrast of the BBXImage
    
    Parameters:
    
    p_fraction - The amount of contrast to add or subtract from the image. A positive number will lighten the image, a negative number will darken the image. For example, providing a value of 0.5 will make the image have 50% more contrast. Values range from -1.0 to 1.0.
    
    Since:
    
    In BBj 15.0 and higher
  - setFilterGrayscale
```
public void setFilterGrayscale()
```
    Method to filter the BBXImage and convert it to grayscale (completely desaturated)
    
    Since:
    
    In BBj 15.0 and higher
  - setFilterBlur
```
public void setFilterBlur(BBjNumber p_blurAmount)
```
    Method to filter the BBXImage and increase the blurriness
    
    Parameters:
    
    p_blurAmount - The amount to increase the blurriness. The amount generally ranges from 1 to about 10 for best results.
    
    Since:
    
    In BBj 15.0 and higher
  - setFilterSharpen
```
public void setFilterSharpen(BBjNumber p_sharpenAmount)
```
    Method to filter the BBXImage and increase the sharpness
    
    Parameters:
    
    p_sharpenAmount - The amount to increase the sharpness. The amount generally ranges from 1 to about 10 for best results.
    
    Since:
    
    In BBj 15.0 and higher
  - exists
```
public BBjNumber exists()
```
    Method to determine whether the BBXImage exists or not
    
    Returns:
    
    0 = the image does not exist, 1 = the image does exist
  - cropTransparent
```
public void cropTransparent()
```
    Method to return the smallest image possible by cropping out the transparent edges of the original image
    
    Since:
    
    In BBj 15.0 and higher
    
    See Also:
    
    cropBackground()
  - cropBackground
```
public void cropBackground()
```
    Method to return the smallest image possible by cropping out the background of the original image using the top left pixel's color as the base background color to crop out.
    
    Since:
    
    In BBj 16.20 and higher
    
    See Also:
    
    cropTransparent()
  - scale
```
public void scale(BBjNumber p_width,
BBjNumber p_height)
```
    Method to scale the BBXImage given a width and height
    
    Parameters:
    
    p_width - The desired width of the BBXImage
    
    p_height - The desired height of the BBXImage
  - scaleWithHints
```
public void scaleWithHints(BBjNumber p_width,
BBjNumber p_height,
HashMap p_renderingHintsMap!)
```
    Method to scale the BBXImage given a width and height and HashMap of Graphics2D rendering hints
    Java's RenderingHints allow you to specify the interpolation method used when scaling the image. The possible values are:
    - VALUE_INTERPOLATION_NEAREST_NEIGHBOR
    - VALUE_INTERPOLATION_BILINEAR
    - VALUE_INTERPOLATION_BICUBIC
    Generally speaking, the interpolations values shown above range from quickest with poorest quality (VALUE_INTERPOLATION_NEAREST_NEIGHBOR) to slowest with best quality (VALUE_INTERPOLATION_BICUBIC). In practice, bilinear and bicubic interpolation produce results that are very similar. Bicubic will be slightly sharper than bilinear, with a bit more emphasis on edges. That translates to bicubic often being a better choice for image reduction, whereas blinear is usually better for image enlargement.
    Following is a short example showing how to use this method:
    use java.util.HashMap use java.awt.RenderingHints hintsMap! = new HashMap() hintsMap!.put(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC) xImage!.scaleWithHints(width, height, hintsMap!)
    Parameters:
    
    p_width - The desired width of the BBXImage
    
    p_height - The desired height of the BBXImage
    
    p_renderingHintsMap! - A HashMap of Graphics2d rendering hints
    
    Since:
    
    In BBj 15.0 and higher
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/awt/RenderingHints.html
  - scale
```
public void scale(BBjNumber p_percentage)
```
    Method to scale the BBXImage given a percentage
    
    Parameters:
    
    p_percentage - The percentage amount (0 - 100) to scale the BBXImage
  - scaleWidth
```
public void scaleWidth(BBjNumber p_height)
```
    Method to scale the BBXImage preserving the aspect ratio given the height
    
    Parameters:
    
    p_height - The desired height of the BBXImage
  - scaleHeight
```
public void scaleHeight(BBjNumber p_width)
```
    Method to scale the BBXImage preserving the aspect ratio given the width
    
    Parameters:
    
    p_width - The desired width of the BBXImage
  - scaleProportionally
```
public void scaleProportionally(BBjNumber p_maxDimension)
```
    Method to scale the BBXImage preserving the aspect ratio given the maximum width or height dimension.
    This method is useful in the case where you'd like to resize the source image ensuring that it will maintain its original proportions and will fit within a square of a particular size.
    
    Parameters:
    
    p_maxDimension - The desired maximum width and height of the resultant image
    
    Since:
    
    In BBj 15.01 and higher
  - scaleProportionally
```
public void scaleProportionally(BBjNumber p_maxWidth,
BBjNumber p_maxHeight)
```
    Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions.
    This method is useful in the case where you'd like to resize the source image ensuring that it will maintain its original proportions and will fit within a rectangle of a particular size.
    
    Parameters:
    
    p_maxWidth - The desired maximum width of the resultant image
    
    p_maxHeight - The desired maximum height of the resultant image
    
    Since:
    
    In BBj 15.01 and higher
  - scaleProportionallyAndResizeCanvas
```
public void scaleProportionallyAndResizeCanvas(BBjNumber p_maxWidth,
BBjNumber p_maxHeight)
```
    Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions, and then resize the canvas so that the image will be resized to the specified width and height. The original image will be centered in the final image and any extra space will be transparent.
    This method is useful in the case where you'd like to resize the source image ensuring that it will maintain its original proportions and will fit within a rectangle of a particular size.
    
    Parameters:
    
    p_maxWidth - The desired maximum width of the resultant image
    
    p_maxHeight - The desired maximum height of the resultant image
    
    Since:
    
    In BBj 15.11 and higher
  - scaleProportionallyResizeCanvasAndSetImage
```
public void scaleProportionallyResizeCanvasAndSetImage(BBjNumber p_maxWidth,
BBjNumber p_maxHeight,
BBjImageCtrl p_imgCtrl!)
```
    Method to scale the BBXImage preserving the aspect ratio given the maximum width and height dimensions, then resize the canvas so that the image will be resized to the specified width and height. The original image will be centered in the final image and any extra space will be transparent. The final image will then be used to set the contents of the specified BBjImageCtrl
    This method is useful in the case where you'd like to resize the an image ensuring that it will maintain its original proportions and will fit within a BBjImageCtrl of a particular size.
    
    Parameters:
    
    p_maxWidth - The desired maximum width of the resultant image, usually the BBjImageCtrl's width
    
    p_maxHeight - The desired maximum height of the resultant image, usually the BBjImageCtrl's height
    
    p_imgCtrl! - The BBjImageCtrl that will display the resultant image
    
    Since:
    
    In BBj 15.11 and higher
  - drawFilledRect
```
public void drawFilledRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
Color p_outlineColor!,
Color p_fillColor!)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_outlineColor! - The Java Color that will be used to draw the shape
    
    p_fillColor! - The Java Color that will be used to fill the shape
    
    Since:
    
    In BBj 15.10 and higher
  - drawFilledRect
```
public void drawFilledRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjColor p_outlineColor!,
BBjColor p_fillColor!,
BBjNumber p_rotation)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_outlineColor! - The BBjColor that will be used to draw the shape
    
    p_fillColor! - The BBjColor that will be used to fill the shape
    
    p_rotation - The angle in degrees to rotate the shape around its center
    
    Since:
    
    In BBj 18.10 and higher
  - drawFilledRect
```
public void drawFilledRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
Color p_outlineColor!,
Color p_fillColor!,
BBjNumber p_rotation)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_outlineColor! - The Java Color that will be used to draw the shape
    
    p_fillColor! - The Java Color that will be used to fill the shape
    
    p_rotation - The angle in degrees to rotate the shape around its center
    
    Since:
    
    In BBj 15.10 and higher
  - drawFilledOval
```
public void drawFilledOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
Color p_outlineColor!,
Color p_fillColor!)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_outlineColor! - The Java Color that will be used to draw the shape
    
    p_fillColor! - The Java Color that will be used to fill the shape
    
    Since:
    
    In BBj 15.10 and higher
  - drawFilledOval
```
public void drawFilledOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjColor p_outlineColor!,
BBjColor p_fillColor!,
BBjNumber p_rotation)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_outlineColor! - The BBjColor that will be used to draw the shape
    
    p_fillColor! - The BBjColor that will be used to fill the shape
    
    p_rotation - The angle in degrees to rotate the shape around its center
    
    Since:
    
    In BBj 18.10 and higher
  - drawFilledOval
```
public void drawFilledOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
Color p_outlineColor!,
Color p_fillColor!,
BBjNumber p_rotation)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_outlineColor! - The Java Color that will be used to draw the shape
    
    p_fillColor! - The Java Color that will be used to fill the shape
    
    p_rotation - The angle in degrees to rotate the shape around its center
    
    Since:
    
    In BBj 15.10 and higher
  - drawRect
```
public void drawRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjColor p_color!)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_color! - The BBjColor that will be used to draw the shape
    
    Since:
    
    In BBj 18.10 and higher
  - drawRect
```
public void drawRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
Color p_color!)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    p_color! - The Java Color that will be used to draw the shape
    
    Since:
    
    In BBj 15.10 and higher
  - drawRect
```
public void drawRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    red - The red component of the rectangle's color (0 - 1)
    
    green - The green component of the rectangle's color (0 - 1)
    
    blue - The blue component of the rectangle's color (0 - 1)
    
    opacity - The opacity component of the rectangle's color (0 - 1)
    
    Since:
    
    In BBj 15.10 and higher
  - drawRect
```
public void drawRect(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity,
BBjNumber p_rotation)
```
    Method to draw a rectangle on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    
    Parameters:
    
    p_x - The desired x coordinate of the rectangle
    
    p_y - The desired y coordinate of the rectangle
    
    p_width - The desired width of the rectangle
    
    p_height - The desired height of the rectangle
    
    p_thickness - The desired thickness of the rectangle
    
    red - The red component of the rectangle's color (0 - 1)
    
    green - The green component of the rectangle's color (0 - 1)
    
    blue - The blue component of the rectangle's color (0 - 1)
    
    opacity - The opacity component of the rectangle's color (0 - 1)
    
    p_rotation - The angle in degrees to rotate the shape around its center
    
    Since:
    
    In BBj 15.10 and higher
  - drawOval
```
public void drawOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
Color p_color!)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the oval
    
    p_y - The desired y coordinate of the oval
    
    p_width - The desired width of the oval
    
    p_height - The desired height of the oval
    
    p_thickness - The desired thickness of the oval
    
    p_color - The Java Color that will be used to draw the shape
    
    Since:
    
    In BBj 15.10 and higher
  - drawOval
```
public void drawOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjColor p_color!)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the oval
    
    p_y - The desired y coordinate of the oval
    
    p_width - The desired width of the oval
    
    p_height - The desired height of the oval
    
    p_thickness - The desired thickness of the oval
    
    p_color! - The oval's color expressed as a BBjColor
    
    Since:
    
    In BBj 18.10 and higher
  - drawOval
```
public void drawOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the oval
    
    p_y - The desired y coordinate of the oval
    
    p_width - The desired width of the oval
    
    p_height - The desired height of the oval
    
    p_thickness - The desired thickness of the oval
    
    red - The red component of the oval's color (0 - 1)
    
    green - The green component of the oval's color (0 - 1)
    
    blue - The blue component of the oval's color (0 - 1)
    
    opacity - The opacity component of the oval's color (0 - 1)
    
    Since:
    
    In BBj 15.02 and higher
  - drawOval
```
public void drawOval(BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjNumber p_thickness,
BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity,
BBjNumber p_rotation)
```
    Method to draw an oval on the BBXImage's canvas, specifying the thickness of the line and the color/opacity of the line.
    Note that specifying the same value for the width and height results in a circle.
    
    Parameters:
    
    p_x - The desired x coordinate of the oval
    
    p_y - The desired y coordinate of the oval
    
    p_width - The desired width of the oval
    
    p_height - The desired height of the oval
    
    p_thickness - The desired thickness of the oval
    
    red - The red component of the oval's color (0 - 1)
    
    green - The green component of the oval's color (0 - 1)
    
    blue - The blue component of the oval's color (0 - 1)
    
    opacity - The opacity component of the oval's color (0 - 1)
    
    p_rotation - The angle in degrees to rotate the shape around its center
    
    Since:
    
    In BBj 15.02 and higher
  - setCanvasSize
```
public void setCanvasSize(BBjNumber p_width,
BBjNumber p_height)
```
    Method to resize the BBXImage's canvas, specifying transparent for the fill color.
    
    Parameters:
    
    p_width - The desired width of the BBXImage's canvas
    
    p_height - The desired height of the BBXImage's canvas
    
    Since:
    
    In BBj 15.02 and higher
  - setCanvasSize
```
public void setCanvasSize(BBjNumber p_width,
BBjNumber p_height,
BBjColor p_color!)
```
    Method to resize the BBXImage's canvas. If the canvas size is larger than the BBXImage's size, then the extra space will be filled with the specified color and the original image will be centered in the new canvas. If the canvas is smaller than the BBXImage then it will be centered and cropped to fit, resulting in the removal of the edges.
    
    Parameters:
    
    p_width - The desired width of the BBXImage's canvas
    
    p_height - The desired height of the BBXImage's canvas
    
    p_color! - The background color expressed as a BBjColor
    
    Since:
    
    In BBj 18.10 and higher
  - setCanvasSize
```
public void setCanvasSize(BBjNumber p_width,
BBjNumber p_height,
BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity)
```
    Method to resize the BBXImage's canvas. If the canvas size is larger than the BBXImage's size, then the extra space will be filled with the specified color and the original image will be centered in the new canvas. If the canvas is smaller than the BBXImage then it will be centered and cropped to fit, resulting in the removal of the edges.
    
    Parameters:
    
    p_width - The desired width of the BBXImage's canvas
    
    p_height - The desired height of the BBXImage's canvas
    
    red - The red component of the added color (0 - 1)
    
    green - The green component of the added color (0 - 1)
    
    blue - The blue component of the added color (0 - 1)
    
    opacity - The opacity component of the added color (0 - 1)
    
    Since:
    
    In BBj 15.01 and higher
  - flipVertically
```
public void flipVertically()
```
    Method to flip the BBXImage vertically
    
    Since:
    
    In BBj 15.0 and higher
  - flipHorizontally
```
public void flipHorizontally()
```
    Method to flip the BBXImage horizontally
    
    Since:
    
    In BBj 15.0 and higher
  - rotate
```
public void rotate(BBjNumber p_degrees)
```
    Method to rotate the BBXImage
    The image will be rotated around the center point, and a positive rotation angle corresponds to rotating the image in a clockwise fashion. Note that the new image will be larger than the original image to avoid truncating rotated edges.
    
    Parameters:
    
    p_degrees - The number of degrees (-360 to +360) to rotate the BBXImage
  - addColorOverlay
```
public void addColorOverlay(BBjColor p_color!)
```
    Method to overlay the BBXImage with a BBjColor (which usually has an alpha component)
    
    Parameters:
    
    BBjColor - The BBjColor to place over the BBXImage
    
    Since:
    
    In BBj 18.10 and higher
  - addColorOverlay
```
public void addColorOverlay(BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity)
```
    Method to overlay the BBXImage with a color (which usually has an alpha component)
    
    Parameters:
    
    red - The red component of the color (0 - 1) to place over the BBXImage
    
    green - The green component of the color (0 - 1) to place over the BBXImage
    
    blue - The blue component of the color (0 - 1) to place over the BBXImage
    
    opacity - The opacity component of the color (0 - 1) to place over the BBXImage
    
    Since:
    
    In BBj 18.10 and higher
  - setOpacity
```
public void setOpacity(BBjNumber p_percentTransparent)
```
    Method to set the transparency of the BBXImage
    
    Parameters:
    
    p_percentTransparent - The percentage (0 - 100) to set the amount of transparency of the BBXImage
  - roundCorners
```
public void roundCorners(BBjNumber arcWidth,
BBjNumber arcHeight)
```
    Method to round the corners (knockout) of the BBXImage given a cornerRadius
    
    Parameters:
    
    arcWidth - The corner radius in the X direction
    
    arcHeight - The corner radius in the Y direction
  - roundTopCorners
```
public void roundTopCorners(BBjNumber arcWidth,
BBjNumber arcHeight)
```
    Method to round the top corners (knockout) of the BBXImage given a cornerRadius
    
    Parameters:
    
    arcWidth - The corner radius in the X direction
    
    arcHeight - The corner radius in the Y direction
  - roundBottomCorners
```
public void roundBottomCorners(BBjNumber arcWidth,
BBjNumber arcHeight)
```
    Method to round the bottom corners (knockout) of the BBXImage given a cornerRadius
    
    Parameters:
    
    arcWidth - The corner radius in the X direction
    
    arcHeight - The corner radius in the Y direction
  - setBorder
```
public void setBorder(BBjNumber borderSize,
BBjColor color!)
```
    Method to add a border to the BBXImage
    
    Parameters:
    
    borderSize - The width of the border
    
    color - The color of the border expressed as a BBjColor
    
    Since:
    
    In BBj 18.10 and higher
  - setBorder
```
public void setBorder(BBjNumber borderSize,
BBjNumber red,
BBjNumber green,
BBjNumber blue,
BBjNumber opacity)
```
    Method to add a border to the BBXImage
    
    Parameters:
    
    borderSize - The width of the border
    
    red - The red component of the border color (0 - 1)
    
    green - The green component of the border color (0 - 1)
    
    blue - The blue component of the border color (0 - 1)
    
    opacity - The opacity component of the border color (0 - 1)
  - setDropShadow
```
public void setDropShadow(BBjNumber shadowSize,
BBjNumber shadowOpacity,
BBjNumber xOffset,
BBjNumber yOffset)
```
    Method to add a drop shadow to the BBXImage
    
    Parameters:
    
    shadowSize - The size in pixels of the shadow
    
    shadowOpacity - The opacity of the shadow (0 - 1)
    
    xOffset - The shadow's offset in the X direction
    
    yOffset - The shadow's offset in the Y direction
  - setReflection
```
public void setReflection(BBjNumber reflectionLength,
BBjNumber reflectionOpacity,
BBjNumber blurred,
BBjNumber verticalSpace)
```
    Method to add a reflection to the BBXImage
    
    Parameters:
    
    reflectionLength - The height in pixels of the reflection
    
    reflectionOpacity - The opacity of the reflection (0 - 1)
    
    blurred - 1 = blur the reflection, 0 = do not blur the reflection
    
    verticalSpace - Spacing in pixels between the original image and the reflection
  - setCornerWaterMark
```
public void setCornerWaterMark(BBXImage watermarkImage!,
BBjNumber opacity,
BBjNumber width,
BBjNumber height,
BBjNumber anchorPoint)
```
    Method to add a watermark logo to the BBXImage
    
    Parameters:
    
    watermarkImage! - A BBXImage that contains the watermark image
    
    opacity - The desired opacity of the watermark (0 - 1)
    
    width - The width of the watermark when placed on the target
    
    height - The height of the watermark when placed on the target
    
    anchorPoint - The corner of the target image on which to place the watermark. 0 = TopLeft, 1 = TopRight, 2 = BottomRight, 3 = BottomLeft
  - saveAsGIF
```
public void saveAsGIF(BBjString p_imageFile$)
```
    Method to save the BBXImage out to a .gif file
    
    Parameters:
    
    p_imageFile$ - The path and filename for the resultant .gif image
    
    Since:
    
    BBj 18.20
  - saveAsBMP
```
public void saveAsBMP(BBjString p_imageFile$)
```
    Method to save the BBXImage out to a .bmp file
    
    Parameters:
    
    p_imageFile$ - The path and filename for the resultant .bmp image
    
    Since:
    
    BBj 19.02
  - saveAsTIFF
```
public void saveAsTIFF(BBjString p_imageFile$)
```
    Method to save the BBXImage out to a .tiff file
    
    Parameters:
    
    p_imageFile$ - The path and filename for the resultant .tiff image
    
    Since:
    
    BBj 19.02
  - saveAsPNG
```
public void saveAsPNG(BBjString p_imageFile$)
```
    Method to save the BBXImage out to a 32-bit .png file with transparency
    
    Parameters:
    
    p_imageFile$ - The path and filename for the resultant .png image
  - saveAsJPG
```
public void saveAsJPG(BBjString p_imageFile$,
BBjNumber p_compressionLevelPercentage)
```
    Method to save the BBXImage out to a .jpg file
    
    Parameters:
    
    p_imageFile$ - The path and filename for the resultant .jpg image
    
    p_compressionLevelPercentage - The amount (0 - 100) to compress the resultant .jpg image
  - getColorWithAlphaFromHexString
```
public static Color getColorWithAlphaFromHexString(BBjString p_colorHexString$,
BBjNumber p_opacity)
```
    Method to create a Java Color with an alpha channel from a hex string
    
    Parameters:
    
    p_colorHexString$ - A hex color string. An example would be "#ff00cc"
    
    p_opacity - The desired opacity value (0-1). 0 = Fully Transparent, 1 = Fully Opaque.
    
    Returns:
    
    A Java Color built from the specific hex color string with the desired opacity value
    
    See Also:
    
    http://docs.oracle.com/javase/8/docs/api/java/awt/Color.html
  - getHexStringFromColor
```
public static BBjString getHexStringFromColor(Color p_color!)
```
    Method to get a hex representation of a Java Color with an alpha channel
    
    Parameters:
    
    p_color! - A Java Color
    
    Returns:
    
    A hex color string. An example would be "#ff00cc"
    
    See Also:
    
    Color documentation for more information.

Class BBXImage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Width

Height

Constructor Detail

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

Method Detail

clone

getBufferedImage

getBufferedImage

getImage

getImageIcon

setImageIcon

getBBjImage

getBase64

getWidth

getHeight

getDescription

getSubimage

crop

setDescription

setFilterBrightness

setFilterContrast

setFilterGrayscale

setFilterBlur

setFilterSharpen

exists

cropTransparent

cropBackground

scale

scaleWithHints

scale

scaleWidth

scaleHeight

scaleProportionally

scaleProportionally

scaleProportionallyAndResizeCanvas

scaleProportionallyResizeCanvasAndSetImage

drawFilledRect

drawFilledRect

drawFilledRect

drawFilledOval

drawFilledOval

drawFilledOval

drawRect

drawRect

drawRect

drawRect

drawOval

drawOval

drawOval

drawOval

setCanvasSize

setCanvasSize

setCanvasSize

flipVertically

flipHorizontally

rotate

addColorOverlay

addColorOverlay

setOpacity

roundCorners

roundTopCorners

roundBottomCorners

setBorder

setBorder

setDropShadow

setReflection

setCornerWaterMark