gwt.material.design.client.ui.MaterialSplashScreen Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * GwtMaterial
 * %%
 * Copyright (C) 2015 - 2017 GwtMaterialDesign
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package gwt.material.design.client.ui;

import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Style;
import com.google.gwt.user.client.ui.Widget;
import gwt.material.design.client.base.MaterialWidget;
import gwt.material.design.client.constants.CssName;
import gwt.material.design.client.constants.Display;
import gwt.material.design.client.ui.html.Div;

//@formatter:off

/**
 * An initial screen that act as a loading screen
 * in order for your apps to load fully.
 * 
 * 
UiBinder Usage:
 *  * {@code
 *
 * 
 *     
 *     
 * 
 *
 * }
 * Java Usage:
 *  * {@code @UiField MaterialSplashScreen splash;
 * splash.show();
 * Timer t = new Timer()
 *  { @Override
 *     public void run() {
 *         splash.hide();
 *     }
 * };
 * t.schedule(3000);
 * }
 * }
 *
 *
 * @author kevzlou7979
 * @author Ben Dol
 * @see Material Splashscreen
 * @see Material Design Specification
 */
//@formatter:on
public class MaterialSplashScreen extends MaterialWidget {

    private Div container = new Div();
    private MaterialProgress progress = new MaterialProgress();

    public MaterialSplashScreen() {
        super(Document.get().createDivElement(), CssName.SPLASH_SCREEN);
    }

    @Override
    protected void onLoad() {
        setDisplay(Display.NONE);

        container.setWidth("100%");
        container.getElement().getStyle().setMarginTop(15, Style.Unit.PCT);
        super.onLoad();

        super.add(container);
        super.add(progress);
    }

    @Override
    public void add(Widget child) {
        container.add(child);
    }

    public void show() {
        setDisplay(Display.BLOCK);
    }

    public void hide() {
        setDisplay(Display.NONE);
    }

    public Div getContainer() {
        return container;
    }

    public MaterialProgress getProgress() {
        return progress;
    }
}