RMImageFill (ReportMill 12 API)

java.lang.Object
- com.reportmill.base.RMObject
- - com.reportmill.shape.fill.RMFill
  - - com.reportmill.shape.fill.RMImageFill

All Implemented Interfaces:

com.reportmill.base.RMPropertyChanger, java.lang.Cloneable
```
public class RMImageFill
extends RMFill
```
This class is used to fill a shape's path with an image.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_FILL_STYLE`
`static java.lang.String`	`ATTRIBUTE_ROLL`
`static java.lang.String`	`ATTRIBUTE_SCALE_X`
`static java.lang.String`	`ATTRIBUTE_SCALE_Y`
`static java.lang.String`	`ATTRIBUTE_X`
`static java.lang.String`	`ATTRIBUTE_Y`
`static byte`	`STYLE_FIT`
`static byte`	`STYLE_FIT_IFNEEDED`
`static byte`	`STYLE_STRETCH`
`static byte`	`STYLE_TILE`

Constructor Summary

Constructors
Constructor and Description
`RMImageFill()` Creates a plain image fill.
`RMImageFill(java.lang.Object aSource)` Creates an image fill for the given source.
`RMImageFill(java.lang.Object aSource, byte aFillStyle, float aMargin)` Creates an image fill from an image source.

Method Summary

Methods
Modifier and Type	Method and Description
`RMFill`	`deriveFill(RMColor aColor)` Creates a new fill from this image fill, but with a new color.
`RMImageFill`	`deriveFill(com.reportmill.graphics.RMImageData anImageData)` Creates a new image fill from this fill, but with a new image.
`RMImageFill`	`deriveFill(java.lang.String aName, java.lang.Number aValue)` Creates a new image fill identical to this image fill, but with new value for given attribute.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementation.
`java.lang.Object`	`fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner)` XML unarchival.
`byte`	`getFillStyle()` Returns the fill style (Stretch, Tile, Fit or FitIfNeeded).
`java.awt.Image`	`getImage()` Returns the image rendered by this image fill.
`RMRect`	`getImageBounds(RMRect aRect)` Returns the image bounds for a given rect.
`RMRect`	`getImageBounds(RMShape aShape)` Returns the image bounds for a given shape.
`com.reportmill.graphics.RMImageData`	`getImageData()` Returns the image data associated with this image fill.
`float`	`getImageMargins()` Returns the inset for the image when drawn in a given bounds.
`RMSize`	`getImageSize2D()` Returns the image size of the image for this image fill.
`int`	`getPageNumber()` Returns the page number of the image fill's image that is displayed (for rare multi-page images like PDF).
`float`	`getRoll()` Returns the rotation of the image fill image.
`float`	`getScaleX()` Returns the scale x of the image fill image.
`float`	`getScaleY()` Returns the scale y of the image fill image.
`java.lang.String`	`getType()` Returns the type of the image for this image fill (gif, jpg, png, etc.).
`float`	`getX()` Returns the X location (offset) of the image fill image.
`float`	`getY()` Returns the Y location (offset) of the image fill image.
`void`	`paint(com.reportmill.shape.RMShapePainter sp, java.awt.Graphics2D g, RMShape aShape)` Render this fill in a Java2D Graphics2D.
`void`	`setFillStyle(byte aValue)` Returns the fill style (Stretch, Tile, Fit or FitIfNeeded).
`void`	`setImageMargins(float aValue)` Sets the inset for the image when drawn in a given bounds.
`void`	`setPageNumber(int aNum)` Sets the page number of the image fill's image that is displayed (for rare multi-page images like PDF).
`com.reportmill.archiver.RXElement`	`toXML(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner)` XML archival.

Methods inherited from class com.reportmill.shape.fill.RMFill
clone, deriveFill, getBounds, getColor, getName, hasAlpha, setColor

Methods inherited from class com.reportmill.base.RMObject
addListener, addPropertyChangeListener, animUpdate, firePropertyChange, firePropertyChange, getListener, getListenerCount, getListeners, isFirePropertyChangeEnabled, isUndoing, removeListener, removePropertyChangeListener, setFirePropertyChangeEnabled, setUndoing, toString

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

- Field Detail
  - STYLE_STRETCH
```
public static final byte STYLE_STRETCH
```
    See Also:
    Constant Field Values
  - STYLE_TILE
```
public static final byte STYLE_TILE
```
    See Also:
    Constant Field Values
  - STYLE_FIT
```
public static final byte STYLE_FIT
```
    See Also:
    Constant Field Values
  - STYLE_FIT_IFNEEDED
