com.inductiveautomation.rm.shape

Class RMSoundShape

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.shape.RMShape

com.inductiveautomation.rm.shape.RMSoundShape

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, RMTypes, java.beans.PropertyChangeListener, java.lang.Cloneable, 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.inductiveautomation.rm.base.RMTypes

RMTypes.Align, RMTypes.AlignX, RMTypes.AlignY

Field Summary

Fields inherited from class com.inductiveautomation.rm.shape.RMShape

BINDING_PROP_NAME, STROKE_BORDER, STROKE_DOUBLE, STROKE_HIDDEN, STROKE_SHAPE

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

Modifier and Type	Method and Description
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement 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.
protected void	getPropertyNames(java.util.List<java.lang.String> aList) Overridden to add 'Source' & 'Playing' to the list of property names you can bind to.
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.
RMShape	rptShape(ReportOwner anRptOwner) Report generation method.
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.).
protected void	shapeHidden() Overrides shape implementation to stop sound.
protected void	shapeShown() Overrides shape implementation to start sound if it should be playing.
RXElement	toXML(RXArchiver anArchiver) XML archival.

Methods inherited from class com.inductiveautomation.rm.shape.RMShape

acceptsChildren, acceptsMouse, addBinding, addBinding, addDeepChangeListener, addMouseListener, animUpdate, bounds, childrenSuperSelectImmediately, clone, cloneDeep, computePrefHeight, computePrefWidth, contains, convertedPointFromShape, convertedPointToShape, convertedRectFromShape, convertedRectToShape, convertedVectorFromShape, convertedVectorToShape, convertFromShape, convertPathFromShape, convertPathToShape, convertPointFromShape, convertPointToShape, convertRectFromShape, convertRectToShape, convertToShape, convertVectorFromShape, convertVectorToShape, copyShape, createDivideShapeRemainder, deepChange, divideShapeFromEdge, divideShapeFromTop, get, get, getAlignment, getAlignmentX, getAlignmentY, getAncestor, getAncestorCount, getAncestorInCommon, getAnimator, getAnimator, getAutosizing, getAutosizingDefault, getBestHeight, getBestHeight, getBestWidth, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBounds, getBoundsInside, getBoundsMarked, getBoundsMarkedDeep, getChild, getChildAnimator, getChildAnimator, getChildClipShape, getChildCount, getChildren, getClipShape, getColor, getDashArrayString, getDashPhase, getDatasetEntity, getDatasetKey, getDisplayedFill, getDisplayedStroke, 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, getRSS, getScaleX, getScaleY, getShapesToAncestor, getShapesToDescendant, getShapesToShape, getSize, getSkewX, getSkewY, getStroke, getStrokeColor, getStrokeOnTop, getStrokeStyle, getStrokeWidth, getTextColor, getTimeline, getTimeline, getTransform, getTransformFromShape, getTransformInverse, getTransformToShape, getUndoer, getURL, getVisbileBounds, getVisibleBounds, getVisibleBounds, getVisibleBounds, getWidth, getX, getXY, getXYP, getY, height, indexOf, intersects, isAncestor, isAnimProperty, isDeletable, isDescendant, isEditing, isEnabled, isFontSet, isHittable, isLocked, isMinHeightSet, isMinWidthSet, isPrefHeightSet, isPrefWidthSet, isRoot, isRSS, isShowing, isUnderlined, isUseFill, isUseStroke, isViewing, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, offsetXY, page, pageMax, paint, paintShapeAll, paintShapeChildren, paintShapeOver, propertyChange, put, removeBinding, removeBinding, removeDeepChangeListener, removeFromParent, removeMouseListener, repaint, repaint, resolvePageReferences, rpgAll, rpgBindings, rpgShape, setAlignment, setAlignmentX, setAlignmentY, setAutosizing, setBestHeight, setBestSize, setBounds, setBounds, setColor, setDashArrayString, setDashPhase, 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, setShowing, setSize, setSize, setSkewX, setSkewXY, setSkewY, setStroke, setStrokeColor, setStrokeStyle, setStrokeWidth, setTextColor, setTime, setTimeline, setUnderlined, setURL, setUseFill, setUseStroke, setVisible, setWidth, setX, setXY, setXY, setXYP, setY, superSelectable, toString, undoerDisable, undoerEnable, undoerSetUndoTitle, width, x, y

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

equals, finalize, 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.

rptShape

public RMShape rptShape(ReportOwner anRptOwner)

Report generation method.

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

protected void shapeShown()

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

Overrides:

shapeShown in class RMShape

shapeHidden

protected void shapeHidden()

Overrides shape implementation to stop sound.

Overrides:

shapeHidden in class RMShape

paintShape

public void paintShape(RMShapePainter aPntr)

Handles painting a sound shape.

Overrides:

paintShape in class RMShape

getPropertyNames

protected void getPropertyNames(java.util.List<java.lang.String> aList)

Overridden to add 'Source' & 'Playing' to the list of property names you can bind to.

Overrides:

getPropertyNames in class RMShape

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

Overrides:

toXML in class RMShape

fromXML

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

XML unarchival.

Specified by:

fromXML in interface Archivable

Overrides:

fromXML in class RMShape