BBXImage

```
public class BBXImage
```
Description
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 in a variety of image formats such 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
In BBj 21.12 and higher, the BBXImage Utility has been updated with the following features:
- The manipulation methods have been updated to return the BBXImage. This makes it possible to chain multiple method calls, as in:
  xImage!.scale(100, 100).rotate(90).saveAsPNG("myScaledAndRotatedeImage.png")
- The new drawText() method allows you to draw single or multiline text on the BBXImage providing values for foreground/background color, font, alignment, and offsets.
How to use the BBXImage Utility
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.
See Also:
[]
Since:
BBj 9.00

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(BBXImage p_bbximage!)` BBXImage Constructor specifying another BBXImage for the source image
`BBXImage(javax.swing.ImageIcon p_imageIcon!)` BBXImage Constructor specifying an ImageIcon for the source image
`BBXImage(Image p_image!)` BBXImage Constructor specifying a Java Image object for the source image
`BBXImage(URL p_imageURL!)` BBXImage Constructor specifying a Java URL object for the source image
`BBXImage(File p_imageFile!)` BBXImage Constructor specifying a Java File object for the source image's file path
`BBXImage(BBjString p_imageFile!)` BBXImage Constructor specifying a string for the source image's file path
`BBXImage(BBjImage p_image!)` BBXImage Constructor specifying a BBjImage for the source image
`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.

Method Summary

Methods
Modifier and Type	Method and Description
`Image`	`addColorOverlay(BBjColor p_color!)` Method to overlay the BBXImage with a BBjColor (which usually has an alpha component)
`Image`	`addColorOverlay(BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to overlay the BBXImage with a color (which usually has an alpha component)
`static BBjNumber`	`ALIGN_BOTTOM()` A constant value that's used to denote bottom vertical alignment
`static BBjNumber`	`ALIGN_CENTER()` A constant value that's used to denote center horizontal alignment
`static BBjNumber`	`ALIGN_LEFT()` A constant value that's used to denote left horizontal alignment
`static BBjNumber`	`ALIGN_MIDDLE()` A constant value that's used to denote middle vertical alignment
`static BBjNumber`	`ALIGN_RIGHT()` A constant value that's used to denote right horizontal alignment
`static BBjNumber`	`ALIGN_TOP()` A constant value that's used to denote top vertical alignment
`Image`	`clone()` Method to get a copy of the BBXImage
`Image`	`crop(BBjNumber p_x, BBjNumber p_y, BBjNumber p_w, BBjNumber p_h)` Method to crop the BBXImage to a specified rectangular region
`Image`	`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.
`Image`	`cropTransparent()` Method to return the smallest image possible by cropping out the transparent edges of the original image
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`drawText(BBjString p_text$, BBjString p_foreColorHexString$, BBjString p_backColorHexString$, Font p_javaFont!, BBjNumber p_offsetX, BBjNumber p_offsetY, BBjNumber p_hAlign, BBjNumber p_vAlign)` Draws the specified text on the current BBXImage object. Multi-line strings are denoted by including a linebreak ($0A$) between the lines of text.
`BBjNumber`	`exists()` Method to determine whether the BBXImage exists or not
`Image`	`flipHorizontally()` Method to flip the BBXImage horizontally
`Image`	`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
`Image`	`getBufferedImage()` Method to get a BufferedImage of type BufferedImage.TYPE_INT_ARGB from the BBXImage
`Image`	`getBufferedImage(BBjNumber p_bufferedImageType!)` Method to get a BufferedImage from the BBXImage
`static Color`	`getColorFromHexString(BBjString p_colorHexString$)` Method to create a Java Color from a hex string. As of BBj 21.12, this method supports hex color string with an alpha channel.
`static Color`	`getColorWithAlphaFromHexString(BBjString p_colorHexString$, BBjNumber p_opacity)` Method to create a Java Color with an alpha channel from a hex string
`static BBjNumber`	`getDecimalFromHex(BBjString p_hexValue$)` Method to convert 2-digit hexadecimal number to a decimal number in the range from 0-255
`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
`Image`	`getImageIcon()` Method to get an ImageIcon from the BBXImage
`Image`	`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
`Image`	`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.
`Image`	`roundBottomCorners(BBjNumber arcWidth, BBjNumber arcHeight)` Method to round the bottom corners (knockout) of the BBXImage given a cornerRadius
`Image`	`roundCorners(BBjNumber arcWidth, BBjNumber arcHeight)` Method to round the corners (knockout) of the BBXImage given a cornerRadius
`Image`	`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
`Image`	`scale(BBjNumber p_width, BBjNumber p_height)` Method to scale the BBXImage given a width and height Note: This method of scaling uses the java.awt.Image::getScaledInstance() method with the Image.SCALE_AREA_AVERAGING rendering hint.
`Image`	`scale(BBjNumber p_percentage)` Method to scale the BBXImage given a percentage
`Image`	`scaleHeight(BBjNumber p_width)` Method to scale the BBXImage preserving the aspect ratio given the width
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`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.
`Image`	`scaleWidth(BBjNumber p_height)` Method to scale the BBXImage preserving the aspect ratio given the height
`Image`	`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!)`
`Image`	`setBorder(BBjNumber borderSize, BBjColor color!)` Method to add a border to the BBXImage
`Image`	`setBorder(BBjNumber borderSize, BBjNumber red, BBjNumber green, BBjNumber blue, BBjNumber opacity)` Method to add a border to the BBXImage
`Image`	`setCanvasSize(BBjNumber p_width, BBjNumber p_height)` Method to resize the BBXImage's canvas, specifying transparent for the fill color.
`Image`	`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.
`Image`	`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.
`Image`	`setCornerWaterMark(BBXImage watermarkImage!, BBjNumber opacity, BBjNumber width, BBjNumber height, BBjNumber anchorPoint)` Method to add a watermark logo to the BBXImage
`Image`	`setDescription(BBjString p_description$)` Method to set the description of the BBXImage
`Image`	`setDropShadow(BBjNumber shadowSize, BBjNumber shadowOpacity, BBjNumber xOffset, BBjNumber yOffset)` Method to add a drop shadow to the BBXImage
`Image`	`setFilterBlur(BBjNumber p_blurAmount)` Method to filter the BBXImage and increase the blurriness
`Image`	`setFilterBrightness(BBjNumber p_fraction)` Method to adjust the brightness of the BBXImage
`Image`	`setFilterContrast(BBjNumber p_fraction)` Method to adjust the contrast of the BBXImage
`Image`	`setFilterGrayscale()` Method to filter the BBXImage and convert it to grayscale (completely desaturated)
`Image`	`setFilterSharpen(BBjNumber p_sharpenAmount)` Method to filter the BBXImage and increase the sharpness
`Image`	`setImageIcon(javax.swing.ImageIcon p_imageIcon!)` Method to set the ImageIcon for the BBXImage
`Image`	`setOpacity(BBjNumber p_percentTransparent)` Method to set the transparency of the BBXImage
`Image`	`setReflection(BBjNumber reflectionLength, BBjNumber reflectionOpacity, BBjNumber blurred, BBjNumber verticalSpace)` Method to add a reflection to the BBXImage

