|
jET |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jet.sce.Scenery
The scenery is the class where data for editor is stored. It has two lists containing tracks and switches. In addition scenery may have custom properties, and description.
Be caution about securing read access to scenery. See readLock() and readUnlock() methods.
Nested Class Summary | |
class |
Scenery.DefaultSceneryEvent
Scenery event standard implementation. |
class |
Scenery.NamesIndices
The indices for track and switch names, implementing a list data model to speed up searching for track names. |
Field Summary | |
protected javax.swing.event.EventListenerList |
listenerList
Event listener list. |
protected java.util.Set |
switches
Set containing switches. |
protected java.util.Set |
tracks
Set containing scenery elements. |
Constructor Summary | |
Scenery()
|
Method Summary | |
void |
addSceneryChangeListener(SceneryChangeListener listener)
Adds a scenery listener to this document for notification of any changes. |
void |
addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
Adds an undo listener for notification of any changes. |
boolean |
contains(java.lang.Object o)
Tests if scenery contains specified object. |
void |
dump(java.io.PrintStream psOut)
Dumps debugging info. |
protected void |
fireSceneryChange(SceneryEvent sce)
Fires scenery change event to all registered scenery listeners. |
int |
getCount(java.lang.Class c)
Returns element's count of specified class. |
java.lang.String |
getDescription()
Gets scenery description. |
java.util.Iterator |
getIterator(java.lang.Class c)
Returns iterator of elements's collection given class. |
java.util.EventListener[] |
getListeners(java.lang.Class listenerType)
Returns an array of registered foo listeners on this scenery. |
java.lang.Object |
getProperty(java.lang.Object key)
Gets a property with key key . |
SceneryChangeListener[] |
getSceneryChangeListeners()
Returns an array of all registered scenery listeners on this document. |
java.util.Dictionary |
getSceneryProperties()
Scenery may contain some properties. |
javax.swing.ListModel |
getTrackNames()
Returns data model for list of track and switch names. |
javax.swing.event.UndoableEditListener[] |
getUndoableEditListeners()
Returns an array of all registered undo listeners on this document. |
void |
insert(java.lang.Object[] obj)
Inserts array of object to the scenery. |
void |
putProperty(java.lang.Object key,
java.lang.Object value)
Sets property for the scenery. |
void |
readLock()
Acquires a lock to begin reading from the scenery. |
void |
readUnlock()
Does a read unlock. |
void |
remove(java.lang.Object[] obj)
Removes object from scenery. |
void |
removeSceneryChangeListener(SceneryChangeListener listener)
Removes a scenery listener. |
void |
removeUndoableEditListener(javax.swing.event.UndoableEditListener listener)
Removes an undo listener. |
void |
replace(java.lang.Object[] o,
java.lang.Object[] n)
Replaces old object with new ones. |
void |
setDescription(java.lang.String content)
Sets scenery description. |
void |
setSceneryProperties(java.util.Dictionary x)
Scenery may contain some properties. |
protected void |
writeLock()
Acquires a scenery lock for writing. |
protected void |
writeUnlock()
Releases a write lock previously obtained via writeLock . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected javax.swing.event.EventListenerList listenerList
protected java.util.Set tracks
protected java.util.Set switches
Constructor Detail |
public Scenery()
Method Detail |
public void insert(java.lang.Object[] obj)
obj
- Elements to insert to.
java.lang.IllegalArgumentException
- When array is null.public void remove(java.lang.Object[] obj)
obj
- An array of elements to remove.
java.lang.IllegalArgumentException
- When array is null or
some of elements in array were not in scenery.public void replace(java.lang.Object[] o, java.lang.Object[] n)
o
- Objects stored in scenery.n
- New object.
java.lang.IllegalArgumentException
- When length of the arrays are not equal or
scenery does not contain some of elements of the first array.public java.util.Iterator getIterator(java.lang.Class c)
c
- Class of elements.
public int getCount(java.lang.Class c)
c
- Class of elements.
public boolean contains(java.lang.Object o)
True
if scenery contains the objectpublic javax.swing.ListModel getTrackNames()
public void setDescription(java.lang.String content)
Scenery description describes scenery and it is usefull to include some user data.
content
- The description.public java.lang.String getDescription()
Scenery description describes scenery and it is usefull to include some user data.
public void addSceneryChangeListener(SceneryChangeListener listener)
listener
- The scenery listener to add.addSceneryChangeListener(org.jet.sce.SceneryChangeListener)
public void removeSceneryChangeListener(SceneryChangeListener listener)
listener
- The scenery listener to remove.removeSceneryChangeListener(org.jet.sce.SceneryChangeListener)
public SceneryChangeListener[] getSceneryChangeListeners()
addSceneryChangeListener(org.jet.sce.SceneryChangeListener)
,
removeSceneryChangeListener(org.jet.sce.SceneryChangeListener)
public void addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
listener
- The undo listener to add.addUndoableEditListener(javax.swing.event.UndoableEditListener)
public javax.swing.event.UndoableEditListener[] getUndoableEditListeners()
addUndoableEditListener(javax.swing.event.UndoableEditListener)
,
removeUndoableEditListener(javax.swing.event.UndoableEditListener)
public void removeUndoableEditListener(javax.swing.event.UndoableEditListener listener)
listener
- The undo listener to remove.removeUndoableEditListener(javax.swing.event.UndoableEditListener)
public java.util.EventListener[] getListeners(java.lang.Class listenerType)
SceneryChangeListener[] mls = (SceneryChangeListener[])(d.getListeners(SceneryChangeListener.class));
java.lang.ClassCastException
- If listenerType
dosen't
specify a class or interface that implements java.util.EventListener
.getSceneryChangeListeners()
,
getUndoableEditListeners()
protected void fireSceneryChange(SceneryEvent sce)
sce
- Scenery event to fire.public java.util.Dictionary getSceneryProperties()
setSceneryProperties(java.util.Dictionary)
public void setSceneryProperties(java.util.Dictionary x)
x
- New properties.getSceneryProperties()
public final java.lang.Object getProperty(java.lang.Object key)
key
.
key
- A property key.
putProperty(java.lang.Object, java.lang.Object)
public final void putProperty(java.lang.Object key, java.lang.Object value)
key
,
when value is null
.
key
- A property key.value
- A property value. If null
property
will be removed.getProperty(java.lang.Object)
protected final void writeLock()
java.lang.IllegalStateException
- Thrown on illegal
lock attempt.writeUnlock()
protected final void writeUnlock()
writeLock
.
writeLock()
public final void readLock()
readUnlock()
public final void readUnlock()
readLock()
public void dump(java.io.PrintStream psOut)
psOut
- Print stream to output.
|
jET |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |