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.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<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, HasCenterOn, HasCircle, HasColors, HasDataAttributes, HasDepth, HasDismissable, HasFlexbox, HasFloat, HasFontSize, HasFontWeight, HasGrid, HasHideOn, HasHoverable, HasId, HasInitialClasses, HasInlineStyle, HasOpacity, HasScrollspy, HasSeparator, HasShadow, HasShowOn, HasTextAlign, HasTooltip, HasTransition, HasType<ModalType>, HasWaves, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialModal
extends MaterialWidget
implements HasType<ModalType>, HasTransition, HasDismissable, com.google.gwt.event.logical.shared.HasCloseHandlers<MaterialModal>

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" dismissable="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.openModal();
 }
 

Author:

kevzlou7979, Ben Dol

See Also:

Material Modals

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
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)
void	closeModal() Close the modal programatically.
void	closeModal(boolean autoClosed) Close the modal programatically.
protected void	closeModal(com.google.gwt.dom.client.Element e, boolean autoClosed)
ModalType	getType() Gets the type of the widget.
boolean	isDismissable()
protected void	onNativeClose(boolean autoClosed)
void	openModal() Open the modal programatically
protected void	openModal(com.google.gwt.dom.client.Element e, double opacity, boolean dismissable, int inDuration, int outDuration) Open modal with additional properties
void	setDismissable(boolean dismissable) Set dismissable when swiping left / right using hammer.js.
void	setInDuration(int inDuration) Sets the In Duration of transition
void	setOpacity(double opacity)
void	setOutDuration(int outDuration) Sets the our duration of transition
void	setType(ModalType type) Sets the type on the widget

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

add, 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, getWidth, insert, insert, isCircle, isEnabled, isFeatureEnabled, isHoverable, isSeparator, onLoad, 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, 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, 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

openModal

public void openModal()

Open the modal programatically

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

openModal

protected void openModal(com.google.gwt.dom.client.Element e,
                         double opacity,
                         boolean dismissable,
                         int inDuration,
                         int outDuration)

Open modal with additional properties

Parameters:

e - - Modal Component

opacity - - Opacity of modal background

dismissable - - Modal can be dismissed by clicking outside of the modal

inDuration - - Transition in Duration

outDuration - - Transition out Duration

onNativeClose

protected void onNativeClose(boolean autoClosed)

closeModal

public void closeModal()

Close the modal programatically. It is the same as calling closeModal(boolean) with false as parameter.

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

closeModal

public void closeModal(boolean autoClosed)

Close the modal programatically.

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

Parameters:

autoClosed - Flag indicating if the modal was automatically dismissed

See Also:

CloseEvent

closeModal

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

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: HasTransition

Sets the In Duration of transition

Specified by:

setInDuration in interface HasTransition

setOutDuration

public void setOutDuration(int outDuration)

Description copied from interface: HasTransition

Sets the our duration of transition

Specified by:

setOutDuration in interface HasTransition

setDismissable

public void setDismissable(boolean dismissable)

Description copied from interface: HasDismissable

Set dismissable when swiping left / right using hammer.js.

Specified by:

setDismissable in interface HasDismissable

isDismissable

public boolean isDismissable()

Specified by:

isDismissable in interface HasDismissable

setOpacity

public void setOpacity(double opacity)

Specified by:

setOpacity in interface HasOpacity

Overrides:

setOpacity in class MaterialWidget

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>