gwt.material.design.client.ui

Class MaterialModal

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.MaterialModal

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.HasCloseHandlers<MaterialModal>, com.google.gwt.event.logical.shared.HasOpenHandlers<MaterialModal>, 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, HasDismissible, HasDraggableHandlers, HasDroppableHandlers, HasFlexbox, HasFloat, HasFontSize, HasFontWeight, HasFullscreen, HasGrid, HasHideOn, HasHoverable, HasId, HasInitialClasses, HasInlineStyle, HasInOutDurationTransition, HasInteractionHandlers, HasOpacity, HasOrientation, HasOrientationChangeHandler, HasScrollspy, HasSeparator, HasShadow, HasShowOn, HasTextAlign, HasTooltip, HasTransform, HasType<ModalType>, HasVerticalAlign, HasWaves, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialModal
extends MaterialWidget
implements HasType<ModalType>, HasInOutDurationTransition, HasDismissible, com.google.gwt.event.logical.shared.HasCloseHandlers<MaterialModal>, com.google.gwt.event.logical.shared.HasOpenHandlers<MaterialModal>, HasFullscreen

Dialogs are content that are not original visible on a page but show up with extra information if needed. The transitions should make the appearance of the dialog make sense and not jarring to the user.

UiBinder Usage:

 
 <m:MaterialModal ui:field="modal" type="FIXED_FOOTER" dismissible="true" inDuration="500" outDuration="800">
     <m:MaterialModalContent>
         <m:MaterialTitle title="Title" description="Description" />
     </m:MaterialModalContent>
     <m:MaterialModalFooter>
         <m:MaterialButton text="Close Modal" type="FLAT"/>
     </m:MaterialModalFooter>
 </m:MaterialModal>
 
 

*

Java Usage:

 {
     @code
     @UiField
     MaterialModal modal;
     modal.open();
 }
 

Author:

kevzlou7979, Ben Dol

See Also:

Material Modals, 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
MaterialModal()

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<MaterialModal> handler)
com.google.gwt.event.shared.HandlerRegistration	addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<MaterialModal> handler)
void	close() Close the modal programmatically.
void	close(boolean autoClosed) Close the modal programmatically.
void	close(boolean autoClosed, boolean fireEvent) Close the modal programmatically.
protected void	close(com.google.gwt.dom.client.Element e, boolean autoClosed, boolean fireEvent)
protected FullscreenMixin	getFullscreenMixin()
int	getInDuration() Get the in / enter animation duration in milliseconds.
double	getOpacity()
int	getOutDuration() Get the out / exit animation duration in milliseconds.
ModalType	getType() Gets the type of the widget.
protected CssTypeMixin<ModalType,MaterialModal>	getTypeMixin()
boolean	isDismissible()
boolean	isFullscreen()
protected void	onNativeClose(boolean autoClosed, boolean fireEvent)
protected void	onNativeOpen(boolean fireEvent)
void	open() Open the modal programmatically
void	open(boolean fireEvent) Open the modal programmatically
protected void	open(com.google.gwt.dom.client.Element e, boolean fireEvent) Open modal with additional properties
void	setDismissible(boolean dismissible) Set dismissible when swiping left / right.
void	setEnabled(boolean enabled)
void	setFullscreen(boolean value)
void	setInDuration(int inDuration) Set the in / enter animation duration in milliseconds.
void	setOpacity(double opacity)
void	setOutDuration(int outDuration) Set the out / exit animation duration in milliseconds.
void	setType(ModalType type) Sets the type on the widget

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

$this, add, 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, 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, onLoad, onUnload, 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, 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

MaterialModal

public MaterialModal()

Method Detail

setType

public void setType(ModalType type)

Description copied from interface: HasType

Sets the type on the widget

Specified by:

setType in interface HasType<ModalType>

Parameters:

type - T type

getType

public ModalType getType()

Description copied from interface: HasType