Field Detail

Height
```
public BBjNumber Height
```

Width
```
public BBjNumber Width
```

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(javax.swing.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 or constants like BBXImage.ALIGN_LEFT(), BBXImage.ALIGN_CENTER(), BBXImage.ALIGN_RIGHT()
  p_vAlign The vertical text alignment: 0=Top, 1=Middle, 2=Bottom or constants like BBXImage.ALIGN_TOP(), BBXImage.ALIGN_MIDDLE(), BBXImage.ALIGN_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
  - addColorOverlay
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - addColorOverlay
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - ALIGN_BOTTOM
```
public static BBjNumber ALIGN_BOTTOM()
```
    A constant value that's used to denote bottom vertical alignment
    
    Since:
    BBj 21.12
  - ALIGN_CENTER
```
public static BBjNumber ALIGN_CENTER()
```
    A constant value that's used to denote center horizontal alignment
    
    Since:
    BBj 21.12
  - ALIGN_LEFT
```
public static BBjNumber ALIGN_LEFT()
```
    A constant value that's used to denote left horizontal alignment
    
    Since:
    BBj 21.12
  - ALIGN_MIDDLE
```
public static BBjNumber ALIGN_MIDDLE()
```
    A constant value that's used to denote middle vertical alignment
    
    Since:
    BBj 21.12
  - ALIGN_RIGHT
```
public static BBjNumber ALIGN_RIGHT()
```
    A constant value that's used to denote right horizontal alignment
    
    Since:
    BBj 21.12
  - ALIGN_TOP
```
public static BBjNumber ALIGN_TOP()
```
    A constant value that's used to denote top vertical alignment
    
    Since:
    BBj 21.12
  - clone
```
public Image clone()
```
    Method to get a copy of the BBXImage
    
    Returns:
    A cloned version of the BBXImage
    Since:
    In BBj 15.0 and higher
  - crop
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - cropBackground
```
public Image 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.
    
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    See Also:
    cropTransparent()
    Since:
    In BBj 16.20 and higher
  - cropTransparent
```
public Image cropTransparent()
```
    Method to return the smallest image possible by cropping out the transparent edges of the original image
    
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    See Also:
    cropBackground()
    Since:
    In BBj 15.0 and higher
  - drawFilledOval
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawFilledOval
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - drawFilledOval
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawFilledRect
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawFilledRect
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - drawFilledRect
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawOval
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawOval
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - drawOval
```
public Image 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)
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.02 and higher
  - drawOval
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.02 and higher
  - drawRect
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - drawRect
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawRect
```
public Image 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)
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawRect
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.10 and higher
  - drawText
```
public Image drawText(BBjString p_text$, BBjString p_foreColorHexString$, BBjString p_backColorHexString$, Font p_javaFont!, BBjNumber p_offsetX, BBjNumber p_offsetY, BBjNumber p_hAlign, BBjNumber p_vAlign)
```
    Draws the specified text on the current BBXImage object. Multi-line strings are denoted by including a linebreak ($0A$) between the lines of text.
    
    Parameters:
    p_text$ The text string to draw. You can include linebreak ($0A$) characters in the text string to separate it into multiple lines.
    p_foreColorHexString$ The foreground color of the resultant text specified as a hex color string that may include an alpha channel. Examples include '#ff00cc', '#f0c', '#ff00ccbb', '#f0cb' depending on whether the hex color has an alpha channel.
    p_backColorHexString$ The background color of the resultant text specified as a hex color string that may include an alpha channel. Examples include '#ff00cc', '#f0c', '#ff00ccbb', '#f0cb' depending on whether the hex color has an alpha channel. By providing a value like '#0000' you can specify that the text background should be transparent.
    p_javaFont! The Java Font used to draw the text
    p_offsetX The number of pixels to horizontally shift the text, can be negative or positive to offset the text left or right, respectively
    p_offsetY The number of pixels to vertically shift the text, can be negative or positive to offset the text up or down, respectively
    p_hAlign The horizontal text alignment relative to the current BBXImage: 0=Left, 1=Center, 2=Right or constants like BBXImage.ALIGN_LEFT(), BBXImage.ALIGN_CENTER(), BBXImage.ALIGN_RIGHT()
    p_vAlign The vertical text alignment relative to the current BBXImage: 0=Top, 1=Middle, 2=Bottom or constants like BBXImage.ALIGN_TOP(), BBXImage.ALIGN_MIDDLE(), BBXImage.ALIGN_BOTTOM()
    Since:
    In BBj 21.12 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
  - flipHorizontally
```
public Image flipHorizontally()
```
    Method to flip the BBXImage horizontally
    
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - flipVertically
```
public Image flipVertically()
```
    Method to flip the BBXImage vertically
    
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - 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
  - getBBjImage
```
public BBjImage getBBjImage()
```
    Method to get a BBjImage for the BBXImage
    
    Returns:
    A BBjImage version of the the BBXImage
    See Also:
    BBjImage for more information on the BBjImage control.
  - getBufferedImage
```
public Image getBufferedImage()
```
    Method to get a BufferedImage of type BufferedImage.TYPE_INT_ARGB from the BBXImage
    
    Returns:
    A BufferedImage representation of the BBXImage
    See Also:
    http://docs.oracle.com/javase/8/docs/api/java/awt/image/BufferedImage.html
    Since:
    In BBj 15.0 and higher
  - getBufferedImage
```
public Image 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
  - getColorFromHexString
