gwt.material.design.client.ui.MaterialPreLoader Maven / Gradle / Ivy
/*
* #%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 gwt.material.design.client.base.HasOverlayStyle;
import gwt.material.design.client.base.MaterialWidget;
import gwt.material.design.client.base.mixin.CssNameMixin;
import gwt.material.design.client.base.mixin.OverlayStyleMixin;
import gwt.material.design.client.constants.CssName;
import gwt.material.design.client.constants.LoaderSize;
import gwt.material.design.client.constants.OverlayOption;
import gwt.material.design.jquery.client.api.JQueryElement;
//@formatter:off
/**
* Material Preloader is a wrapper for Material Spinner which handle multiple flashing circular loaders
*
*
Java Usage:
*
* {@code
*
* MaterialLoader.loading(true);
*
* }
*
* @author kevzlou7979
* @author Ben Dol
* @see Material PreLoader
* @see Material Design Specification
*/
//@formatter:on
public class MaterialPreLoader extends MaterialWidget implements HasOverlayStyle {
private CssNameMixin sizeMixin;
private OverlayStyleMixin overlayStyleMixin;
public MaterialPreLoader() {
super(Document.get().createDivElement(), CssName.PRELOADER_WRAPPER, CssName.ACTIVE);
}
/**
* Sets the size of the pre loader.
*/
public void setSize(LoaderSize size) {
getSizeMixin().setCssName(size);
}
/**
* Same as {@link #setSize(LoaderSize)}, but will not clash with {@link com.google.gwt.user.client.ui.UIObject#setSize(String, String)}
*/
public void setLoaderSize(LoaderSize size) {
setSize(size);
}
public LoaderSize getSize() {
return getSizeMixin().getCssName();
}
public LoaderSize getLoaderSize() {
return getSize();
}
@Override
public void setOverlayOption(OverlayOption overlayOption) {
getOverlayStyleMixin().setOverlayOption(overlayOption);
}
@Override
public OverlayOption getOverlayOption() {
return getOverlayStyleMixin().getOverlayOption();
}
@Override
public void applyOverlayStyle(JQueryElement overlayElement) {
getOverlayStyleMixin().applyOverlayStyle(overlayElement);
}
@Override
public void resetOverlayStyle() {
getOverlayStyleMixin().resetOverlayStyle();
}
protected CssNameMixin getSizeMixin() {
if (sizeMixin == null) {
sizeMixin = new CssNameMixin<>(this);
}
return sizeMixin;
}
protected OverlayStyleMixin getOverlayStyleMixin() {
if (overlayStyleMixin == null) {
overlayStyleMixin = new OverlayStyleMixin(this);
}
return overlayStyleMixin;
}
}