votorola.s.gwt.stage

Class TheatreInitializerBC

java.lang.Object

TheatreInitializerC

TheatreInitializerBC

All Implemented Interfaces:

TheatreInitializer

public abstract class TheatreInitializerBC
extends TheatreInitializerC

A theatre initializer with handy "init begun" and "init complete" methods.

Constructor Summary

Constructors

Constructor and Description
TheatreInitializerBC()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	initBegun(Stage s) Signals that initFrom or initTo is being called during stage initialization.
void	initFrom(Stage _s, boolean _rPending) Here the prop or other component initializes its own properties by reference to a previously initialized stage.
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.

Methods inherited from class TheatreInitializerC

initComplete, initFromComplete, initToComplete, initUltimately

Methods inherited from class java.lang.Object

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

Constructor Detail

TheatreInitializerBC

public TheatreInitializerBC()

Method Detail

initBegun

public abstract void initBegun(Stage s)

Signals that initFrom or initTo is being called during stage initialization.

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

Overrides:

initFrom in class TheatreInitializerC

_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.

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

Overrides:

initTo in class TheatreInitializerC

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

Overrides:

initTo in class TheatreInitializerC

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