```
public static Color getColorFromHexString(BBjString p_colorHexString$)
```
    Method to create a Java Color from a hex string. As of BBj 21.12, this method supports hex color string with an alpha channel.
    
    Parameters:
    p_colorDesc$ A hex color string. Examples would be '#ff00cc', '#f0c', '#ff00ccbb', '#f0cb' depending on whether the hex color has an alpha channel.
    Returns:
    A Java Color version of the hex color string
    See Also:
    Color documentation for more information.
  - 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
  - getDecimalFromHex
```
public static BBjNumber getDecimalFromHex(BBjString p_hexValue$)
```
    Method to convert 2-digit hexadecimal number to a decimal number in the range from 0-255
    
    Parameters:
    p_hexValue$ A BBjString filled with a two-digit hexadecimal number, like 'f0'
    Returns:
    A BBjNumber in the range from 0-255 that's the decimal equivalent of the provided hexadecimal number
  - 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.
  - getHeight
```
public BBjNumber getHeight()
```
    Method to get the height of the BBXImage
    
    Returns:
    The height in pixels of the BBXImage
  - 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.
  - 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 Image 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
  - getSubimage
```
public Image 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
  - getWidth
```
public BBjNumber getWidth()
```
    Method to get the width of the BBXImage
    
    Returns:
    The width in pixels of the BBXImage
  - rotate
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - roundBottomCorners
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - roundCorners
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - roundTopCorners
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - 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
  - 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
  - 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
  - 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
  - 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
  - scale
```
public Image scale(BBjNumber p_width, BBjNumber p_height)
```
    Method to scale the BBXImage given a width and height Note: This method of scaling uses the java.awt.Image::getScaledInstance() method with the Image.SCALE_AREA_AVERAGING rendering hint.
    
    Parameters:
    p_width The desired width of the BBXImage
    p_height The desired height of the BBXImage
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    See Also:
    https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/Image.html
  - scale
```
public Image scale(BBjNumber p_percentage)
```
    Method to scale the BBXImage given a percentage
    
    Parameters:
    p_percentage The percentage amount (0 - 100) to scale the BBXImage
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - scaleHeight
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - scaleProportionally
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.01 and higher
  - scaleProportionally
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.01 and higher
  - scaleProportionallyAndResizeCanvas
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.11 and higher
  - scaleProportionallyResizeCanvasAndSetImage
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.11 and higher
  - scaleWidth
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - scaleWithHints
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    See Also:
    http://docs.oracle.com/javase/8/docs/api/java/awt/RenderingHints.html
    Since:
    In BBj 15.0 and higher
  - setBorder
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - setBorder
```
public Image 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)
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - setCanvasSize
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.02 and higher
  - setCanvasSize
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 18.10 and higher
  - setCanvasSize
