gwt.material.design.client.ui

Class MaterialLoader

java.lang.Object

gwt.material.design.client.ui.MaterialLoader

public class MaterialLoader
extends Object

If you have content that will take a long time to load, you should give the user feedback. For this reason we provide a number activity + progress indicators.

Java Usage:

 

 // FOR CIRCULAR LOADER
 MaterialLoader.showLoading(true);
 // FOR PROGRESS LOADER
 MaterialLoader.showProgress(true);

 // INSTANTIATE THE LOADER COMPONENT
 MaterialLoader loader = new MaterialLoader();
 loader.setContainer(target);
 loader.setType(LoaderType.CIRCULAR);
 loader.setScrollDisabled(true);
 loader.show();
 Timer t = new Timer()
 { @Override
 public void run() {
 loader.hide();
 }
 };
 t.schedule(2000);
 
 

Author:

kevzlou7979, Ben Dol

See Also:

Material Loaders, Material Design Specification }

Constructor Summary

Constructors

Constructor and Description
MaterialLoader()
MaterialLoader(LoaderType type)

Method Summary

Modifier and Type	Method and Description
protected void	build()
com.google.gwt.user.client.ui.Panel	getContainer() Get the Container that wraps the MaterialLoader (Default RootPanel)
LoaderType	getType() Get the type of the MaterialLoader (Default CIRCULAR)
void	hide() Hides the Loader component
boolean	isScrollDisabled() Get the value whether the scroll is enabled or disabled (Default false)
static void	loading(boolean visible) Static helper class that shows / hides a circular loader
static void	loading(boolean visible, com.google.gwt.user.client.ui.Panel container) Static helper class that shows / hides a circular loader within a container
static void	progress(boolean visible) Static helper class that shows / hides a progress loader
static void	progress(boolean visible, com.google.gwt.user.client.ui.Panel container) Static helper class that shows / hides a progress loader within a container
void	setContainer(com.google.gwt.user.client.ui.Panel container) Set the Container of the MaterialLoader
void	setScrollDisabled(boolean scrollDisabled) Set whether the loader will allow a body scroll when it is shown
void	setType(LoaderType type) Set the type of the MaterialLoader
void	show() Shows the Loader component

Methods inherited from class java.lang.Object

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

Constructor Detail

MaterialLoader

public MaterialLoader(LoaderType type)

MaterialLoader

public MaterialLoader()

Method Detail

build

protected void build()

show

public void show()

Shows the Loader component

hide

public void hide()

Hides the Loader component

loading

public static void loading(boolean visible)

Static helper class that shows / hides a circular loader

loading

public static void loading(boolean visible,
                           com.google.gwt.user.client.ui.Panel container)

Static helper class that shows / hides a circular loader within a container

progress

public static void progress(boolean visible)

Static helper class that shows / hides a progress loader

progress

public static void progress(boolean visible,
                            com.google.gwt.user.client.ui.Panel container)

Static helper class that shows / hides a progress loader within a container

getType

public LoaderType getType()

Get the type of the MaterialLoader (Default CIRCULAR)

setType

public void setType(LoaderType type)

Set the type of the MaterialLoader

Parameters:

type - There are two types of Loader (CIRCULAR and PROGRESS)

getContainer

public com.google.gwt.user.client.ui.Panel getContainer()

Get the Container that wraps the MaterialLoader (Default RootPanel)

setContainer

public void setContainer(com.google.gwt.user.client.ui.Panel container)

Set the Container of the MaterialLoader

isScrollDisabled

public boolean isScrollDisabled()

Get the value whether the scroll is enabled or disabled (Default false)

setScrollDisabled

public void setScrollDisabled(boolean scrollDisabled)

Set whether the loader will allow a body scroll when it is shown