RMImageShape (ReportMill 14 API)

java.lang.Object
- SnapObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMRectShape
    - - com.reportmill.shape.RMImageShape

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, java.util.EventListener
```
public class RMImageShape
extends RMRectShape
```
This class is a shape representation of an image.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes
  RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Constructor Summary

Constructors
Constructor and Description

RMImageShape()
Creates an RMImageShape.

RMImageShape(java.lang.Object aSource)
Creates an RMImageShape from the image source provided.

Constructors
Constructor and Description
`RMImageShape()` Creates an RMImageShape.
`RMImageShape(java.lang.Object aSource)` Creates an RMImageShape from the image source provided.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`fromXML(XMLArchiver anArchiver, XMLElement anElement)` XML unarchival.
`RMTypes.AlignX`	`getAlignmentX()` Returns the horizontal alignment.
`RMTypes.AlignY`	`getAlignmentY()` Returns the vertical alignment.
`java.awt.geom.Rectangle2D`	`getImageBounds()` Returns the image bounds.
`RMImageData`	`getImageData()` Returns the image data.
`java.lang.String`	`getKey()` Returns the report key used to load an image if none is provided.
`int`	`getPadding()` Returns the padding.
`int`	`getPageIndex()` Returns the page index.
`boolean`	`getPreserveRatio()` Returns whether to preserve the natural width to height ratio of image.
`boolean`	`isGrowToFit()` Returns whether to grow image to fit available area if shape larger than image.
`void`	`paintShape(RMShapePainter aPntr)` Override to paint shape.
`RMShape`	`rpgShape(ReportOwner aRptOwner, RMShape aParent)` Report generation method.
`void`	`setAlignmentX(RMTypes.AlignX anAlignX)` Sets the horizontal alignment.
`void`	`setAlignmentY(RMTypes.AlignY anAlignY)` Sets the vertical alignment.
`void`	`setGrowToFit(boolean aValue)` Sets whether to grow image to fit available area if shape larger than image.
`void`	`setImageData(java.lang.Object aSource)` Sets the image data from given source.
`void`	`setImageData(RMImageData anImageData)` Sets the image data.
`void`	`setKey(java.lang.String aString)` Sets the report key used to load an image if none is provided.
`void`	`setPadding(int aPadding)` Sets the padding.
`void`	`setPageIndex(int anIndex)` Sets the page index.
`void`	`setPreserveRatio(boolean aValue)` Sets whether to preserve the natural width to height ratio of image.
`XMLElement`	`toXML(XMLArchiver anArchiver)` XML archival.

Methods inherited from class com.reportmill.shape.RMRectShape
getPath, getRadius, setRadius

Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, clone, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, deepChange, divideShapeFromEdge, divideShapeFromTop, get, get, getAlignment, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChild, getChildAnimator, getChildAnimator, getChildCount, getChildren, getClipShape, getColor, getDatasetEntity, getDatasetKey, getDocument, getEffect, getEventAdapter, getFill, getFont, getFormat, getFrame, getFrameHeight, getFrameMaxX, getFrameMaxY, getFrameWidth, getFrameX, getFrameXY, getFrameY, getHeight, getHover, getLayoutInfo, getMaskPath, getMaxX, getMaxY, getMinHeight, getMinHeight, getMinWidth, getMinWidth, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParent, getPathInBounds, getPrefHeight, getPrefHeight, getPrefWidth, getPrefWidth, getPropertyNameMapped, getPropertyNames, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isUnderlined, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, rpgAll, rpgBindings, setAlignment, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setEffect, setEnabled, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHover, setLayoutInfo, setLocked, setMinHeight, setMinSize, setMinWidth, setName, setOpacity, setOutline, setParent, setPrefHeight, setPrefWidth, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeWidth, setTextColor, setTime, setUnderlined, setURL, setVisible, setWidth, setX, setXY, setXY, setXYP, setY, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

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

- Constructor Detail
  - RMImageShape
```
public RMImageShape()
```
    Creates an RMImageShape.
  - RMImageShape
```
public RMImageShape(java.lang.Object aSource)
```
    Creates an RMImageShape from the image source provided.
- Method Detail
  - getKey
```
public java.lang.String getKey()
```
    Returns the report key used to load an image if none is provided.
  - setKey
```
public void setKey(java.lang.String aString)
```
    Sets the report key used to load an image if none is provided.
  - getImageData
```
public RMImageData getImageData()
```
    Returns the image data.
  - setImageData
```
public void setImageData(RMImageData anImageData)
```
    Sets the image data.
  - setImageData
```
public void setImageData(java.lang.Object aSource)
```
    Sets the image data from given source.
  - getPageIndex
```
public int getPageIndex()
```
    Returns the page index.
  - setPageIndex
```
public void setPageIndex(int anIndex)
```
    Sets the page index.
  - getPadding
```
public int getPadding()
```
    Returns the padding.
  - setPadding
```
public void setPadding(int aPadding)
```
    Sets the padding.
  - getAlignmentX
```
public RMTypes.AlignX getAlignmentX()
```
    Returns the horizontal alignment.
    
    Overrides:
    
    getAlignmentX in class RMShape
  - setAlignmentX
```
public void setAlignmentX(RMTypes.AlignX anAlignX)
```
    Sets the horizontal alignment.
    
    Overrides:
    
    setAlignmentX in class RMShape
  - getAlignmentY
```
public RMTypes.AlignY getAlignmentY()
```
    Returns the vertical alignment.
    
    Overrides:
    
    getAlignmentY in class RMShape
  - setAlignmentY
```
public void setAlignmentY(RMTypes.AlignY anAlignY)
```
    Sets the vertical alignment.
    
    Overrides:
    
    setAlignmentY in class RMShape
  - isGrowToFit
```
public boolean isGrowToFit()
```
    Returns whether to grow image to fit available area if shape larger than image.
  - setGrowToFit
```
public void setGrowToFit(boolean aValue)
```
    Sets whether to grow image to fit available area if shape larger than image.
  - getPreserveRatio
```
public boolean getPreserveRatio()
```
    Returns whether to preserve the natural width to height ratio of image.
  - setPreserveRatio
```
public void setPreserveRatio(boolean aValue)
```
    Sets whether to preserve the natural width to height ratio of image.
  - rpgShape
```
public RMShape rpgShape(ReportOwner aRptOwner,
                        RMShape aParent)
```
    Report generation method.
  - paintShape
```
public void paintShape(RMShapePainter aPntr)
```
    Override to paint shape.
    
    Overrides:
    
    paintShape in class RMShape
  - getImageBounds
```
public java.awt.geom.Rectangle2D getImageBounds()
```
    Returns the image bounds.
  - toXML
```
public XMLElement toXML(XMLArchiver anArchiver)
```
    XML archival.
    
    Overrides:
    
    toXML in class RMRectShape
  - fromXML
```
public java.lang.Object fromXML(XMLArchiver anArchiver,
                                XMLElement anElement)
```
    XML unarchival.
    
    Overrides:
    
    fromXML in class RMRectShape

Class RMImageShape

Nested Class Summary

Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMRectShape

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class java.lang.Object

Constructor Detail

RMImageShape

RMImageShape

Method Detail

getKey

setKey

getImageData

setImageData

setImageData

getPageIndex

setPageIndex

getPadding

setPadding

getAlignmentX

setAlignmentX

getAlignmentY

setAlignmentY

isGrowToFit

setGrowToFit

getPreserveRatio

setPreserveRatio

rpgShape

paintShape

getImageBounds

toXML

fromXML