gwt.material.design.client.ui

Class MaterialDropDown

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.html.UnorderedList

gwt.material.design.client.ui.MaterialDropDown

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.logical.shared.HasSelectionHandlers<com.google.gwt.user.client.ui.Widget>, 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, HasSeparator, HasShadow, HasShowOn, HasTextAlign, HasTooltip, HasTransform, HasVerticalAlign, HasWaves, JsLoader, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialDropDown
extends UnorderedList
implements JsLoader, com.google.gwt.event.logical.shared.HasSelectionHandlers<com.google.gwt.user.client.ui.Widget>, HasInOutDurationTransition

You can add dropdown easily by specifying it's item content and add a UiHandler on it to implement any event.

UiBinder Usage:

 
 <m:MaterialDropDown>
   <m:MaterialLink text="First" />
   <m:MaterialLink text="Second" />
   <m:MaterialLink text="Third" />
 </m:MaterialDropDown>
 
 

Author:

kevzlou7979, Ben Dol

See Also:

Material DropDown, Material Design Specification

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 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
MaterialDropDown()
MaterialDropDown(com.google.gwt.dom.client.Element activatorElement)
MaterialDropDown(String activator) Add a list item selection when button, link, icon button pressed.
MaterialDropDown(com.google.gwt.user.client.ui.UIObject activator)

Method Summary

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget child)
com.google.gwt.event.shared.HandlerRegistration	addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<com.google.gwt.user.client.ui.Widget> handler)
String	getActivator() Get the unique activator set by material widget e.g links, icons, buttons to trigger the dropdown.
com.google.gwt.dom.client.Element	getActivatorElement()
Alignment	getAlignment()
int	getGutter()
int	getInDuration() Get the in / enter animation duration in milliseconds.
List<com.google.gwt.user.client.ui.Widget>	getItems()
int	getOutDuration() Get the out / exit animation duration in milliseconds.
boolean	isBelowOrigin()
boolean	isConstrainWidth()
boolean	isHover()
void	load()
protected void	onLoad()
protected void	onUnload()
protected void	registerDropdownItemHandlers()
void	reload()
void	setActivator(String activator) Set the unique activator of each dropdown component and it must be unique
void	setAlignment(Alignment alignment) Defines the edge the menu is aligned to.
void	setBelowOrigin(boolean belowOrigin) If true, the dropdown will show below the activator.
void	setConstrainWidth(boolean constrainWidth) If true, constrainWidth to the size of the dropdown activator.
void	setGutter(int gutter) This defines the spacing from the aligned edge.
void	setHover(boolean hover) If true, the dropdown will open on hover.
void	setInDuration(int durationMillis) Set the in / enter animation duration in milliseconds.
void	setOutDuration(int durationMillis) Set the out / exit animation duration in milliseconds.
void	unload()

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, getWidth, insert, 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, 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, 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, onAttach, onBrowserEvent, onDetach, 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, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

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

setVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MaterialDropDown

public MaterialDropDown()

MaterialDropDown

@UiConstructor
public MaterialDropDown(String activator)

Add a list item selection when button, link, icon button pressed.

Parameters:

activator - data-activates attribute name of your dropdown activator.

MaterialDropDown

public MaterialDropDown(com.google.gwt.dom.client.Element activatorElement)

MaterialDropDown

public MaterialDropDown(com.google.gwt.user.client.ui.UIObject activator)

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class MaterialWidget

registerDropdownItemHandlers

protected void registerDropdownItemHandlers()

onUnload

protected void onUnload()

Overrides:

onUnload in class MaterialWidget

load

public void load()

Specified by:

load in interface JsLoader

unload

public void unload()

Specified by:

unload in interface JsLoader

reload

public void reload()

Specified by:

reload in interface HasReload

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 UnorderedList

setInDuration

public void setInDuration(int durationMillis)

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 durationMillis)

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

setConstrainWidth

public void setConstrainWidth(boolean constrainWidth)

If true, constrainWidth to the size of the dropdown activator. Default: true

isConstrainWidth

public boolean isConstrainWidth()

setHover

public void setHover(boolean hover)

If true, the dropdown will open on hover. Default: false

isHover

public boolean isHover()

setGutter

public void setGutter(int gutter)

This defines the spacing from the aligned edge. Default: 0

getGutter

public int getGutter()

setBelowOrigin

public void setBelowOrigin(boolean belowOrigin)

If true, the dropdown will show below the activator. Default: false

isBelowOrigin

public boolean isBelowOrigin()

setAlignment

public void setAlignment(Alignment alignment)

Defines the edge the menu is aligned to. Default: 'left'

getAlignment

public Alignment getAlignment()

getActivator

public String getActivator()

Get the unique activator set by material widget e.g links, icons, buttons to trigger the dropdown.

setActivator

public void setActivator(String activator)

Set the unique activator of each dropdown component and it must be unique

getItems

public List<com.google.gwt.user.client.ui.Widget> getItems()

getActivatorElement

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

addSelectionHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<com.google.gwt.user.client.ui.Widget> handler)

Specified by:

addSelectionHandler in interface com.google.gwt.event.logical.shared.HasSelectionHandlers<com.google.gwt.user.client.ui.Widget>