gwt.material.design.client.base

Class AbstractSideNav

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.base.AbstractSideNav

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, 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, HasAllDragAndDropHandlers, HasBorder, HasCenterOn, HasCircle, HasColors, HasDataAttributes, HasDepth, HasDimension, HasDraggableHandlers, HasDroppableHandlers, HasFlexbox, HasFloat, HasFontSize, HasFontWeight, HasGrid, HasHideOn, HasHoverable, HasId, HasInitialClasses, HasInlineStyle, HasInOutDurationTransition, HasInteractionHandlers, HasOpacity, HasOrientation, HasOrientationChangeHandler, HasReload, HasScrollspy, HasSelectables, HasSeparator, HasShadow, HasShowOn, HasSideNavHandlers, HasTextAlign, HasTooltip, HasTransform, HasVerticalAlign, HasWaves, JsLoader, Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

MaterialSideNav, MaterialSideNavCard, MaterialSideNavDrawer, MaterialSideNavMini, MaterialSideNavPush

public abstract class AbstractSideNav
extends MaterialWidget
implements JsLoader, HasSelectables, HasInOutDurationTransition, HasSideNavHandlers

AbstractSideNav handles the creation and Ui logic for different sidenavs, you can easily setup any kind of logic for you sidenav behaviour in setup().

Author:

kevzlou7979

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

Modifier and Type	Field and Description
protected com.google.gwt.dom.client.Element	activator
protected boolean	allowBodyScroll
protected boolean	alwaysShowActivator
protected boolean	closeOnClick
protected Edge	edge
protected int	inDuration
protected boolean	open
protected int	outDuration
protected Boolean	showOnAttach
protected int	width

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

$this

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractSideNav()
AbstractSideNav(SideNavType type)
AbstractSideNav(com.google.gwt.user.client.ui.Widget... widgets)

Method Summary

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget child)
com.google.gwt.event.shared.HandlerRegistration	addClosedHandler(SideNavClosedEvent.SideNavClosedHandler handler) This handler will be triggered when the side nav is closed.
com.google.gwt.event.shared.HandlerRegistration	addClosingHandler(SideNavClosingEvent.SideNavClosingHandler handler) This handler will be triggered when the side nav starts closing.
com.google.gwt.event.shared.HandlerRegistration	addOpenedHandler(SideNavOpenedEvent.SideNavOpenedHandler handler) This handler will be triggered when the side nav is opened.
com.google.gwt.event.shared.HandlerRegistration	addOpeningHandler(SideNavOpeningEvent.SideNavOpeningHandler handler) This handler will be triggered when the side nav starts opening.
protected void	applyBodyScroll()
protected void	applyTransition(com.google.gwt.dom.client.Element element)
protected void	applyTransition(com.google.gwt.dom.client.Element element, String property)
void	clearActive()
com.google.gwt.dom.client.Element	getActivator()
Edge	getEdge()
protected com.google.gwt.dom.client.Element	getFooter()
protected com.google.gwt.dom.client.Element	getHeader()
int	getInDuration() Get the in / enter animation duration in milliseconds.
protected com.google.gwt.dom.client.Element	getMain()
protected MaterialWidget	getNavMenu()
int	getOutDuration() Get the out / exit animation duration in milliseconds.
protected StyleMixin<MaterialSideNav>	getTypeMixin()
int	getWidth()
void	hide() Hide the sidenav using the activator element
void	hideOverlay() Hide the overlay menu.
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	isOpen()
boolean	isShowOnAttach() Will the menu forcefully show on attachment.
protected boolean	isSmall()
void	load()
protected void	load(boolean strict)
protected void	onAttach()
protected void	onClosed()
protected void	onClosing()
protected void	onDetach()
protected void	onLoad()
protected void	onOpened()
protected void	onOpening()
protected void	onUnload()
protected void	pushElement(com.google.gwt.dom.client.Element element, int value)
protected void	pushElementMargin(com.google.gwt.dom.client.Element element, int value)
void	reload() Reinitialize the side nav configurations when changing properties.
void	setActive(int index)
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	setEnabled(boolean enabled)
void	setInDuration(int inDuration) Set the in / enter animation duration in milliseconds.
void	setOutDuration(int outDuration) Set the out / exit animation duration in milliseconds.
void	setShowOnAttach(boolean showOnAttach) Show the menu upon attachment. Note that you shouldn't apply this setting if you want your side nav to appear static.
protected void	setType(SideNavType type)
protected abstract void	setup() Override the type of your sidenav.
void	setWidth(int width) Set the menu's width in pixels.
void	setWidth(String width)
void	show() Show the sidenav using the activator element
void	unload()
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

