org.opensourcephysics.ejs.control.swing
Class ControlSound

java.lang.Object
  org.opensourcephysics.ejs.control.ControlElement
      org.opensourcephysics.ejs.control.swing.ControlSwingElement
          org.opensourcephysics.ejs.control.swing.ControlCheckBox
              org.opensourcephysics.ejs.control.swing.ControlSound

public class ControlSound
extends ControlCheckBox

An element to play sound according to the state of an internal variable. The element does not change this variable

Field Summary

Fields inherited from class org.opensourcephysics.ejs.control.swing.ControlCheckBox

checkbox

Fields inherited from class org.opensourcephysics.ejs.control.swing.ControlSwingElement

ACTION_OFF, ACTION_ON, ACTION_PRESS, BACKGROUND, ENABLED, FONT, FOREGROUND, myVisual, NAME, PARENT, POSITION, SIZE, TOOLTIP, VISIBLE

Fields inherited from class org.opensourcephysics.ejs.control.ControlElement

ACTION, isUnderEjs, METHOD_FOR_VARIABLE, METHOD_TRIGGER, myGroup, myObject, myPropertiesTable, VARIABLE_CHANGED

Constructor Summary

ControlSound(java.lang.Object _visual)
Constructor ControlSound

Method Summary

void	destroy() Clears any trace of myself (specially in the group)
java.lang.String	getPropertyInfo(java.lang.String _property) Returns information about a given property.
java.util.ArrayList<java.lang.String>	getPropertyList() Returns the list of all properties that can be set for this ControlElement.
Value	getValue(int _index) Gets the value of any internal variable.
void	play()
void	setAudioClip(java.lang.String _codebase, java.lang.String _audioFile)
void	setDefaultValue(int _index)
void	setValue(int _index, Value _value) Sets the value of the registered variables.
void	stop()

Methods inherited from class org.opensourcephysics.ejs.control.swing.ControlCheckBox

createVisual, reset

Methods inherited from class org.opensourcephysics.ejs.control.swing.ControlSwingElement

getComponent, getIcon, getVisual, parseConstant

Methods inherited from class org.opensourcephysics.ejs.control.ControlElement

addAction, addAction, addAction, getGroup, getObject, getProperty, getSimulation, implementsProperty, initialize, invokeActions, invokeActions, isActive, propertyIsTypeOf, propertyType, removeAction, removeAction, setActive, setGroup, setProperties, setProperty, toString, variableChanged, variableChangedDoNotUpdate, variablePropertiesClear, variablesChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ControlSound

public ControlSound(java.lang.Object _visual)

Constructor ControlSound

Parameters:

_visual -

Method Detail

setAudioClip

public void setAudioClip(java.lang.String _codebase,
                         java.lang.String _audioFile)

destroy

public void destroy()

Description copied from class: ControlElement

Clears any trace of myself (specially in the group)

Overrides:

destroy in class ControlElement

play

public void play()

stop

public void stop()

getPropertyList

public java.util.ArrayList<java.lang.String> getPropertyList()

Description copied from class: ControlSwingElement

Returns the list of all properties that can be set for this ControlElement. Subclasses that add properties should extend this table. Order is crucial here: Both for the presentation in an editor (f.i. ViewElement) and for the setValue() method.

Overrides:

getPropertyList in class ControlCheckBox

getPropertyInfo

public java.lang.String getPropertyInfo(java.lang.String _property)

Description copied from class: ControlSwingElement

Returns information about a given property. Subclasses that add properties should extend this table.

The first keyword is ALWAYS the type.

The keyword CONSTANT applies to properties that can not be changed using the setValue() methods

The keyword BASIC is used by Ejs to group properties to the left hand side of the property editor

The keyword HIDDEN is used by Ejs so that it does not display an entry in the editor field

Overrides:

getPropertyInfo in class ControlCheckBox

setValue

public void setValue(int _index,
                     Value _value)

Description copied from class: ControlSwingElement

Sets the value of the registered variables. Subclasses with internal values should extend this

Overrides:

setValue in class ControlCheckBox

Parameters:

_index - A keyword index that distinguishes among variables

_value - The object holding the value for the variable.

setDefaultValue

public void setDefaultValue(int _index)

Overrides:

setDefaultValue in class ControlCheckBox

getValue

public Value getValue(int _index)

Description copied from class: ControlSwingElement

Gets the value of any internal variable. Subclasses with internal values should extend this

Overrides:

getValue in class ControlCheckBox

Parameters:

_index - A keyword index that distinguishes among variables

Returns:

Value _value The object holding the value for the variable.