gwt.material.design.client.ui

Class MaterialSideNav

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

gwt.material.design.client.base.MaterialWidget

gwt.material.design.client.ui.MaterialSideNav

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, HasCenterOn, HasCircle, HasColors, HasDataAttributes, HasDepth, HasFlexbox, HasFloat, HasFontSize, HasFontWeight, HasGrid, HasHideOn, HasHoverable, HasId, HasInitialClasses, HasInlineStyle, HasOpacity, HasScrollspy, HasSelectables, HasSeparator, HasShadow, HasShowOn, HasTextAlign, HasTooltip, HasType<SideNavType>, HasWaves, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialSideNav
extends MaterialWidget
implements HasType<SideNavType>, HasSelectables

SideNav is a material component that gives you a lists of menus and other navigation components.

UiBinder Usage:

 
 <m:MaterialSideNav ui:field="sideNav" width="280" m:id="mysidebar"  type="OPEN" closeOnClick="false">
     <m:MaterialLink href="#about" iconPosition="LEFT" iconType="OUTLINE" text="About" textColor="blue"  />
     <m:MaterialLink href="#gettingStarted" iconPosition="LEFT" iconType="DOWNLOAD" text="Getting Started" textColor="blue"  >
 </m:MaterialSideNav>
 
 

Author:

kevzlou7979, Ben Dol

See Also:

Material SideNav

Nested Class Summary

Nested classes/interfaces inherited from class gwt.material.design.client.base.MaterialWidget

MaterialWidget.Feature

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
MaterialSideNav() Container for App Toolbar and App Sidebar , contains Material Links, Icons or any other material components.
MaterialSideNav(SideNavType type)
MaterialSideNav(com.google.gwt.user.client.ui.Widget... widgets) Creates a list and adds the given widgets.

Method Summary

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget child)
com.google.web.bindery.event.shared.HandlerRegistration	addClosedHandler(SideNavClosedEvent.SideNavClosedHandler handler) This handler will be triggered when the side nav is closed.
com.google.web.bindery.event.shared.HandlerRegistration	addClosingHandler(SideNavClosingEvent.SideNavClosingHandler handler) This handler will be triggered when the side nav starts closing.
com.google.web.bindery.event.shared.HandlerRegistration	addOpenedHandler(SideNavOpenedEvent.SideNavOpenedHandler handler) This handler will be triggered when the side nav is opened.
com.google.web.bindery.event.shared.HandlerRegistration	addOpeningHandler(SideNavOpeningEvent.SideNavOpeningHandler handler) This handler will be triggered when the side nav starts opening.
protected void	applyPushType(com.google.gwt.dom.client.Element element, com.google.gwt.dom.client.Element activator, double width) Push the header, footer, and main to the right part when Close type is applied.
void	clearActive()
Edge	getEdge()
SideNavType	getType() Gets the type of the widget.
int	getWidth()
void	hide() Hide the sidenav using the activator element
protected void	hide(com.google.gwt.dom.client.Element e) Hide the sidenav.
void	hideOverlay() Hide the overlay menu.
protected void	initialize()
protected void	initialize(boolean strict)
protected void	initialize(com.google.gwt.dom.client.Element e, int width, boolean closeOnClick, String edge)
protected void	insert(com.google.gwt.user.client.ui.Widget child, com.google.gwt.user.client.Element container, int beforeIndex, boolean domInsert)
boolean	isAllowBodyScroll() Will the body have scroll capability while the menu is open.
boolean	isAlwaysShowActivator() Will the activator always be shown.
boolean	isCloseOnClick()
boolean	isFixed()
boolean	isOpen()
boolean	isShowOnAttach() Will the menu forcefully show on attachment.
protected boolean	isSmall()
protected void	onClosed()
protected void	onClosing()
void	onLoad()
protected void	onOpened()
protected void	onOpening()
protected void	onPush(boolean toggle, int width, int duration)
protected void	processType(SideNavType type)
protected void	pushElements(boolean toggle, int width)
void	reinitialize() reinitialize the side nav configurations when changing properties.
void	setAllowBodyScroll(boolean allowBodyScroll) Allow the body to maintain its scroll capability while the menu is visible.
void	setAlwaysShowActivator(boolean alwaysShowActivator) Disable the hiding of your activator element.
void	setCloseOnClick(boolean closeOnClick) Close the side nav menu when an \ tag is clicked from inside it.
void	setEdge(Edge edge) Set which edge of the window the menu should attach to.
void	setFixed(boolean fixed) Fixed determines its display state on loading (fixed being visible on load).
void	setShowOnAttach(boolean showOnAttach) Show the menu upon attachment, this isn't always required.
void	setType(SideNavType type) Define the menu's type specification.
void	setWidth(int width) Set the menu's width in pixels.
void	setWidth(String width)
void	show() Show the sidenav using the activator element
protected void	show(com.google.gwt.dom.client.Element e) Show the sidenav.
com.google.gwt.user.client.ui.Widget	wrap(com.google.gwt.user.client.ui.Widget child)

