com.reportmill.shape
Class RMSound

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

All Implemented Interfaces:

com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMSound
extends RMShape

This class represents a sound in a document.

Nested Class Summary

static interface

RMSound.RMSoundListener A listener interface that can be implemented by anyone that cares.

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	fromXMLShape(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival.
javax.sound.sampled.Clip	getClip() Returns the clip.
javax.sound.sampled.Clip	getClip(boolean create) Returns the clip, creating it if requested.
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.
boolean	getPlaying() Returns whether this sound is currently playing.
com.reportmill.graphics.RMSoundData	getSoundData() Returns the sound data for this sound shape.
java.lang.String	getSoundName() Returns the name of the sound.
java.lang.Object	getSource() For the moment, this has to be here for the binder
void	paintShape(com.reportmill.shape.RMShapePainter aPainter, java.awt.Graphics2D g) Handles painting a sound shape.
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	setPlaying(boolean aValue) Sets whether or not this sound is currently playing.
void	setReportMill(com.reportmill.base.ReportMill aReportMill) Report generation method.
void	setSoundData(com.reportmill.graphics.RMSoundData aSoundData) Sets the sound data for this sound shape.
void	setSource(java.lang.Object aSource) Sets the source of the sound (File, String path, InputStream, byte array, etc.).
void	shapeHidden() Overrides shape implementation to stop sound.
void	shapeShown() Overrides shape implementation to start sound if it should be playing.
com.reportmill.archiver.RXElement	toXMLShape(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.

Methods inherited from class com.reportmill.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addChild, addChild, animUpdate, bounds, boundsChanged, boundsChanged, bringShapesToFront, checkBindings, 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, createDivideShapeRemainder, createLayout, createPartClone, divideShapeFromEdge, divideShapeFromTop, doLayout, firePropertyChange, fromXML, fromXMLShapeChildren, get, getAction, getAncestor, getAncestorCount, getAncestorInCommon, getAnim, getAnim, getAnimator, getAnimator, getAspectMapped, getAspects, getAutosizeHeight, getAutosizing, getBinder, getBinding, getBinding, getBindingCount, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getBoundsOfChildren, getCausesWrap, getCausesWrapType, getChild, getChildAnimator, getChildAnimator, getChildArray, getChildClipShape, getChildContaining, getChildCount, getChildCountHitable, getChildCountLayout, getChildCountVisible, getChildHitable, getChildLast, getChildLayout, getChildren, getChildrenIntersecting, getChildrenWhoCauseWrap, getChildrenWithClass, getChildrenWithClass, getChildVisible, getChildWithClass, getChildWithName, getClipShape, getColor, getDatasetEntity, getDatasetKey, getDocument, getEffect, getFill, getFill, getFillCount, getFont, getFormat, getFrame, getFrame, getFrameMaxX, getFrameMaxY, getFrameX, getFrameXY, getFrameY, getHeight, getHeightToFit, getImageFill, getLayout, getLineWidth, getMaskPath, getMaxX, getMaxY, getName, getOpacity, getOpacityDeep, getOriginal, getOutline, getPageBreak, getPageBreakMax, getPageBreakPage, getPageBreakPageMax, getPageShape, getParent, getParentWithClass, getPart, getPartCount, getPartDeep, getPartDeepCount, getPath, getPathInBounds, getReportMill, getRoll, getRootShape, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSizeP, getSkewX, getSkewY, getStroke, getStrokeColor, getTextColor, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getUrl, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getWidthToFit, getX, getXY, getXYP, getY, height, indexOf, indexOfChild, intersects, isAncestor, isAnimProperty, isDescendant, isEditing, isLocked, isMouseDown, isMouseOver, isRoot, isShowing, isUnderlined, isValid, isViewing, isVisible, layoutReset, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, notRSS, offsetChildrenXY, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeChild, removeChild, removeChildren, removeFromParent, repaint, repaint, resolvePageReferences, revalidate, sendShapesToBack, setAction, setAnim, setAutosizeHeight, setAutosizing, setBounds, setBounds, setCausesWrap, setCausesWrapType, setColor, setEffect, setFill, setFont, setFormat, setFrame, setFrame, setFrameSize, setFrameX, setFrameXY, setFrameXY, setFrameY, setHeight, setHeightToFit, setLayout, setLayoutEnabled, setLineWidth, setLocked, setName, setOpacity, setOutline, setParent, setReportMillBindings, setReportMillDeep, setRoll, setScaleX, setScaleXY, setScaleY, setSize, setSize, setSizeP, setSizeToFit, setSizeToFit, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setTextColor, setTime, setUnderlined, setUrl, setVisible, setWidth, setWidthToFit, setX, setXY, setXY, setXYP, setY, sizesToFitChildren, superSelectable, toString, toXML, toXMLShapeChildren, undoerDisable, undoerEnable, undoerSetUndoTitle, validate, width, x, y

Methods inherited from class com.reportmill.base.RMObject

addListener, addPropertyChangeListener, firePropertyChange, getListener, getListenerCount, getListeners, isFirePropertyChangeEnabled, isUndoing, removeListener, removePropertyChangeListener, setFirePropertyChangeEnabled, setUndoing

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

setSource

public void setSource(java.lang.Object aSource)

Sets the source of the sound (File, String path, InputStream, byte array, etc.).

getSource

public java.lang.Object getSource()

For the moment, this has to be here for the binder

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.

getSoundName

public java.lang.String getSoundName()

Returns the name of the sound.

getPlaying

public boolean getPlaying()

Returns whether this sound is currently playing.

setPlaying

public void setPlaying(boolean aValue)

Sets whether or not this sound is currently playing.

setReportMill

public void setReportMill(com.reportmill.base.ReportMill aReportMill)

Report generation method.

Overrides:

setReportMill in class RMShape

getClip

public javax.sound.sampled.Clip getClip()

Returns the clip.

getClip

public javax.sound.sampled.Clip getClip(boolean create)

Returns the clip, creating it if requested.

shapeShown

public void shapeShown()

Overrides shape implementation to start sound if it should be playing.

Overrides:

shapeShown in class RMShape

shapeHidden

public void shapeHidden()

Overrides shape implementation to stop sound.

Overrides:

shapeHidden in class RMShape

paintShape

public void paintShape(com.reportmill.shape.RMShapePainter aPainter,
                       java.awt.Graphics2D g)

Handles painting a sound shape.

Overrides:

paintShape in class RMShape

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class RMShape

toXMLShape

public com.reportmill.archiver.RXElement toXMLShape(com.reportmill.archiver.RXArchiver anArchiver,
                                                    java.lang.Object anOwner)

XML archival.

Overrides:

toXMLShape in class RMShape

fromXMLShape

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

XML unarchival.

Overrides:

fromXMLShape in class RMShape