001/*
002 * #%L
003 * GwtMaterial
004 * %%
005 * Copyright (C) 2015 - 2017 GwtMaterialDesign
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 * 
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 * 
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package gwt.material.design.client.ui;
021
022import com.google.gwt.core.client.Scheduler;
023import gwt.material.design.client.base.AbstractSideNav;
024import gwt.material.design.client.constants.SideNavType;
025
026//@formatter:off
027
028/**
029 * SideNav is a material component that gives you a lists of menus and other navigation components.
030 * <p>
031 * <h3>UiBinder Usage:</h3>
032 * <pre>
033 * {@code
034 * <m:MaterialSideNav ui:field="sideNav" width="280" m:id="mysidebar"  closeOnClick="false">
035 *     <m:MaterialLink href="#about" iconPosition="LEFT" iconType="OUTLINE" text="About" textColor="BLUE"  />
036 *     <m:MaterialLink href="#gettingStarted" iconPosition="LEFT" iconType="DOWNLOAD" text="Getting Started" textColor="BLUE"  >
037 * </m:MaterialSideNav>
038 * }
039 * </pre>
040 *
041 * @author kevzlou7979
042 * @author Ben Dol
043 * @see <a href="http://gwtmaterialdesign.github.io/gwt-material-demo/#sidenavs">Material SideNav</a>
044 * @see <a href="https://material.io/guidelines/patterns/navigation-drawer.html">Material Design Specification</a>
045 * @see <a href="https://gwtmaterialdesign.github.io/gwt-material-patterns/snapshot/#sidenav_fixed">Pattern</a>
046 */
047//@formatter:on
048public class MaterialSideNav extends AbstractSideNav {
049
050    public MaterialSideNav() {
051        super(SideNavType.FIXED);
052    }
053
054    @Override
055    protected void setup() {
056        applyBodyScroll();
057
058        Scheduler.get().scheduleDeferred(() -> {
059            pushElement(getHeader(), width);
060            pushElement(getMain(), width);
061            pushElement(getFooter(), width);
062        });
063    }
064}