Methods inherited from class gwt.material.design.client.base.MaterialWidget

add, clearActiveClass, enableFeature, getBackgroundColor, getCenterOn, getCenterOnMixin, getCircleMixin, getColorsMixin, getDataAttribute, getDepth, getEnabledMixin, getFlexboxMixin, getFloat, getFloatMixin, getFocusableMixin, getFontSize, getFontSizeMixin, getFontWeight, getFontWeightMixin, getGridMixin, getHideOn, getHideOnMixin, getHoverableMixin, getId, getIdMixin, getInitialClasses, getOpacity, getScrollspy, getScrollspyMixin, getSeparatorMixin, getShadow, getShadowMixin, getShowOn, getShowOnMixin, getTabIndex, getTextAlign, getTextAlignMixin, getTextColor, getTooltip, getTooltipDelayMs, getTooltipMixin, getTooltipPosition, getTruncateMixin, getWaves, getWavesMixin, getWidth, insert, isCircle, isEnabled, isFeatureEnabled, isHoverable, isSeparator, setAccessKey, setBackgroundColor, setBottom, setCenterOn, setCircle, setDataAttribute, setDepth, setDisplay, setEnabled, setFlex, setFlexAlignContent, setFlexAlignItems, setFlexAlignSelf, setFlexBasis, setFlexDirection, setFlexGrow, setFlexJustifyContent, setFlexOrder, setFlexShrink, setFlexWrap, setFloat, setFocus, setFontSize, setFontSize, setFontWeight, setGrid, setGwtDisplay, setHideOn, setHoverable, setId, setInitialClasses, setLayoutPosition, setLeft, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setOffset, setOpacity, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setRight, setScrollspy, setSeparator, setShadow, setShowOn, setTabIndex, setTextAlign, setTextColor, setTooltip, setTooltipDelayMs, setTooltipPosition, setTop, setTruncate, setVisibility, setWaves, stopTouchStartEvent, stopTouchStartEvent

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface gwt.material.design.client.base.HasFlexbox

setVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MaterialSideNav

public MaterialSideNav()

Container for App Toolbar and App Sidebar , contains Material Links, Icons or any other material components.

MaterialSideNav

public MaterialSideNav(com.google.gwt.user.client.ui.Widget... widgets)

Creates a list and adds the given widgets.

MaterialSideNav

@UiConstructor
public MaterialSideNav(SideNavType type)

Method Detail

onLoad

public void onLoad()

Overrides:

onLoad in class MaterialWidget

addOpeningHandler

public com.google.web.bindery.event.shared.HandlerRegistration addOpeningHandler(SideNavOpeningEvent.SideNavOpeningHandler handler)

This handler will be triggered when the side nav starts opening.

addOpenedHandler

public com.google.web.bindery.event.shared.HandlerRegistration addOpenedHandler(SideNavOpenedEvent.SideNavOpenedHandler handler)

This handler will be triggered when the side nav is opened.

addClosingHandler

