package votorola.s.gwt.stage; // Copyright 2011-2013, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import votorola.a.web.gwt.*;
import com.google.gwt.user.client.ui.RootPanel;


/** The GWT entry module for embedding the stage in a non-GWT web page.  An instance of
  * this class is automatically constructed and invoked per module definition
  * <a href='../../../../../../s/gwt/stage/StageIn.gwt.xml'>StageIn.gwt.xml</a>.  It
  * constructs a {@linkplain votorola.s.gwt.stage.StageV stage view} and ordinarily
  * inserts it as the first child of the body element, as detailed for {@linkplain
  * #insertStageV() insertStageV}().  To install it, add the following lines as
  * <a href='https://developers.google.com/web-toolkit/doc/latest/DevGuideOrganizingProjects#DevGuideBootstrap' target='_top'>high as possible</a>
  * in the head of the page, substituting the correct
  * value for <var>CONTEXT</var>: (links to working examples are provided farther
  * below)<pre>
  *
  *   &lt;!-- - -
  *    ! Crossforum Theatre stage of Votorola
  *    ! - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  *    ! http://reluk.ca/project/votorola/_/javadoc/votorola/s/gwt/stage/StageIn.html
  *    ! The GWT config script must precede the "nocache.js" boot script.
  *    ! The style sheet must too, or layout may be unstable:
  *    ! http://mail.zelea.com/list/votorola/2012-November/001540.html
  *    ! Following is a standards-compliant downlevel-revealed conditional comment:
  *    --&gt;
  *   &lt;!--[if !IE]&gt;--&gt;
  *       &lt;script src='<var>{@linkplain App#getServletContextLocation() CONTEXT}</var>/w/publicConfig/gwt.js'&gt;&lt;/script&gt;
  *       &lt;link rel='stylesheet' type='text/css' href='<var>{@linkplain App#getServletContextLocation() CONTEXT}</var>/stage/module.css'/&gt;
  *       &lt;script src='<var>{@linkplain App#getServletContextLocation() CONTEXT}</var>/votorola.s.gwt.stage.StageIn/votorola.s.gwt.stage.StageIn.nocache.js'&gt;&lt;/script&gt;
  *       &lt;!--&lt;![endif]--&gt;</pre>
  *
  *
  * <h3>Working examples</h3>
  *
  * <li><a href='http://reluk.ca/project/votorola/home.html' target='_top'>project/votorola/home.html</a></li>
  * <li><a href='http://havoc.zelea.com/system/host/havoc/etc/apache2/modules.d/50_mailman.conf'>apache2/modules.d/50_mailman.conf</a></li>
  */
public final class StageIn implements EntryPointS
{


    /** Constructs a {@linkplain StageV stage view} and inserts it as the first child of
      * {@code <ELEMENT id='stageTopHolder'/>}, where ELEMENT denotes any type of HTML
      * element.  If no element with that ID exists, then the document's body element is
      * used instead.  You must subsequently call StageV.i().{@linkplain
      * StageV#initEmbeddedDisplay() initEmbeddedDisplay}() to actually display it.
      */
    public static void insertStageV()
    {
        RootPanel parent = RootPanel.get( "stageTopHolder" );
        if( parent == null ) parent = RootPanel.get();
        parent.insert( new StageV( /*toDisplay*/false ), 0 );
    }



   // - E n t r y - P o i n t ------------------------------------------------------------


    public void onModuleLoad()
    {
        insertStageV();
        EntryPointS.U.schedule( StageIn.this );
        EntryPointS.U.execute();
    }



   // - S c h e d u l e r . S c h e d u l e d - C o m m a n d ----------------------------


    public void execute() { StageV.i().initEmbeddedDisplay(); }


}