IsModalDialog (domino-ui 1.0.0-RC13 API)

Type Parameters:

T - the type of the component implementing this interface

All Known Implementing Classes:

BaseModal, ConfirmationDialog, MessageDialog, ModalDialog, Window
```
public interface IsModalDialog<T>
```
Base interface to implement modal dialog

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IsModalDialog.CloseHandler` An interface to implement handlers for closing a dialog
`static class`	`IsModalDialog.ModalSize` An enum to list modal possible zises
`static class`	`IsModalDialog.ModalType` An enum to list modal types
`static interface`	`IsModalDialog.OpenHandler` A function to implement a listener to be called when open the dialog

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`addCloseListener(IsModalDialog.CloseHandler closeHandler)`
`T`	`addOpenListener(IsModalDialog.OpenHandler openHandler)`
`T`	`appendChild(org.jboss.elemento.IsElement<?> content)`
`T`	`appendChild(elemental2.dom.Node content)`
`T`	`appendFooterChild(org.jboss.elemento.IsElement<?> content)`
`T`	`appendFooterChild(elemental2.dom.Node content)`
`T`	`centerVertically()` make the dialog show up in the center of the screen
`T`	`close()` Close and hide the dialog
`T`	`deCenterVertically()` make the dialog show up on the top of the screen
`boolean`	`getAutoAppendAndRemove()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getBodyElement()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getContentElement()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getDialogElement()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getFooterElement()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getHeaderContainerElement()`
`DominoElement<elemental2.dom.HTMLHeadingElement>`	`getHeaderElement()`
`T`	`hideFooter()` Hides the footer of the dialog
`T`	`hideHeader()` hide the header of the dialog
`T`	`hideTitle()` Hide the title of the dialog
`boolean`	`isAutoFocus()`
`T`	`large()` set the dialog size to `IsModalDialog.ModalSize.LARGE`
`T`	`open()` Show the dialog
`T`	`removeCloseHandler(IsModalDialog.CloseHandler closeHandler)`
`T`	`removeOpenHandler(IsModalDialog.OpenHandler openHandler)`
`T`	`setAutoAppendAndRemove(boolean autoAppendAndRemove)`
`T`	`setAutoClose(boolean autoClose)`
`T`	`setAutoFocus(boolean autoFocus)`
`T`	`setModalColor(Color color)`
`T`	`setTitle(String title)`
`T`	`showFooter()` Show the footer of the dialog
`T`	`showHeader()` Show the header of the dialog
`T`	`showTitle()` Show the title of the dialog
`T`	`small()` set the dialog size to `IsModalDialog.ModalSize.SMALL`

- Method Detail
  - appendChild
```
T appendChild(elemental2.dom.Node content)
```
    Parameters:
    
    content - Node to be appended to the modal body
    
    Returns:
    
    same implementing component
  - appendChild
```
T appendChild(org.jboss.elemento.IsElement<?> content)
```
    Parameters:
    
    content - IsElement to be appended to the modal body
    
    Returns:
    
    same implementing component
  - appendFooterChild
```
T appendFooterChild(elemental2.dom.Node content)
```
    Parameters:
    
    content - Node to be appended to the modal footer
    
    Returns:
    
    same implementing component
  - appendFooterChild
```
T appendFooterChild(org.jboss.elemento.IsElement<?> content)
```
    Parameters:
    
    content - IsElement to be appended to the modal footer
    
    Returns:
    
    same implementing component
  - large
```
T large()
```
    set the dialog size to IsModalDialog.ModalSize.LARGE
    
    Returns:
    
    same implementing interface
  - small
```
T small()
```
    set the dialog size to IsModalDialog.ModalSize.SMALL
    
    Returns:
    
    same implementing interface
  - setModalColor
```
T setModalColor(Color color)
```
    Parameters:
    
    color - Color of the modal header and body
    
    Returns:
    
    same implementing interface
  - setAutoClose
```
T setAutoClose(boolean autoClose)
```
    Parameters:
    
    autoClose - boolean, true to close the dialog by pressing escape key
    
    Returns:
    
    same implementing interface
  - open
```
T open()
```
    Show the dialog
    
    Returns:
    
    same implementing component
  - close
```
T close()
```
    Close and hide the dialog
    
    Returns:
    
    same implementing component
  - hideFooter
```
T hideFooter()
```
    Hides the footer of the dialog
    
    Returns:
    
    same implementing component
  - showFooter
```
T showFooter()
```
    Show the footer of the dialog
    
    Returns:
    
    same implementing component
  - hideHeader
```
T hideHeader()
```
    hide the header of the dialog
    
    Returns:
    
    same implementing component
  - showHeader
```
T showHeader()
```
    Show the header of the dialog
    
    Returns:
    
    same implementing component
  - hideTitle
```
T hideTitle()
```
    Hide the title of the dialog
    
    Returns:
    
    same implementing component
  - showTitle
```
T showTitle()
```
    Show the title of the dialog
    
    Returns:
    
    same implementing component
  - setTitle
```
T setTitle(String title)
```
    Parameters:
    
    title - String
    
    Returns:
    
    same implementing component
  - getDialogElement
```
DominoElement<elemental2.dom.HTMLDivElement> getDialogElement()
```
    Returns:
    
    same implementing component
  - getContentElement
```
DominoElement<elemental2.dom.HTMLDivElement> getContentElement()
```
    Returns:
    
    same implementing component
  - getHeaderElement
```
DominoElement<elemental2.dom.HTMLHeadingElement> getHeaderElement()
```
    Returns:
    
    same implementing component
  - getHeaderContainerElement
```
DominoElement<elemental2.dom.HTMLDivElement> getHeaderContainerElement()
```
    Returns:
    
    same implementing component
  - getBodyElement
```
DominoElement<elemental2.dom.HTMLDivElement> getBodyElement()
```
    Returns:
    
    same implementing component
  - getFooterElement
```
DominoElement<elemental2.dom.HTMLDivElement> getFooterElement()
```
    Returns:
    
    same implementing component
  - addOpenListener
```
T addOpenListener(IsModalDialog.OpenHandler openHandler)
```
    Parameters:
    
    openHandler - IsModalDialog.OpenHandler
    
    Returns:
    
    same implementing component
  - addCloseListener
```
T addCloseListener(IsModalDialog.CloseHandler closeHandler)
```
    Parameters:
    
    closeHandler - IsModalDialog.CloseHandler
    
    Returns:
    
    same implementing component
  - removeOpenHandler
```
T removeOpenHandler(IsModalDialog.OpenHandler openHandler)
```
    Parameters:
    
    openHandler - IsModalDialog.OpenHandler
    
    Returns:
    
    same implementing component
  - removeCloseHandler
```
T removeCloseHandler(IsModalDialog.CloseHandler closeHandler)
```
    Parameters:
    
    closeHandler - IsModalDialog.CloseHandler
    
    Returns:
    
    same implementing component
  - setAutoAppendAndRemove
```
T setAutoAppendAndRemove(boolean autoAppendAndRemove)
```
    Parameters:
    
    autoAppendAndRemove - boolean, true to automatically remove and append the modal every time we open it
    
    Returns:
    
    same implementing component
  - getAutoAppendAndRemove
```
boolean getAutoAppendAndRemove()
```
    Returns:
    
    boolean, true to automatically remove and append the modal every time we open it
  - centerVertically
```
T centerVertically()
```
    make the dialog show up in the center of the screen
    
    Returns:
    
    same implementing component
  - deCenterVertically
```
T deCenterVertically()
```
    make the dialog show up on the top of the screen
    
    Returns:
  - isAutoFocus
```
boolean isAutoFocus()
```
    Returns:
    
    boolean, true if the modal should auto-focus first focusable element when opened.
  - setAutoFocus
```
T setAutoFocus(boolean autoFocus)
```
    Parameters:
    
    autoFocus - boolean, true if the modal should auto-focus first focusable element when opened.
    
    Returns:
    
    same dialog instance

Interface IsModalDialog<T>

Nested Class Summary

Method Summary

Method Detail

appendChild

appendChild

appendFooterChild

appendFooterChild

large

small

setModalColor

setAutoClose

open

close

hideFooter

showFooter

hideHeader

showHeader

hideTitle

showTitle

setTitle

getDialogElement

getContentElement

getHeaderElement

getHeaderContainerElement

getBodyElement

getFooterElement

addOpenListener

addCloseListener

removeOpenHandler

removeCloseHandler

setAutoAppendAndRemove

getAutoAppendAndRemove

centerVertically

deCenterVertically

isAutoFocus

setAutoFocus