public com.google.web.bindery.event.shared.HandlerRegistration addClosingHandler(SideNavClosingEvent.SideNavClosingHandler handler)

This handler will be triggered when the side nav starts closing.

addClosedHandler

public com.google.web.bindery.event.shared.HandlerRegistration addClosedHandler(SideNavClosedEvent.SideNavClosedHandler handler)

This handler will be triggered when the side nav is closed.

wrap

public com.google.gwt.user.client.ui.Widget wrap(com.google.gwt.user.client.ui.Widget child)

add

public void add(com.google.gwt.user.client.ui.Widget child)

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

add in class MaterialWidget

insert

protected void insert(com.google.gwt.user.client.ui.Widget child,
                      com.google.gwt.user.client.Element container,
                      int beforeIndex,
                      boolean domInsert)

Overrides:

insert in class MaterialWidget

setWidth

public void setWidth(String width)

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

setWidth

public void setWidth(int width)

Set the menu's width in pixels.

getWidth

public int getWidth()

Overrides:

getWidth in class MaterialWidget

isCloseOnClick

public boolean isCloseOnClick()

setCloseOnClick

public void setCloseOnClick(boolean closeOnClick)

Close the side nav menu when an \ tag is clicked from inside it. Note that if you want this to work you must wrap your item within a MaterialLink.

getEdge

public Edge getEdge()

setEdge

public void setEdge(Edge edge)

Set which edge of the window the menu should attach to.

isFixed

public boolean isFixed()

setFixed

public void setFixed(boolean fixed)

Fixed determines its display state on loading (fixed being visible on load).

setType

public void setType(SideNavType type)

Define the menu's type specification.

Specified by:

setType in interface HasType<SideNavType>

Parameters:

type - T type

getType

public SideNavType getType()

Description copied from interface: HasType

Gets the type of the widget.

Specified by:

getType in interface HasType<SideNavType>

Returns:

type of the widget

processType

protected void processType(SideNavType type)

isSmall

protected boolean isSmall()

applyPushType

protected void applyPushType(com.google.gwt.dom.client.Element element,
                             com.google.gwt.dom.client.Element activator,
                             double width)

Push the header, footer, and main to the right part when Close type is applied.

pushElements

protected void pushElements(boolean toggle,
                            int width)

onPush

protected void onPush(boolean toggle,
                      int width,
                      int duration)

clearActive

public void clearActive()

Specified by:

clearActive in interface HasSelectables

reinitialize

public void reinitialize()

reinitialize the side nav configurations when changing properties.

initialize

protected void initialize()

initialize

protected void initialize(boolean strict)

initialize

protected void initialize(com.google.gwt.dom.client.Element e,
                          int width,
                          boolean closeOnClick,
                          String edge)

onClosing

protected void onClosing()

onClosed

protected void onClosed()

onOpening

protected void onOpening()

onOpened

protected void onOpened()

hideOverlay

public void hideOverlay()

Hide the overlay menu.

show

protected void show(com.google.gwt.dom.client.Element e)

Show the sidenav.

hide

protected void hide(com.google.gwt.dom.client.Element e)

Hide the sidenav.

show

public void show()

Show the sidenav using the activator element

hide

public void hide()

Hide the sidenav using the activator element

isOpen

public boolean isOpen()

isAllowBodyScroll

public boolean isAllowBodyScroll()

Will the body have scroll capability while the menu is open.

setAllowBodyScroll

public void setAllowBodyScroll(boolean allowBodyScroll)

Allow the body to maintain its scroll capability while the menu is visible.

isAlwaysShowActivator

public boolean isAlwaysShowActivator()

Will the activator always be shown.

setAlwaysShowActivator

public void setAlwaysShowActivator(boolean alwaysShowActivator)

Disable the hiding of your activator element.

isShowOnAttach

public boolean isShowOnAttach()

Will the menu forcefully show on attachment.

setShowOnAttach

public void setShowOnAttach(boolean showOnAttach)

Show the menu upon attachment, this isn't always required. Some menu types will automatically show themselves by default.