quicktime.app.spaces
Class SimpleSpace

java.lang.Object
  |
  +--quicktime.app.spaces.SimpleSpace

All Implemented Interfaces:

Collection, DynamicCollection, Listener, Space, Ticklish

Direct Known Subclasses:

GroupDrawable, SWCompositor

Deprecated. since QTJava 6.1

public abstract class SimpleSpace

extends java.lang.Object

implements Space

SimpleSpace provides a default reference implementation of the Space interface. The following actions are taken by the SimpleSpace class when members or controllers are added to the Space.

• If the member is a Space then the contained Space will have the same source for its Listener members as the parent Space. The Space's TimeBase will be slaved to the parent Space.
• If the member or controller (TimeableController) implements the Timeable interface then the TimeBase of the member or controller will be slaved to the Space.
• If the member or controller (ListenerController) implements the Listener interface then the source of the Listener interest will be the source of the parent Space - that is all members and controllers will have the same Listener source.
• If the controller implements the Ticklish interface (TicklishController) it will be added to the ticklishList and the tickle and timeChanged methods of the Space will tickle and timeChange all members of this ticklishList.
• If the controller implements the Collection interface (CollectionController) and the isWholespace method of the controller returns true then all members that are added to the Space will also be added to the controller. It is the responsibility of the Controller to determine if the member is an appropriate member for it to control, and if so add it to its collection of objects it controls. If isWholespace is false then members must explicitly added to the controllers. When a member is removed from a Space the CollectionController will be told to remove that member form its collection of objects it controls (regardless of the isWholespace method).
• All Controllers that are added to a Space are considered to be active. There is no explicit way for a Controller to deactivate itself, though internally a particular implementation of the Controller interface may choose to be inactive or active. However the Space knows no such state of the Controller and thus treats all attached Controllers as active.

The SimpleSpace can be used in different settings - ie. it has no predefined application for managing display (presentation) or model contexts. The QTJava library provides DisplaySpaces as extensions and concrete classes of the SimpleSpace. However applications can also use SimpleSpace as a parent class for other kinds of Spaces, such as model spaces.

The SimpleSpace has no knowledge or implementation of the type of collection that is used to hold the collection of members. It is a delegated responsibility of the subclass to implement the Collection methods. There are two protected methods that the subclass should call after they have successfully added or removed a member - memberAdded and memberRemoved respectively. These methods ensure the behaviour of members as outlined.

See Also:

quicktime.app.display.SWCompositor, GroupDrawable

Field Summary

protected java.util.Vector	containedSpaces Deprecated. This vector is used to collect any Spaces that are added as members to this Space* @deprecated since QTJava 6.1
protected java.util.Vector	controllersVec Deprecated. This vector is used to collect the Controllers that are added to the Space* @deprecated since QTJava 6.1
protected TickleList	ticklers Deprecated. This TickleList is used to collect any ticklish controllers that are added to the Space* @deprecated since QTJava 6.1
protected Timer	timer Deprecated. This is the Timer that both provides a TimeBase for the Space and tickles the Space based on the scale and period of the Timer* @deprecated since QTJava 6.1

Fields inherited from interface quicktime.app.time.Ticklish

kScale

Constructor Summary

protected	SimpleSpace(Protocol protocols) Deprecated. since QTJava 6.1
protected	SimpleSpace(Protocol protocols, int scale, int period) Deprecated. since QTJava 6.1

Method Summary

void	addController(Controller c) Deprecated. since QTJava 6.1
void	addedTo(java.lang.Object interest) Deprecated. since QTJava 6.1
abstract boolean	addMember(java.lang.Object member) Deprecated. since QTJava 6.1
java.util.Enumeration	controllers() Deprecated. since QTJava 6.1
protected void	finalize() Deprecated.
Protocol	getProtocol() Deprecated. since QTJava 6.1
java.lang.Object	getSource() Deprecated. since QTJava 6.1
Timer	getTimer() Deprecated. since QTJava 6.1
boolean	hasMember(java.lang.Object object) Deprecated. since QTJava 6.1
boolean	isAppropriate(java.lang.Object object) Deprecated. since QTJava 6.1
protected void	memberAdded(java.lang.Object member) Deprecated. since QTJava 6.1
protected void	memberRemoved(java.lang.Object member) Deprecated. since QTJava 6.1
void	removeAllControllers() Deprecated. since QTJava 6.1
void	removeAllMembers() Deprecated. since QTJava 6.1
void	removeController(Controller c) Deprecated. since QTJava 6.1
void	removedFrom(java.lang.Object interest) Deprecated. since QTJava 6.1
abstract void	removeMember(java.lang.Object member) Deprecated. since QTJava 6.1
boolean	tickle(float er, int time) Deprecated. since QTJava 6.1
java.util.Enumeration	tickleList() Deprecated. since QTJava 6.1
void	timeChanged(int newTime) Deprecated. since QTJava 6.1