$this, add, addAttachHandler, addBlurHandler, addClickHandler, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragLeaveHandler, addDragMoveHandler, addDragOverHandler, addDragStartHandler, addDropActivateHandler, addDropDeactivateHandler, addDropHandler, addFocusHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addOrientationChangeHandler, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, body, clearActiveClass, enableFeature, getBackfaceVisibility, getBackgroundColor, getBorder, getBorderBottom, getBorderLeft, getBorderMixin, getBorderRadius, getBorderRight, getBorderTop, getCenterOn, getCenterOnMixin, getChildren, getChildrenList, getCircleMixin, getColorsMixin, getDataAttribute, getDepth, getDimensionMixin, getEnabledMixin, getFlexboxMixin, getFloat, getFloatMixin, getFocusableMixin, getFontSize, getFontSizeMixin, getFontWeight, getFontWeightMixin, getGridMixin, getHandlerRegistry, getHideOn, getHideOnMixin, getHoverableMixin, getId, getIdMixin, getInitialClasses, getLayoutPosition, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpacity, getOrientation, getOrientationMixin, getPerspective, getPerspectiveOrigin, getScrollspy, getScrollspyMixin, getSeparatorMixin, getShadow, getShadowMixin, getShowOn, getShowOnMixin, getTabIndex, getTextAlign, getTextAlignMixin, getTextColor, getTooltip, getTooltipDelayMs, getTooltipHTML, getTooltipMixin, getTooltipPosition, getTransform, getTransformMixin, getTransformOrigin, getTransformStyle, getTruncateMixin, getVerticalAlign, getVerticalAlignMixin, getWaves, getWavesMixin, insert, isCircle, isDetectOrientation, isEnabled, isFeatureEnabled, isHoverable, isSeparator, isTruncate, registerHandler, removeHandler, setAccessKey, setBackfaceVisibility, setBackgroundColor, setBorder, setBorderBottom, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBottom, setCenterOn, setCircle, setClass, setDataAttribute, setDepth, setDetectOrientation, setDisplay, setFlex, setFlexAlignContent, setFlexAlignItems, setFlexAlignSelf, setFlexBasis, setFlexDirection, setFlexGrow, setFlexJustifyContent, setFlexOrder, setFlexShrink, setFlexWrap, setFloat, setFocus, setFontSize, setFontSize, setFontWeight, setGrid, setGwtDisplay, setHideOn, setHoverable, setId, setInitialClasses, setLayoutPosition, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOffset, setOpacity, setOrientation, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPerspective, setPerspectiveOrigin, setRight, setScrollspy, setSeparator, setShadow, setShowOn, setStyle, setTabIndex, setTextAlign, setTextColor, setTooltip, setTooltipDelayMs, setTooltipHTML, setTooltipPosition, setTop, setTransform, setTransformOrigin, setTransformStyle, setTransition, setTruncate, setVerticalAlign, setVisibility, setWaves, stopTouchStartEvent, validate, window

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, 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, onBrowserEvent, 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 com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

width

protected int width

inDuration

protected int inDuration

outDuration

protected int outDuration

open

protected boolean open

closeOnClick

protected boolean closeOnClick

alwaysShowActivator

protected boolean alwaysShowActivator

allowBodyScroll

protected boolean allowBodyScroll

edge

protected Edge edge

showOnAttach

protected Boolean showOnAttach

activator

protected com.google.gwt.dom.client.Element activator

Constructor Detail

AbstractSideNav

public AbstractSideNav()

AbstractSideNav

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

AbstractSideNav

public AbstractSideNav(SideNavType type)

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class MaterialWidget

onUnload

protected void onUnload()

Overrides:

onUnload in class MaterialWidget

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

pushElement

protected void pushElement(com.google.gwt.dom.client.Element element,
                           int value)

pushElementMargin

protected void pushElementMargin(com.google.gwt.dom.client.Element element,
                                 int value)

applyBodyScroll

protected void applyBodyScroll()

applyTransition

protected void applyTransition(com.google.gwt.dom.client.Element element)

applyTransition

protected void applyTransition(com.google.gwt.dom.client.Element element,
                               String property)

clearActive

public void clearActive()

Specified by:

clearActive in interface HasSelectables

setActive

public void setActive(int index)

load

public void load()

Specified by:

load in interface JsLoader

unload

public void unload()

Specified by:

unload in interface JsLoader

reload

public void reload()

Reinitialize the side nav configurations when changing properties.

Specified by:

reload in interface HasReload

load

protected void load(boolean strict)

setup

protected abstract void setup()

Override the type of your sidenav. Used by MaterialSideNavDrawer, MaterialSideNavCard, MaterialSideNavMini, MaterialSideNavPush

onDetach

protected void onDetach()

Overrides:

onDetach in class com.google.gwt.user.client.ui.Widget

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.Widget

getMain

protected com.google.gwt.dom.client.Element getMain()

getHeader

protected com.google.gwt.dom.client.Element getHeader()

getFooter

protected com.google.gwt.dom.client.Element getFooter()

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.

setType

protected void setType(SideNavType type)

isSmall

protected boolean isSmall()

getNavMenu

protected MaterialWidget getNavMenu()

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

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.
Note that you shouldn't apply this setting if you want your side nav to appear static. otherwise when set to true will slide in from the left.

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

setEnabled in class MaterialWidget

setInDuration

public void setInDuration(int inDuration)

Description copied from interface: HasInOutDurationTransition

Set the in / enter animation duration in milliseconds.

Specified by:

setInDuration in interface HasInOutDurationTransition

getInDuration

public int getInDuration()

Description copied from interface: HasInOutDurationTransition

Get the in / enter animation duration in milliseconds.

Specified by:

getInDuration in interface HasInOutDurationTransition

setOutDuration

public void setOutDuration(int outDuration)

Description copied from interface: HasInOutDurationTransition

Set the out / exit animation duration in milliseconds.

Specified by:

setOutDuration in interface HasInOutDurationTransition

getOutDuration

public int getOutDuration()

Description copied from interface: HasInOutDurationTransition

Get the out / exit animation duration in milliseconds.

Specified by:

getOutDuration in interface HasInOutDurationTransition

getActivator

public com.google.gwt.dom.client.Element getActivator()

addOpeningHandler

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

Description copied from interface: HasSideNavHandlers

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

Specified by:

addOpeningHandler in interface HasSideNavHandlers

addOpenedHandler

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

Description copied from interface: HasSideNavHandlers

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

Specified by:

addOpenedHandler in interface HasSideNavHandlers

addClosingHandler

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

Description copied from interface: HasSideNavHandlers

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

Specified by:

addClosingHandler in interface HasSideNavHandlers

addClosedHandler

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

Description copied from interface: HasSideNavHandlers

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

Specified by:

addClosedHandler in interface HasSideNavHandlers

getTypeMixin

protected StyleMixin<MaterialSideNav> getTypeMixin()