Michael Bayne
63191ec610
a place config object which is used to determine the classes of the place manager and the (newly added) place controller. Moved PlaceView and PlaceViewUtil into cocktail.party.client from cocktail.party.util because the controller and the UI (in very abstract form) are now part of the place services. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@399 542714f4-19e9-0310-aa3c-eee0fc999fb1
105 lines
3.6 KiB
Java
105 lines
3.6 KiB
Java
//
|
|
// $Id: PlaceController.java,v 1.1 2001/10/05 23:57:26 mdb Exp $
|
|
|
|
package com.threerings.cocktail.party.client;
|
|
|
|
import java.awt.event.ActionEvent;
|
|
import com.samskivert.swing.Controller;
|
|
|
|
import com.threerings.cocktail.party.data.PlaceConfig;
|
|
import com.threerings.cocktail.party.data.PlaceObject;
|
|
import com.threerings.cocktail.party.util.PartyContext;
|
|
|
|
/**
|
|
* Controls the user interface that is used to display a place. When the
|
|
* client moves to a new place, the appropriate place controller is
|
|
* constructed and requested to create and display the appopriate user
|
|
* interface for that place.
|
|
*/
|
|
public abstract class PlaceController
|
|
extends Controller
|
|
{
|
|
/**
|
|
* Initializes this place controller with a reference to the context
|
|
* that they can use to access client services and to the
|
|
* configuration record for this place. The controller should create
|
|
* as much of its user interface that it can without having access to
|
|
* the place object because this will be invoked in parallel with the
|
|
* fetching of the place object. When the place object is obtained,
|
|
* the controller will be notified and it can then finish the user
|
|
* interface configuration and put the user interface into operation.
|
|
*
|
|
* @param ctx the client context.
|
|
* @param config the place configuration for this place.
|
|
*/
|
|
public void init (PartyContext ctx, PlaceConfig config)
|
|
{
|
|
// keep these around
|
|
_ctx = ctx;
|
|
_config = config;
|
|
|
|
// create our user interface
|
|
_view = createPlaceView();
|
|
}
|
|
|
|
/**
|
|
* Creates the user interface that will be used to display this place.
|
|
* The view instance returned will later be configured with the place
|
|
* object, once it becomes available.
|
|
*/
|
|
protected abstract PlaceView createPlaceView ();
|
|
|
|
/**
|
|
* This is called by the location director once the place object has
|
|
* been fetched. The place controller will dispatch the place object
|
|
* to the user interface hierarchy via {@link
|
|
* PlaceViewUtil.dispatchWillEnterPlace}. Derived classes can override
|
|
* this and perform any other starting up that they need to do
|
|
*/
|
|
public void willEnterPlace (PlaceObject plobj)
|
|
{
|
|
// let the UI hierarchy know that we've got our place
|
|
if (_view != null ) {
|
|
PlaceViewUtil.dispatchWillEnterPlace(_view, plobj);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This is called by the location director when we are leaving this
|
|
* place and need to clean up after ourselves and shutdown. Derived
|
|
* classes should override this method (being sure to call
|
|
* <code>super.didLeavePlace</code>) and perform any necessary
|
|
* cleanup.
|
|
*/
|
|
public void didLeavePlace (PlaceObject plobj)
|
|
{
|
|
// let the UI hierarchy know that we're outta here
|
|
if (_view != null ) {
|
|
PlaceViewUtil.dispatchDidLeavePlace(_view, plobj);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles basic place controller action events. Derived classes
|
|
* should be sure to call <code>super.handleAction</code> for events
|
|
* they don't specifically handle.
|
|
*/
|
|
public boolean handleAction (ActionEvent action)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/** A reference to the active client context. */
|
|
protected PartyContext _ctx;
|
|
|
|
/** A reference to our place configuration. */
|
|
protected PlaceConfig _config;
|
|
|
|
/** A reference to the place object for which we're controlling a user
|
|
* interface. */
|
|
protected PlaceObject _plobj;
|
|
|
|
/** A reference to the root user interface component. */
|
|
protected PlaceView _view;
|
|
}
|