Methods inherited from class java.lang.Object

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

Methods inherited from interface quicktime.app.spaces.Collection

isEmpty, members, size

Field Detail

controllersVec

protected java.util.Vector controllersVec

Deprecated.

This vector is used to collect the Controllers that are added to the Space* @deprecated since QTJava 6.1

containedSpaces

protected java.util.Vector containedSpaces

Deprecated.

This vector is used to collect any Spaces that are added as members to this Space* @deprecated since QTJava 6.1

ticklers

protected TickleList ticklers

Deprecated.

This TickleList is used to collect any ticklish controllers that are added to the Space* @deprecated since QTJava 6.1

timer

protected Timer timer

Deprecated.

This is the Timer that both provides a TimeBase for the Space and tickles the Space based on the scale and period of the Timer* @deprecated since QTJava 6.1

Constructor Detail

SimpleSpace

protected SimpleSpace(Protocol protocols)
               throws QTException

Deprecated. since QTJava 6.1

Called by classes that extend the SimpleSpace. The sub class must pass in a Protocol object that defines the protocol (ie. the Class type of member objects) that the sub-class Space knows how to deal with. This ensure that members of a Space meet some minimal functionality.

This constructor does not create a Timer, the subclass must create a Timer in its constructor. This is provided so that subclasses can customise the Timer.

Parameters:

protocols - the Protocol that is enforced on candidate member objects of this space.

See Also:

Protocol, Timer

SimpleSpace

protected SimpleSpace(Protocol protocols,
                      int scale,
                      int period)
               throws QTException

Deprecated. since QTJava 6.1

Called by classes that extend the SimpleSpace. The sub class must pass in a Protocol object that defines the protocol (ie. the Class type of member objects) that the sub-class Space knows how to deal with. This ensure that members of a Space meet some minimal functionality. The constructor also provides a scale and period for the construction of the Space's Timer. This scale and period can be reset at any time using appropriate methods on the Timer class.

Parameters:

protocols - the Protocol that is enforced on candidate member objects of this space.

scale - the scale of the Space's Timer - this may NOT be zero.

period - the period of the Space's Timer.

See Also:

Protocol, Timer

Method Detail

timeChanged

public void timeChanged(int newTime)
                 throws QTException

Deprecated. since QTJava 6.1

Invoked by the timer when a time condition of its time base has changed.

Specified by:

timeChanged in interface Ticklish

QTException

tickle

public boolean tickle(float er,
                      int time)
               throws QTException

Deprecated. since QTJava 6.1

The Timer invokes the tickle method when the invocation constraints of the Timer are reached. If the sub-class Space has its own tickle requirements then it should overide the tickle method, however to ensure that any ticklish controllers are tickled the overiding implementation should first call super.tickle.

Specified by:

tickle in interface Ticklish

Parameters:

er - the effective rate of the Timer when the time condition matches

time - the time that the Timer invoked the tickle method.

Returns:

true if the Ticklish object should receive a consequent tickle, or false if the Ticklish object should not be tickled again.

QTException

tickleList

public java.util.Enumeration tickleList()

Deprecated. since QTJava 6.1

Returns an Enumeration of all of the Controllers that implement the Ticklish interface (TicklishControllers) that have been added to the Space. These controllers are tickled each time the Space itself is tickled by its Timer.

Specified by:

tickleList in interface Space

Returns:

an Enumeration of Ticklish objects

getSource

public java.lang.Object getSource()

Deprecated. since QTJava 6.1

This object is the source for all of the members and controllers of the Space that implement the Listener interface. All such members and controllers will have the same source as the parent space when it is addedTo a Listener source. If the parent Space has not been added to a Listener source this returns null.

Specified by:

getSource in interface Space

Returns:

the Listener source object

getProtocol