Gets the type of the widget.

Specified by:

getType in interface HasType<ModalType>

Returns:

type of the widget

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

setDismissible

public void setDismissible(boolean dismissible)

Description copied from interface: HasDismissible

Set dismissible when swiping left / right.

Specified by:

setDismissible in interface HasDismissible

isDismissible

public boolean isDismissible()

Specified by:

isDismissible in interface HasDismissible

setOpacity

public void setOpacity(double opacity)

Specified by:

setOpacity in interface HasOpacity

Overrides:

setOpacity in class MaterialWidget

getOpacity

public double getOpacity()

Specified by:

getOpacity in interface HasOpacity

Overrides:

getOpacity in class MaterialWidget

setEnabled

public void setEnabled(boolean enabled)

Specified by:

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

Overrides:

setEnabled in class MaterialWidget

setFullscreen

public void setFullscreen(boolean value)

Specified by:

setFullscreen in interface HasFullscreen

isFullscreen

public boolean isFullscreen()

Specified by:

isFullscreen in interface HasFullscreen

open

public void open()

Open the modal programmatically

Note: the MaterialModal component must be added to the document before calling this method. When declaring this modal on a UiBinder file, the MaterialModal is already added, but if you call it using pure Java, you must add it to a container before opening the modal. You can do it by calling, for example:

 MaterialModal modal = new MaterialModal();
 RootPanel.get().add(modal);
 

Throws:

IllegalStateException - If the MaterialModal is not added to the document

open

public void open(boolean fireEvent)

Open the modal programmatically

Note: the MaterialModal component must be added to the document before calling this method. When declaring this modal on a UiBinder file, the MaterialModal is already added, but if you call it using pure Java, you must add it to a container before opening the modal. You can do it by calling, for example:

 MaterialModal modal = new MaterialModal();
 RootPanel.get().add(modal);
 

Parameters:

fireEvent - - Flag whether this component fires Open Event

Throws:

IllegalStateException - If the MaterialModal is not added to the document

open

protected void open(com.google.gwt.dom.client.Element e,
                    boolean fireEvent)

Open modal with additional properties

Parameters:

e - - Modal Component

fireEvent - - Flag whether this component fires Open Event

onNativeOpen

protected void onNativeOpen(boolean fireEvent)

onNativeClose

protected void onNativeClose(boolean autoClosed,
                             boolean fireEvent)

close

public void close()

Close the modal programmatically. It is the same as calling close(boolean) with false as parameter.

Note: you may need to remove it MaterialModal from the document if you are not using UiBinder. See open().

close

public void close(boolean autoClosed)

Close the modal programmatically.

Note: you may need to remove it MaterialModal from the document if you are not using UiBinder. See open().

Parameters:

autoClosed - Flag indicating if the modal was automatically dismissed

See Also:

CloseEvent

close

public void close(boolean autoClosed,
                  boolean fireEvent)

Close the modal programmatically.

Note: you may need to remove it MaterialModal from the document if you are not using UiBinder. See open().

Parameters:

autoClosed - Flag indicating if the modal was automatically dismissed

fireEvent - Flag whether this component fires Close Event

See Also:

CloseEvent

close

protected void close(com.google.gwt.dom.client.Element e,
                     boolean autoClosed,
                     boolean fireEvent)

addCloseHandler

public com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<MaterialModal> handler)

Specified by:

addCloseHandler in interface com.google.gwt.event.logical.shared.HasCloseHandlers<MaterialModal>

addOpenHandler

public com.google.gwt.event.shared.HandlerRegistration addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<MaterialModal> handler)

Specified by:

addOpenHandler in interface com.google.gwt.event.logical.shared.HasOpenHandlers<MaterialModal>

getTypeMixin

protected CssTypeMixin<ModalType,MaterialModal> getTypeMixin()

getFullscreenMixin

protected FullscreenMixin getFullscreenMixin()