ReportMill 7.0 API

com.reportmill.shape
Class RMImage

java.lang.Object
  extended bycom.reportmill.foundation.RMObject
      extended bycom.reportmill.shape.RMShape
          extended bycom.reportmill.shape.RMRectangle
              extended bycom.reportmill.shape.RMImage
All Implemented Interfaces:
java.lang.Cloneable, com.reportmill.foundation.RMArchiver.Archiving

public class RMImage
extends RMRectangle

This class is a shape representation of an image.


Field Summary
 
Fields inherited from class com.reportmill.shape.RMRectangle
_radius
 
Fields inherited from class com.reportmill.shape.RMShape
HandleMaxXMaxY, HandleMaxXMidY, HandleMaxXMinY, HandleMidXMaxY, HandleMidXMinY, HandleMinXMaxY, HandleMinXMidY, HandleMinXMinY, HandleWidth
 
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.ribs.RXArchiver anArchiver, com.ribs.RXElement anElement)
          XML unarchival.
 boolean getCacheData()
          Returns whether image data should be cached (in anticipation of sharing among multiple image shapes).
 int getFillStyle()
          Returns the fill style for the image's image fill.
 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.
 java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)
          Legacy unarchival.
 RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill)
          Report generation method.
 void setCacheData(boolean aFlag)
          Returns whether image data should be cached (in anticipation of sharing among multiple image shapes).
 void setFill(RMFill aFill, boolean drawsFill)
          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.ribs.RXElement toXML(com.ribs.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, acceptsDragKeys, acceptsEvents, acceptsFirstEvent, acceptsFormat, addChild, addChild, addChildBelowLastChild, boundsChanged, boundsChanged, bringShapesToFront, canBeUngrouped, childHitByPoint, childrenHitByPath, childrenSuperSelectImmediately, clone, cloneDeep, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedSizeFromShape, convertedSizeToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertSizeFromShape, convertSizeToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, didChange, divideShapeFromEdge, divideShapeFromTop, dragExit, dragKeyAtPoint, drawChildren, drawsFill, drawsStroke, dropKeyAtPoint, fromXMLDeep, get, getActionScript, getAnim, getAnim, getAnimator, getAnimator, getAutosizeHeight, getAutosizing, getBounds, getBounds, getBoundsInside, getBoundsMarked, getBoundsOfChildren, getBoundsOfChildren, getBoundsOfPath, getBoundsOrigin, getBoundsSize, getBoundsSuperSelected, getChild, getChildAnimator, getChildAnimator, getChildCount, getChildLast, getChildren, getChildWithClass, getChildWithName, getColor, getCommonAncestor, getDocument, getFill, getFont, getFormat, getGroupShape, getHeight, getHeightToFit, getImageData, getImageFill, getLineWidth, getListKey, getListKeyDeep, getListKeyShape, getName, getOpacity, getOpacityDeep, getOrigin, getOutline, getPageCount, getPageShape, getParent, getParentCount, getParents, getPathInBounds, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getWidth, getWidthToFit, getX, getY, groupShapes, handleAtPoint, handleCount, handlePoint, handleRect, hasPageBreaks, height, hitByPath, hitByPoint, hitChildren, indexOf, indexOf, isAncestor, isDescendant, isLocked, isRoot, isUnderlined, maxX, maxXInside, maxY, maxYInside, midX, midXInside, midY, midYInside, minX, minXInside, minY, minYInside, moveHandleToPoint, notRSS, offsetChildrenXY, offsetXY, opposingHandle, page, pageBreakMax, pageBreakPageMax, pageMax, put, reclaimChildren, removeChild, removeChild, removeChildren, removeChildren, removeFromParent, resolvePageReferences, rpgCloneBase, rpgCloneChildren, rpgCloneConclude, rpgCloneNotification, rpgClonePrepare, rpgClonePreprocess, rpgCloneUrl, sendShapesToBack, setActionScript, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setBoundsOrigin, setBoundsOrigin, setBoundsOriginX, setBoundsOriginY, setBoundsSize, setBoundsSize, setChildAnimator, setChildren, setColor, setColor, setDrawsFill, setDrawsStroke, setEverythingStretches, setFill, setFont, setFormat, setHeight, setHeightDeep, setHeightDeep, setHeightToFit, setLineWidth, setListKey, setLocked, setName, setNeedsRepaint, setNeedsRepaint, setOnlyBottomAndRightMarginStretches, setOnlyTopAndRightMarginStretches, setOnlyWidthAndHeightStretches, setOpacity, setOrigin, setOrigin, setOutline, setParent, setRoll, setScaleX, setScaleXY, setScaleXY, setScaleY, setSize, setSize, setSizeDeep, setSizeDeep, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewXY, setSkewY, setStroke, setStroke, setStrokeColor, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setWidth, setWidthDeep, setWidthDeep, setWidthToFit, setX, setXY, setXY, setXYWidthHeight, setY, sizesToFitChildren, superSelectable, superSelectImmediately, toString, undoClone, undoCopy, undoEquals, undoerAddDirtyObject, undoerDisable, undoerEnable, undoerSetUndoTitle, width, willChange, willChange, x, y
 
Methods inherited from class com.reportmill.foundation.RMObject
archiverClassName, 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.


getCacheData

public boolean getCacheData()
Returns whether image data should be cached (in anticipation of sharing among multiple image shapes).


setCacheData

public void setCacheData(boolean aFlag)
Returns whether image data should be cached (in anticipation of sharing among multiple image shapes).


setFill

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

Overrides:
setFill in class RMShape

getFillStyle

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


rpgClone

public RMShape rpgClone(com.reportmill.foundation.ReportMill reportMill)
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.ribs.RXElement toXML(com.ribs.RXArchiver anArchiver)
XML archival.

Overrides:
toXML in class RMRectangle

fromXML

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

Overrides:
fromXML in class RMRectangle

initWithArchiver

public java.lang.Object initWithArchiver(com.reportmill.foundation.RMArchiver anArchiver)
Legacy unarchival.

Specified by:
initWithArchiver in interface com.reportmill.foundation.RMArchiver.Archiving
Overrides:
initWithArchiver in class RMRectangle

ReportMill 7.0 API