votorola.s.gwt.stage

Class TheatreInitializerC

java.lang.Object

TheatreInitializerC

All Implemented Interfaces:

TheatreInitializer

Direct Known Subclasses:

TheatreInitializerBC

public abstract class TheatreInitializerC
extends Object
implements TheatreInitializer

A theatre initializer with a handy "init complete" method.

Constructor Summary

Constructors

Constructor and Description
TheatreInitializerC()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	initComplete(Stage s, boolean rPending) Signals that initFrom or initTo was called for all props and that immediate initialization of the stage is complete and the associated events have fired.
void	initFrom(Stage _s, boolean _rPending) Here the prop or other component initializes its own properties by reference to a previously initialized stage.
void	initFromComplete(Stage _s, boolean _rPending) Signals that initFrom was called for all props and that immediate initialization of the stage is complete and the associated events have fired.
void	initTo(Stage _s) Here the prop or other component initializes the properties of the stage.
void	initTo(Stage _s, TheatrePage _r) Here the prop or other component initializes the properties of the stage.
void	initToComplete(Stage _s, boolean _rPending) Signals that initTo was called for all props and that immediate initialization of the stage is complete and the associated events have fired.
void	initUltimately(Stage _s, TheatrePage _r) Signals that deferred resolution of the referrer is now complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

TheatreInitializerC

public TheatreInitializerC()

Method Detail

initComplete

public abstract void initComplete(Stage s,
                boolean rPending)

Signals that initFrom or initTo was called for all props and that immediate initialization of the stage is complete and the associated events have fired. Referrer resolution may yet follow depending on the value of rPending.

Parameters:

rPending - true if initialization will eventually complete at initUltimately; false if this is the end of it.

initFrom

public void initFrom(Stage _s,
            boolean _rPending)

Description copied from interface: TheatreInitializer

Here the prop or other component initializes its own properties by reference to a previously initialized stage. This method is called on page load after the state of the stage has been restored via single-page persistence. Writing to the stage is permitted here, though ordinarily only page authors will do this and only in cases where a stage property needs to be re-initialized owing to a change in the environment, such as a structual change to the page.

The equivalent JavaScript callback is the global function voGWTConfig.s_gwt_stage_Stage_initFrom. It may be defined in the gwt.js configuration script, for example.

Specified by:

initFrom in interface TheatreInitializer

_rPending - whether the referrer (if any) remains to be resolved. If this flag is true, then initialization will eventually complete at initUltimately; otherwise it will complete earlier at initFromComplete.

initFromComplete

public void initFromComplete(Stage _s,
                    boolean _rPending)

Description copied from interface: TheatreInitializer

Signals that initFrom was called for all props and that immediate initialization of the stage is complete and the associated events have fired. Referrer resolution may yet follow depending on the value of rPending. This method is called only when the state is initialized by restoration, i.e. in those cases where initFrom is called.

The equivalent JavaScript callback is the global function voGWTConfig.s_gwt_stage_Stage_initFromComplete. It may be defined in the gwt.js configuration script, for example.

Specified by:

initFromComplete in interface TheatreInitializer

_rPending - true if initialization will eventually complete at initUltimately; false if this is the end of it.

initTo

public void initTo(Stage _s)

Description copied from interface: TheatreInitializer

Here the prop or other component initializes the properties of the stage. This method is called on page load when a new page is created from scratch and the referrer (if any) cannot immediately be resolved. Referrer resolution will be signaled by a subsequent call to initUltimately.

The equivalent JavaScript callback is the global function voGWTConfig.s_gwt_stage_Stage_initTo. It may be defined in the gwt.js configuration script, for example.

Specified by:

initTo in interface TheatreInitializer

initTo

public void initTo(Stage _s,
          TheatrePage _r)

Description copied from interface: TheatreInitializer

Here the prop or other component initializes the properties of the stage. This method is called on page load when a new page is created from scratch and the referrer (if any) can immediately be resolved. Referrer resolution enables cross-page persistence. As a general rule, a prop may transfer state from the referrer to the stage if it also provides the user with both control over that state and the ability to restore it. Thus the user might transit a link from one page (referrer) in which a difference is shown, for example, to a new page (destination) where the same difference is automatically selected by a prop that makes use of the r parameter. The prop will also provide a means of selecting other differences and of re-selecting the original one, such that the user need never navigate back and re-transit the link for this purpose.

A prop ought generally to avoid transferring a given property from a referrer when it already has a non-default value on the destination, whether set by the scene or by another prop. By the same token, an initializer that sets a default value for a property, such as actor name, will typically null the ordinary value to ensure that the default is immediately exhibited. It is recommended however that defaults be set earlier, e.g. during module initialization.

The equivalent JavaScript callback is the global function voGWTConfig.s_gwt_stage_Stage_initTo. It may be defined in the gwt.js configuration script, for example.

Specified by:

initTo in interface TheatreInitializer

_r - the theatre page that linked to this page (referrer), or null if there was none.

initToComplete

public void initToComplete(Stage _s,
                  boolean _rPending)

Description copied from interface: TheatreInitializer

Signals that initTo was called for all props and that immediate initialization of the stage is complete and the associated events have fired. Referrer resolution may yet follow depending on the value of rPending. This method is called only when the state is initialized from scratch, i.e. in those cases where initTo is called.

The equivalent JavaScript callback is the global function voGWTConfig.s_gwt_stage_Stage_initToComplete. It may be defined in the gwt.js configuration script, for example.

Specified by:

initToComplete in interface TheatreInitializer

_rPending - true if initialization will eventually complete at initUltimately; false if this is the end of it.

initUltimately

public void initUltimately(Stage _s,
                  TheatrePage _r)

Description copied from interface: TheatreInitializer

Signals that deferred resolution of the referrer is now complete. This method is called last of all, and only if rPending was asserted in one of the previous initialization calls. Resolution is never deferred longer than 5000 milliseconds.

The equivalent JavaScript callback is the global function voGWTConfig.s_gwt_stage_Stage_initUltimately. It may be defined in the gwt.js configuration script, for example.

Specified by:

initUltimately in interface TheatreInitializer

_r - the theatre page that linked to this page (referrer), or null if there was none. The prop may transfer state from the referrer as noted for initTo(stage,referrer), but with the further stipulation that any state changes by the user subsequent to the completion of immediate initialization ought to be honoured and not overidden.