RMSoundShape (ReportMill 14 API)

java.lang.Object
- SnapObject
- - com.reportmill.shape.RMShape
  - - com.reportmill.shape.RMSoundShape

All Implemented Interfaces:

RMTypes, java.beans.PropertyChangeListener, java.util.EventListener
```
public class RMSoundShape
extends RMShape
```
This class represents a sound in a document.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RMSoundShape.RMSoundListener
A listener interface that can be implemented by anyone that cares.
- Nested classes/interfaces inherited from interface com.reportmill.base.RMTypes
  RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RMSoundShape.RMSoundListener` A listener interface that can be implemented by anyone that cares.

Constructor Summary

Constructors
Constructor and Description
`RMSoundShape()` Creates an empty sound shape.
`RMSoundShape(java.lang.Object aSource)` Creates a sound shape from a given source (File, String path, InputStream, byte array, etc.).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`fromXML(XMLArchiver anArchiver, XMLElement anElement)` 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.
`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 binding.
`void`	`paintShape(RMShapePainter aPntr)` 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`	`setSoundData(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.).
`XMLElement`	`toXML(XMLArchiver anArchiver)` XML archival.

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, getAlignmentX, getAlignmentY, 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, getPath, 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, setAlignmentX, setAlignmentY, 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
  - RMSoundShape
```
public RMSoundShape()
```
    Creates an empty sound shape.
  - RMSoundShape
```
public RMSoundShape(java.lang.Object aSource)
```
    Creates a sound shape from a given source (File, String path, InputStream, byte array, etc.).
- Method Detail
  - getSource
```
public java.lang.Object getSource()
```
    For the moment, this has to be here for binding.
  - setSource
```
public void setSource(java.lang.Object aSource)
```
    Sets the source of the sound (File, String path, InputStream, byte array, etc.).
  - getSoundData
```
public RMSoundData getSoundData()
```
    Returns the sound data for this sound shape.
  - setSoundData
```
public void setSoundData(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.
  - 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.
  - paintShape
```
public void paintShape(RMShapePainter aPntr)
```
    Handles painting a sound shape.
    
    Overrides:
    
    paintShape in class RMShape
  - toXML
```
public XMLElement toXML(XMLArchiver anArchiver)
```
    XML archival.
    
    Overrides:
    
    toXML in class RMShape
  - fromXML
```
public java.lang.Object fromXML(XMLArchiver anArchiver,
                                XMLElement anElement)
```
    XML unarchival.
    
    Overrides:
    
    fromXML in class RMShape

Class RMSoundShape

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMShape

Methods inherited from class java.lang.Object

Constructor Detail

RMSoundShape

RMSoundShape

Method Detail

getSource

setSource

getSoundData

setSoundData

getKey

setKey

getDelay

setDelay

getLoopCount

setLoopCount

getOverlap

setOverlap

getSoundName

getPlaying

setPlaying

getClip

getClip

paintShape

toXML

fromXML