```
public static final byte STYLE_FIT_IFNEEDED
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_FILL_STYLE
```
public static final java.lang.String ATTRIBUTE_FILL_STYLE
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_X
```
public static final java.lang.String ATTRIBUTE_X
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_Y
```
public static final java.lang.String ATTRIBUTE_Y
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_ROLL
```
public static final java.lang.String ATTRIBUTE_ROLL
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_SCALE_X
```
public static final java.lang.String ATTRIBUTE_SCALE_X
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_SCALE_Y
```
public static final java.lang.String ATTRIBUTE_SCALE_Y
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RMImageFill
```
public RMImageFill()
```
    Creates a plain image fill.
  - RMImageFill
```
public RMImageFill(java.lang.Object aSource)
```
    Creates an image fill for the given source.
  - RMImageFill
```
public RMImageFill(java.lang.Object aSource,
           byte aFillStyle,
           float aMargin)
```
    Creates an image fill from an image source.
- Method Detail
  - getImage
```
public java.awt.Image getImage()
```
    Returns the image rendered by this image fill.
  - getImageData
```
public com.reportmill.graphics.RMImageData getImageData()
```
    Returns the image data associated with this image fill.
  - getFillStyle
```
public byte getFillStyle()
```
    Returns the fill style (Stretch, Tile, Fit or FitIfNeeded).
  - setFillStyle
```
public void setFillStyle(byte aValue)
```
    Returns the fill style (Stretch, Tile, Fit or FitIfNeeded).
  - getX
```
public float getX()
```
    Returns the X location (offset) of the image fill image.
  - getY
```
public float getY()
```
    Returns the Y location (offset) of the image fill image.
  - getRoll
```
public float getRoll()
```
    Returns the rotation of the image fill image.
  - getScaleX
```
public float getScaleX()
```
    Returns the scale x of the image fill image.
  - getScaleY
```
public float getScaleY()
```
    Returns the scale y of the image fill image.
  - getImageMargins
```
public float getImageMargins()
```
    Returns the inset for the image when drawn in a given bounds.
  - setImageMargins
```
public void setImageMargins(float aValue)
```
    Sets the inset for the image when drawn in a given bounds.
  - deriveFill
```
public RMFill deriveFill(RMColor aColor)
```
    Creates a new fill from this image fill, but with a new color.
  - deriveFill
```
public RMImageFill deriveFill(com.reportmill.graphics.RMImageData anImageData)
```
    Creates a new image fill from this fill, but with a new image.
  - deriveFill
```
public RMImageFill deriveFill(java.lang.String aName,
                     java.lang.Number aValue)
```
    Creates a new image fill identical to this image fill, but with new value for given attribute.
  - getType
```
public java.lang.String getType()
```
    Returns the type of the image for this image fill (gif, jpg, png, etc.).
  - getImageSize2D
```
public RMSize getImageSize2D()
```
    Returns the image size of the image for this image fill.
  - getImageBounds
```
public RMRect getImageBounds(RMRect aRect)
```
    Returns the image bounds for a given rect.
  - getImageBounds
```
public RMRect getImageBounds(RMShape aShape)
```
    Returns the image bounds for a given shape.
  - getPageNumber
```
public int getPageNumber()
```
    Returns the page number of the image fill's image that is displayed (for rare multi-page images like PDF).
  - setPageNumber
```
public void setPageNumber(int aNum)
```
    Sets the page number of the image fill's image that is displayed (for rare multi-page images like PDF).
  - paint
```
public void paint(com.reportmill.shape.RMShapePainter sp,
         java.awt.Graphics2D g,
         RMShape aShape)
```
    Render this fill in a Java2D Graphics2D.
    
    Overrides:
    
    paint in class RMFill
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementation.
    
    Overrides:
    
    equals in class RMFill
  - toXML
```
public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver,
                                      java.lang.Object anOwner)
```
    XML archival.
    
    Overrides:
    
    toXML in class RMFill
  - fromXML
```
public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                       com.reportmill.archiver.RXElement anElement,
                       java.lang.Object anOwner)
```
    XML unarchival.
    
    Overrides:
    
    fromXML in class RMFill

Class RMImageFill

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.fill.RMFill

Methods inherited from class com.reportmill.base.RMObject

Methods inherited from class java.lang.Object

Field Detail

STYLE_STRETCH

STYLE_TILE

STYLE_FIT

STYLE_FIT_IFNEEDED

ATTRIBUTE_FILL_STYLE

ATTRIBUTE_X

ATTRIBUTE_Y

ATTRIBUTE_ROLL

ATTRIBUTE_SCALE_X

ATTRIBUTE_SCALE_Y

Constructor Detail

RMImageFill

RMImageFill

RMImageFill

Method Detail

getImage

getImageData

getFillStyle

setFillStyle

getX

getY

getRoll

getScaleX

getScaleY

getImageMargins

setImageMargins

deriveFill

deriveFill

deriveFill

getType

getImageSize2D

getImageBounds

getImageBounds

getPageNumber

setPageNumber

paint

equals

toXML

fromXML