Package org.patternfly.component.modal

Class Modal

java.lang.Object

org.patternfly.component.ComponentDelegate<HTMLElement,Modal>

org.patternfly.component.modal.Modal

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLElement,Modal>, ElementClassListMethods<HTMLElement,Modal>, ElementConsumerMethods<HTMLElement,Modal>, ElementContainerMethods<HTMLElement,Modal>, ElementEventMethods<HTMLElement,Modal>, ElementIdMethods<HTMLElement,Modal>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement,Modal>, HTMLElementDataMethods<HTMLElement,Modal>, HTMLElementStyleMethods<HTMLElement,Modal>, HTMLElementVisibilityMethods<HTMLElement,Modal>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,Modal>, Closeable<HTMLElement,Modal>, Component

public class Modal
extends ComponentDelegate<HTMLElement,Modal>
implements Attachable, Closeable<HTMLElement,Modal>

A modal displays important information to a user without requiring them to navigate to a new page.

See Also:

• https://www.patternfly.org/components/modal

Method Summary

Modifier and Type	Method	Description
Modal	add(ModalBody body)
Modal	add(ModalFooter footer)
Modal	add(ModalHeader header)
Modal	addBody(ModalBody body)
Modal	addFooter(ModalFooter footer)
Modal	addHeader(String title)
Modal	addHeader(ModalHeader header)
Modal	appendTo(HTMLElement element)
Modal	appendToBody()
void	attach(MutationRecord mutationRecord)
Modal	autoClose(boolean autoClose)
ModalBody	body()
void	close(Event event, boolean fireEvent)
Modal	closeOnEsc(boolean closeOnEsc)
Modal	hideClose()
Modal	maxWidth(String maxWidth)
static Modal	modal()
Modal	onClose(org.patternfly.handler.CloseHandler<Modal> closeHandler)
void	open()
Modal	size(org.patternfly.style.Size size)
Modal	that()
Modal	top()
Modal	width(String width)

Methods inherited from class org.patternfly.component.ComponentDelegate

componentType, element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.elemento.Attachable

detach

Methods inherited from interface org.patternfly.component.Closeable

close, close

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Method Details

modal

public static Modal modal()

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

appendToBody

public Modal appendToBody()

appendTo

public Modal appendTo(HTMLElement element)

addHeader

public Modal addHeader(String title)

addHeader

public Modal addHeader(ModalHeader header)

add

public Modal add(ModalHeader header)

addBody

public Modal addBody(ModalBody body)

add

public Modal add(ModalBody body)

addFooter

public Modal addFooter(ModalFooter footer)

add

public Modal add(ModalFooter footer)

closeOnEsc

public Modal closeOnEsc(boolean closeOnEsc)

autoClose

public Modal autoClose(boolean autoClose)

hideClose

public Modal hideClose()

maxWidth

public Modal maxWidth(String maxWidth)

size

public Modal size(org.patternfly.style.Size size)

top

public Modal top()

width

public Modal width(String width)

that

public Modal that()

Specified by:

that in interface TypedBuilder<HTMLElement,Modal>

onClose

public Modal onClose(org.patternfly.handler.CloseHandler<Modal> closeHandler)

Specified by:

onClose in interface Closeable<HTMLElement,Modal>

open

public void open()

close

public void close(Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<HTMLElement,Modal>

body

public ModalBody body()