public Protocol getProtocol()

Deprecated. since QTJava 6.1

Returns the Protocol object that defines if a member is an appropriate member of the Space.

Specified by:

getProtocol in interface DynamicCollection

Returns:

a Protocol object.

isAppropriate

public boolean isAppropriate(java.lang.Object object)

Deprecated. since QTJava 6.1

Returns true if the Object object is an appropriate member of the Space. To be an appropriate member the object must pass the passProtocol method of the Protocol object of the Space.

Specified by:

isAppropriate in interface Collection

Parameters:

object - the Object to test

Returns:

true if the object passes the current protocol of the Protocol object of the Space.

See Also:

DynamicCollection, Protocol

hasMember

public boolean hasMember(java.lang.Object object)

Deprecated. since QTJava 6.1

Returns true if the specified QTDrawable is a member of this Group.

Specified by:

hasMember in interface Collection

Parameters:

object - the object to test for membership

Returns:

a boolean

addedTo

public void addedTo(java.lang.Object interest)

Deprecated. since QTJava 6.1

This method is called by some kind of container object when the Listener is added to the object that is the source of the interest.

Specified by:

addedTo in interface Listener

Parameters:

interest - the object that is to be the source of interest for the the Listener object.

removedFrom

public void removedFrom(java.lang.Object interest)

Deprecated. since QTJava 6.1

This method is called by the specified object when the Listener object is removed from the object that is the source of the interest.

Specified by:

removedFrom in interface Listener

Parameters:

interest - the object that is to be the source of interest for the the Listener object.

addController

public void addController(Controller c)
                   throws QTException

Deprecated. since QTJava 6.1

This method is used by the application to add a Controller to the Space. A Controller will control members of a Space.

Specified by:

addController in interface Space

Parameters:

c - the Controller to add to the Space.

QTException

removeController

public void removeController(Controller c)
                      throws QTException

Deprecated. since QTJava 6.1

Removes a controller that was previously added to the Space.

Specified by:

removeController in interface Space

Parameters:

c - the Controller to remove from the Space.

QTException

controllers

public java.util.Enumeration controllers()

Deprecated. since QTJava 6.1

Returns an Enumeration of all Controllers that are currently attached to the Space.

Specified by:

controllers in interface Space

Returns:

an Enumeration

getTimer

public Timer getTimer()

Deprecated. since QTJava 6.1

Returns the Timer of the Space. This Timer provids a TimeBase for the Space and if active will tickle and send timeChanged calls to the TicklishControllers that are attached to the Space.

Specified by:

getTimer in interface Space

Returns:

a Timer

addMember

public abstract boolean addMember(java.lang.Object member)
                           throws QTException

Deprecated. since QTJava 6.1

Adds an object to the collection. Returns true if the object is appropriate member of the collection (and thus added) and false if not.

Specified by:

addMember in interface Collection

Parameters:

member - the object that should be added as a member to the collection

Returns:

a boolean.

QTException

removeMember

public abstract void removeMember(java.lang.Object member)
                           throws QTException

Deprecated. since QTJava 6.1

If the object is a member of the collection it is removed.

Specified by:

removeMember in interface Collection

Parameters:

member - the object to remove from the collection

QTException

memberAdded

protected void memberAdded(java.lang.Object member)
                    throws QTException

Deprecated. since QTJava 6.1

When the sub-class defines the addMember method and has added the member to its collection it should call memberAdded to ensure that the member roles as defined within the Space are correctly established.

Parameters:

member - the object that has been added to the Space.

QTException

memberRemoved

protected void memberRemoved(java.lang.Object member)
                      throws QTException

Deprecated. since QTJava 6.1

When the sub-class defines the removeMember method and has removed the member from its collection it should call memberRemoved to ensure that the member roles as defined within the Space are correctly maintained.

Parameters:

member - the object that has been added to the Space.

QTException

removeAllControllers

public void removeAllControllers()
                          throws QTException

Deprecated. since QTJava 6.1

This method will remove all of the controllers that are currently attached to the Space.

QTException

removeAllMembers

public void removeAllMembers()
                      throws QTException

Deprecated. since QTJava 6.1

This method will remove all of the members that are currently contained by the space.

QTException

finalize

protected void finalize()
                 throws java.lang.Throwable

Deprecated.

Overrides:

finalize in class java.lang.Object

java.lang.Throwable