org.dominokit.domino.ui.media

Class MediaObject

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,MediaObject>

org.dominokit.domino.ui.media.MediaObject

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,MediaObject,MediaObject>, HasChildren<MediaObject>, HasWavesElement, IsCollapsible<MediaObject>, IsReadOnly<MediaObject>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class MediaObject
extends BaseDominoElement<elemental2.dom.HTMLDivElement,MediaObject>
implements org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

A component to display media such as images, video and audio

Customize the component can be done by overwriting classes provided by MediaStyles

For example:

     MediaObject.create()
                .setHeader("Media heading")
                .setLeftMedia(a().add(
                                  img("http://placehold.it/64x64")
                                      .attr("width", "64")
                                      .attr("height", "64")
                             )
                )
                .appendChild(TextNode.of(SAMPLE_TEXT))
 

See Also:

BaseDominoElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaObject.MediaAlign An enum representing the alignment of the media elements

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Constructor Summary

Constructors

Constructor and Description
MediaObject()

Method Summary

Modifier and Type	Method and Description
MediaObject	alignLeftMedia(MediaObject.MediaAlign align) Sets the alignment of the left media element
MediaObject	alignRightMedia(MediaObject.MediaAlign align) Sets the alignment of the right media element
MediaObject	appendChild(org.jboss.elemento.IsElement<?> content)
MediaObject	appendChild(elemental2.dom.Node content)
static MediaObject	create()
elemental2.dom.HTMLDivElement	element()
DominoElement<elemental2.dom.HTMLDivElement>	getLeftMedia()
DominoElement<elemental2.dom.HTMLDivElement>	getMediaBody()
DominoElement<elemental2.dom.HTMLHeadingElement>	getMediaHeader()
DominoElement<elemental2.dom.HTMLDivElement>	getRightMedia()
MediaObject	setHeader(String header) Sets the header title of the media object
MediaObject	setLeftMedia(org.jboss.elemento.IsElement<?> element) Same as setLeftMedia(Node) but uses IsElement wrapper
MediaObject	setLeftMedia(elemental2.dom.Node content) Sets the media node at the left of this component
MediaObject	setRightMedia(org.jboss.elemento.IsElement<?> element) Same as setRightMedia(Node) but uses IsElement wrapper
MediaObject	setRightMedia(elemental2.dom.Node content) Sets the media node at the right of this component

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

MediaObject

public MediaObject()

Method Detail

create

public static MediaObject create()

Returns:

new instance

setHeader

public MediaObject setHeader(String header)

Sets the header title of the media object

Parameters:

header - the header text

Returns:

same instance

setLeftMedia

public MediaObject setLeftMedia(elemental2.dom.Node content)

Sets the media node at the left of this component

Parameters:

content - A media Node

Returns:

same instance

setLeftMedia

public MediaObject setLeftMedia(org.jboss.elemento.IsElement<?> element)

Same as setLeftMedia(Node) but uses IsElement wrapper

Parameters:

element - A media IsElement

Returns:

same instance

setRightMedia

public MediaObject setRightMedia(elemental2.dom.Node content)

Sets the media node at the right of this component

Parameters:

content - A media Node

Returns:

same instance

setRightMedia

public MediaObject setRightMedia(org.jboss.elemento.IsElement<?> element)

Same as setRightMedia(Node) but uses IsElement wrapper

Parameters:

element - A media IsElement

Returns:

same instance

appendChild

public MediaObject appendChild(elemental2.dom.Node content)

Specified by:

appendChild in interface HasChildren<MediaObject>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,MediaObject>

Parameters:

content - Node to be appended to the component

Returns:

same component

appendChild

public MediaObject appendChild(org.jboss.elemento.IsElement<?> content)

Specified by:

appendChild in interface HasChildren<MediaObject>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,MediaObject>

Parameters:

content - IsElement to be appended to the component

Returns:

same component

alignLeftMedia

public MediaObject alignLeftMedia(MediaObject.MediaAlign align)

Sets the alignment of the left media element

Parameters:

align - the MediaObject.MediaAlign

Returns:

same instance

alignRightMedia

public MediaObject alignRightMedia(MediaObject.MediaAlign align)

Sets the alignment of the right media element

Parameters:

align - the MediaObject.MediaAlign

Returns:

same instance

getMediaBody

public DominoElement<elemental2.dom.HTMLDivElement> getMediaBody()

Returns:

The media element body

getMediaHeader

public DominoElement<elemental2.dom.HTMLHeadingElement> getMediaHeader()

Returns:

The media header element

getLeftMedia

public DominoElement<elemental2.dom.HTMLDivElement> getLeftMedia()

Returns:

The left media element

getRightMedia

public DominoElement<elemental2.dom.HTMLDivElement> getRightMedia()

Returns:

The right media element

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,MediaObject>

Returns:

the HTML element of type E which is the root element of the component