ReportMill 10 API

com.reportmill.shape
Class RMImage

java.lang.Object
  extended by com.reportmill.base.RMObject
      extended by com.reportmill.shape.RMShape
          extended by com.reportmill.shape.RMRectangle
              extended by com.reportmill.shape.RMImage
All Implemented Interfaces:
java.lang.Cloneable

public class RMImage
extends RMRectangle

This class is a shape representation of an image.


Field Summary
 
Fields inherited from class com.reportmill.shape.RMShape
WRAP_TYPE_BOTH, WRAP_TYPE_NONE
 
Constructor Summary
RMImage()
          Creates a plain image shape (with no actual image).
RMImage(java.lang.Object aSource)
          Creates an image shape from the image source provided.
 
Method Summary
 boolean equals(java.lang.Object anObj)
          Standard equals implementation.
 java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement)
          XML unarchival.
 int getFillStyle()
          Returns the fill style for the image's image fill.
 float getHeightToFit()
          Returns the height to fit the image.
 com.reportmill.graphics.RMImageData getImageData()
          Returns the imageData for this shape (or null if fill isn't an RMImageFill).
 java.lang.String getKey()
          Returns the report key used to load an image if none is provided.
 boolean getSizeBorders()
          Returns whether the image shape should resize it's borders to fit dynamically provided images.
 float getWidthToFit()
          Returns the width to fit the image.
 RMShape rpgClone(com.reportmill.base.ReportMill aReportMill)
          Report generation method.
 void setFill(RMFill aFill)
          Overrides standard shape setFill method to ensure fill is an RMImageFill.
 void setKey(java.lang.String aString)
          Sets the report key used to load an image if none is provided.
 void setSizeBorders(boolean aFlag)
          Sets whether the image shape should resize it's borders to fit dynamically provided images.
 com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)
          XML archival.
 
Methods inherited from class com.reportmill.shape.RMRectangle
copy, getPath, getRadius, setRadius
 
Methods inherited from class com.reportmill.shape.RMShape
acceptsChildren, acceptsMouse, addChild, addChild, bounds, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, childrenSuperSelectImmediately, clone, cloneDeep, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createLayout, delete, didChange, divideShapeFromEdge, divideShapeFromTop, doLayout, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsSuperSelected, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDatasetKey, getDatasetKeyDeep, getDatasetKeyShape, getDocument, getFill, getFill, getFill, getFillCount, getFills, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getGroupShape, getHeight, getImageFill, getLayout, getLineWidth, getListKey, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageCount, getPageShape, getParent, getParentCount, getParents, getPathInBounds, getPropertyKey, getPropertyKeyCount, getPropertyKeyName, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getToolClassName, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getX, getXY, getXYP, getY, groupShapes, height, indexOf, indexOf, intersects, invalidate, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, isValid, layoutReset, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, put, putPropertyKey, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, revalidate, rpgCloneBase, rpgCloneChildren, rpgCloneNotification, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrapType, setChildren, setColor, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightDeep, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOpacity, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, superSelectable, toString, toXMLDeep, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, willChange, willChange, x, y
 
Methods inherited from class com.reportmill.base.RMObject
didUndo, getAnimAttribute, getClassNameShort
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RMImage

public RMImage()
Creates a plain image shape (with no actual image).


RMImage

public RMImage(java.lang.Object aSource)
Creates an image shape 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.


getSizeBorders

public boolean getSizeBorders()
Returns whether the image shape should resize it's borders to fit dynamically provided images.


setSizeBorders

public void setSizeBorders(boolean aFlag)
Sets whether the image shape should resize it's borders to fit dynamically provided images.


getImageData

public com.reportmill.graphics.RMImageData getImageData()
Returns the imageData for this shape (or null if fill isn't an RMImageFill).


getFillStyle

public int getFillStyle()
Returns the fill style for the image's image fill.


setFill

public void setFill(RMFill aFill)
Overrides standard shape setFill method to ensure fill is an RMImageFill.

Overrides:
setFill in class RMShape

getWidthToFit

public float getWidthToFit()
Returns the width to fit the image.

Overrides:
getWidthToFit in class RMShape

getHeightToFit

public float getHeightToFit()
Returns the height to fit the image.

Overrides:
getHeightToFit in class RMShape

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill aReportMill)
Report generation method.

Overrides:
rpgClone in class RMShape

equals

public boolean equals(java.lang.Object anObj)
Standard equals implementation.

Overrides:
equals in class RMRectangle

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)
XML archival.

Overrides:
toXML in class RMRectangle

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                                com.reportmill.archiver.RXElement anElement)
XML unarchival.

Overrides:
fromXML in class RMRectangle

ReportMill 10 API