com.reportmill.shape
Class RMSound

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.shape.RMShape
          com.reportmill.shape.RMSound

All Implemented Interfaces:

java.lang.Cloneable

public class RMSound
extends RMShape

This class represents a sound in a document.

Field Summary

Fields inherited from class com.reportmill.shape.RMShape

WRAP_TYPE_BOTH, WRAP_TYPE_NONE

Constructor Summary

RMSound()
Creates an empty sound shape.

RMSound(java.lang.Object aSource)
Creates a sound shape from a given source (File, String path, InputStream, byte array, etc.).

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.
float	getDelay() Returns the delay after which this sound is supposed to start to play.
java.lang.String	getKey() Returns the RPG key for this sound shape.
int	getLoopCount() Returns the number of loops that this sound should play before stopping.
boolean	getOverlap() Returns whether this sound should overlap other sounds.
com.reportmill.graphics.RMSoundData	getSoundData() Returns the sound data for this sound shape.
RMShape	rpgClone(com.reportmill.base.ReportMill reportMill) Returns a copy of this shape for report generation - might include getting new sound data using RPG key.
void	setDelay(float aValue) Sets the delay after which this sound is supposed to start to play.
void	setKey(java.lang.String aKey) Sets the RPG key for this sound shape.
void	setLoopCount(int aValue) Returns the number of loops that this sound should play before stopping.
void	setOverlap(boolean aValue) Returns whether this sound should overlap other sounds.
void	setSoundData(com.reportmill.graphics.RMSoundData aSoundData) Sets the sound data for this sound shape.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver) XML archival.

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, copy, 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, getHeightToFit, getImageFill, getLayout, getLineWidth, getListKey, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageCount, getPageShape, getParent, getParentCount, getParents, getPath, 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, getWidthToFit, 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, setFill, 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

RMSound

public RMSound()

Creates an empty sound shape.

RMSound

public RMSound(java.lang.Object aSource)

Creates a sound shape from a given source (File, String path, InputStream, byte array, etc.).

Method Detail

getSoundData

public com.reportmill.graphics.RMSoundData getSoundData()

Returns the sound data for this sound shape.

setSoundData

public void setSoundData(com.reportmill.graphics.RMSoundData aSoundData)

Sets the sound data for this sound shape.

getKey

public java.lang.String getKey()

Returns the RPG key for this sound shape.

setKey

public void setKey(java.lang.String aKey)

Sets the RPG key for this sound shape.

getDelay

public float getDelay()

Returns the delay after which this sound is supposed to start to play.

setDelay

public void setDelay(float aValue)

Sets the delay after which this sound is supposed to start to play.

getLoopCount

public int getLoopCount()

Returns the number of loops that this sound should play before stopping.

setLoopCount

public void setLoopCount(int aValue)

Returns the number of loops that this sound should play before stopping.

getOverlap

public boolean getOverlap()

Returns whether this sound should overlap other sounds.

setOverlap

public void setOverlap(boolean aValue)

Returns whether this sound should overlap other sounds.

rpgClone

public RMShape rpgClone(com.reportmill.base.ReportMill reportMill)

Returns a copy of this shape for report generation - might include getting new sound data using RPG key.

Overrides:

rpgClone in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMShape

toXML

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

XML archival.

Overrides:

toXML in class RMShape

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMShape