PollwikiIn (Votorola Java API)

java.lang.Object
- TheatreInitializer0
- - PollwikiIn

All Implemented Interfaces:: EntryPoint, Scheduler.ScheduledCommand, EntryPointS, TheatreInitializer

public final class PollwikiIn
extends TheatreInitializer0
implements EntryPointS

The GWT entry module for embedding the Crossforum Theatre stage in pollwiki pages. An instance of this class is automatically constructed and invoked per module definition PollwikiIn.gwt.xml. It constructs a stage view and ordinarily inserts it as the first child of the body element, as detailed for MediaWikiIn.insertStageVTop. To install it add the following to pollwiki page MediaWiki:Common.js:

  // Crossforum Theatre stage.
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // module.css and gwt.js must load before boot script nocache.js
  // http://reluk.ca/project/votorola/_/javadoc/votorola/s/gwt/pollwiki/PollwikiIn.html

    if( $.client.profile().name != 'msie' ) // all but IE [1]
    {
        var context = 'CONTEXT';
        document.write( "<link href='" + context // [2]
          + "/mediawiki/module.css' rel='stylesheet' type='text/css'/>" );
        document.write( "<script src='" + context // [3]
          + "/w/publicConfig/gwt.js' type='text/javascript'></script>" );
        document.write( "<script src='" + context // [3]
          + "/votorola.s.gwt.pollwiki.PollwikiIn/votorola.s.gwt.pollwiki.PollwikiIn.nocache.js'"
          + " type='text/javascript'></script>" );
    }

  //
  // NOTES
  //
  //   [1] IE excluded by conditional compilation in MediaWiki 16 and earlier, thus:
  //
  //          /*@cc_on @if( false ) @*/
  //          /*@end @*/
  //
  //       And by JQuery in MediaWiki 17 and later, thus:
  //
  //          if( $.client.profile().name != 'msie' )
  //
  //   [2] For MediaWiki 16 and earlier, would ordinarily use: importStylesheetURI( URL )
  //       For MediaWiki 17 and later: mw.loader.load( URL, 'text/css' )
  //       http://www.mediawiki.org/wiki/ResourceLoader/Migration_guide_%28users%29
  //
  //       But instead write to ensure CSS link element precedes script element, else layout
  //       may be unstable: http://mail.zelea.com/list/votorola/2012-November/001540.html
  //
  //   [3] Scripts might instead be inject asynchronously using MediaWiki's mw.loader or
  //       importScriptURI.  We are no longer using the old cross-site linker ('xs') that
  //       writes to the document.  But asynchronous injection has not been tested yet.
  //

Working examples

Nested Class Summary
- Nested classes/interfaces inherited from interface EntryPointS
  EntryPointS.U

Constructor Summary

Constructors
Constructor and Description

PollwikiIn()

Constructors
Constructor and Description
`PollwikiIn()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute()` Called after all modules are loaded provided the call was previously scheduled.
`void`	`initFrom(Stage stage, boolean _isReferencePending)` Here the prop or other component initializes its own properties by reference to a previously initialized stage.
`void`	`initTo(Stage stage)` Here the prop or other component initializes the properties of the stage.
`void`	`initTo(Stage stage, TheatrePage _referrer)` Here the prop or other component initializes the properties of the stage.
`void`	`onModuleLoad()` Called first during the load of any module M that declares an `entry-point` in its declaration file `M.gwt.xml`, this method (a) finalizes the configuration of any other modules on which this one depends, and (b) ensures that any views are solidly placed that might affect the position or size of already placed views, such as those of an embedding page or those previously attached by other modules.

Methods inherited from class TheatreInitializer0
initFromComplete, initToComplete, initUltimately

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PollwikiIn
```
public PollwikiIn()
```
- Method Detail
  - onModuleLoad
```
public final void onModuleLoad()
```
    Description copied from interface: EntryPointS
    
    Called first during the load of any module M that declares an entry-point in its declaration file M.gwt.xml, this method (a) finalizes the configuration of any other modules on which this one depends, and (b) ensures that any views are solidly placed that might affect the position or size of already placed views, such as those of an embedding page or those previously attached by other modules. This is to ensure that the page content does not jitter from late attachments. Otherwise this method depends as little as possible on other application modules, as they might not be fully functional yet.
    This method may also (c) schedule the invocation of the execute method.
    
    Specified by:
    
    onModuleLoad in interface EntryPoint
    
    Specified by:
    
    onModuleLoad in interface EntryPointS
  - execute
```
public void execute()
```
    Description copied from interface: EntryPointS
    
    Called after all modules are loaded provided the call was previously scheduled.
    
    Specified by:
    
    execute in interface Scheduler.ScheduledCommand
    
    Specified by:
    
    execute in interface EntryPointS
    
    See Also:
    EntryPointS.onModuleLoad()
  - initFrom
```
public void initFrom(Stage stage,
            boolean _isReferencePending)
```
    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 TheatreInitializer0
    
    _isReferencePending - 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 stage)
```
    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 TheatreInitializer0
  - initTo
```
public void initTo(Stage stage,
          TheatrePage _referrer)
```
    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 TheatreInitializer0
    
    _referrer - the theatre page that linked to this page (referrer), or null if there was none.

Class PollwikiIn

Working examples

Nested Class Summary

Nested classes/interfaces inherited from interface EntryPointS

Constructor Summary

Method Summary

Methods inherited from class TheatreInitializer0

Methods inherited from class java.lang.Object

Constructor Detail

PollwikiIn

Method Detail

onModuleLoad

execute

initFrom

initTo

initTo