```
public Image 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)
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.01 and higher
  - setCornerWaterMark
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - setDescription
```
public Image 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.
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - setDropShadow
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - setFilterBlur
```
public Image 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.
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - setFilterBrightness
```
public Image 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.
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - setFilterContrast
```
public Image 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.
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - setFilterGrayscale
```
public Image setFilterGrayscale()
```
    Method to filter the BBXImage and convert it to grayscale (completely desaturated)
    
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - setFilterSharpen
```
public Image 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.
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    Since:
    In BBj 15.0 and higher
  - setImageIcon
```
public Image setImageIcon(javax.swing.ImageIcon p_imageIcon!)
```
    Method to set the ImageIcon for the BBXImage
    
    Parameters:
    An ImageIcon containing the desired contents of the BBXImage
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
    See Also:
    ImageIcon for more information on the ImageIcon control.
  - setOpacity
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")
  - setReflection
```
public Image 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
    Returns:
    BBXImage As of BBj 21.12, this method returns the BBXImage, allowing you to chain method calls, as in myXImage!.scale(100, 100).saveAsPNG("myScaledImage.png")

Class BBXImage

Description

How to use the BBXImage Utility

THROWn Error Codes:

Field Summary

Constructor Summary

Method Summary

Field Detail

Height

Width

Constructor Detail

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

BBXImage

Method Detail

addColorOverlay

addColorOverlay

ALIGN_BOTTOM

ALIGN_CENTER

ALIGN_LEFT

ALIGN_MIDDLE

ALIGN_RIGHT

ALIGN_TOP

clone

crop

cropBackground

cropTransparent

drawFilledOval

drawFilledOval

drawFilledOval

drawFilledRect

drawFilledRect

drawFilledRect

drawOval

drawOval

drawOval

drawOval

drawRect

drawRect

drawRect

drawRect

drawText

exists

flipHorizontally

flipVertically

getBase64

getBBjImage

getBufferedImage

getBufferedImage

getColorFromHexString

getColorWithAlphaFromHexString

getDecimalFromHex

getDescription

getHeight

getHexStringFromColor

getImage

getImageIcon

getSubimage

getWidth

rotate

roundBottomCorners

roundCorners

roundTopCorners

saveAsBMP

saveAsGIF

saveAsJPG

saveAsPNG

saveAsTIFF

scale

scale

scaleHeight

scaleProportionally

scaleProportionally

scaleProportionallyAndResizeCanvas

scaleProportionallyResizeCanvasAndSetImage