org.dominokit.domino.ui.layout

Class Layout

java.lang.Object

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

org.dominokit.domino.ui.layout.Layout

All Implemented Interfaces:

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

public class Layout
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Layout>

A component for building application layout -Shell- with predefined sections

• Header Bar
• Lwft panel
• Content panel
• Optional right panel
• Optional footer

     Layout.create("Application title").show(ColorScheme.INDIGO);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Layout.LayoutHandler a function to implement logic for interacting with the layout during different phases of its attach cycle
static class	Layout.LeftPanelOpenStyle An enum to list left panel open behaviors
static class	Layout.LeftPanelSize An enum to list left panel sizes that controls the panel width

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIT_HEIGHT
static String	FIT_WIDTH

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

element

Constructor Summary

Constructors

Constructor and Description
Layout() Creates a Layout without a title
Layout(String title) Creates a Layout with a title

Method Summary

Modifier and Type	Method and Description
elemental2.dom.HTMLElement	addActionItem(BaseIcon<?> icon) Adds an action to the action bar at the right
elemental2.dom.HTMLElement	addActionItem(elemental2.dom.HTMLElement element) Adds an action to the action bar at the right
elemental2.dom.HTMLElement	addActionItem(org.jboss.elemento.IsElement<?> element) Adds an action to the action bar at the right
Layout	addLeftPanel() un-hide the left panel
Layout	autoFixLeftPanel() fix the left panel so the user wont be able to hide it using the hamburger menu icon while we open the application on large device screen, while it will be collapsible when opened on small screens
Layout	content(Consumer<DominoElement<elemental2.dom.HTMLDivElement>> contentConsumer) Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)
static Layout	create()
static Layout	create(String title)
Layout	disableLeftPanel() Hides the left panel and hide the icon that toggle its open/close state
elemental2.dom.HTMLDivElement	element()
Layout	enableLeftPanel() if disable this will show the left panel and show its toggle icon
Layout	fitHeight() expands the content panel height to fit the screen without gaps and margins
Layout	fitWidth() expands the content panel width to fit the screen without gaps and margins
Layout	fixFooter()
Layout	fixLeftPanelPosition() Fix the left panel so it open and push the content panel and reduce its width instead of showing on top of it
Layout	footer(Consumer<Footer> footerConsumer) Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)
elemental2.dom.Text	getAppTitle()
DominoElement<elemental2.dom.HTMLDivElement>	getContentPanel()
Content	getContentSection()
Footer	getFooter()
DominoElement<elemental2.dom.HTMLElement>	getLeftPanel()
Layout.LeftPanelOpenStyle	getLeftPanelOpenStyle()
Layout.LeftPanelSize	getLeftPanelSize()
NavigationBar	getNavigationBar()
DominoElement<elemental2.dom.HTMLElement>	getRightPanel()
DominoElement<elemental2.dom.HTMLUListElement>	getTopBar()
Layout	hideFooter()
Layout	hideLeftPanel() Close the left panel
Layout	hideNavBarExpand() Hide the menu toggle icon from the navigation bar
Layout	hideNavBarExpandOn(ScreenMedia screenMedia) Hide the menu toggle icon from the navigation bar on provided screens only
Layout	hideNavBarExpandOnSmallDown() Hide the menu toggle icon from the navigation bar on small screens only
Layout	hideRightPanel() Close the left panel if it is open
boolean	isFixedLeftPanel()
boolean	isFooterVisible()
boolean	isLeftPanelDisabled()
boolean	isLeftPanelVisible()
boolean	isNavigationBarExpanded() Deprecated. not used
boolean	isOverlayVisible()
boolean	isRightPanelVisible()
Layout	leftPanel(Consumer<DominoElement<elemental2.dom.HTMLElement>> leftPanelConsumer) Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)
Layout	navigationBar(Consumer<NavigationBar> navigationBarConsumer) Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)
Layout	onLeftPanelStateChanged(Consumer<Boolean> leftPanelHandler) Sets a handler to be called when the left open/closed state is changed
Layout	onShow(Layout.LayoutHandler layoutHandler) sets handler to be called when show() is called
Layout	remove() removes the layout from the page body
void	remove(Layout.LayoutHandler removeHandler) removes the layout from the page body and call the provided handler
Layout	removeLeftPanel() Hides the left panel permanently
Layout	removeLeftPanelHandler(Consumer<Boolean> leftPanelHandler) remove the handler that was set with onLeftPanelStateChanged(Consumer)
Layout	rightPanel(Consumer<DominoElement<elemental2.dom.HTMLElement>> rightPanelConsumer) Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)
Layout	setContent(org.jboss.elemento.IsElement<?> element) clears the content panel and appends the provided element to it
Layout	setContent(elemental2.dom.Node node) clears the content panel and appends the provided Node to it
Layout	setHeaderHeight(String height)
Layout	setLeftPanelOpenStyle(Layout.LeftPanelOpenStyle leftPanelOpenStyle) Change the behavior of the left open/close
Layout	setLeftPanelSize(Layout.LeftPanelSize leftPanelSize) change the left panel size
Layout	setLogo(elemental2.dom.HTMLImageElement imageElement)
Layout	setLogo(org.jboss.elemento.IsElement<elemental2.dom.HTMLImageElement> imageElement)
Layout	setTitle(String title)
Layout	show() Reveal the layout and append it to the page body
Layout	show(boolean autoFixLeftPanel) Reveal the layout and append it to the page body
Layout	show(ColorScheme theme) Reveal the layout and append it to the page body and apply the specified theme color
Layout	show(ColorScheme theme, boolean autoFixLeftPanel) Reveal the layout and append it to the page body and apply the specified theme color
Layout	showFooter()
Layout	showLeftPanel() Opens the left panel
Layout	showRightPanel() Opens the right panel, this will also hide the left panel if it is open
Layout	spanLeftPanelUp() the left panel will spread to the top of the browser page and push the header to the right reducing its width
Layout	toggleLeftPanel() Toggle the state of the left panel, if it is open close it, if closed open it
Layout	toggleRightPanel() toggle the state of the right panel, if it is closed it will open and if it is open it will be closed
Layout	topBar(Consumer<DominoElement<elemental2.dom.HTMLUListElement>> topBarConsumer) Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)
Layout	unfitHeight() restore the gaps and margins removed by fitHeight()
Layout	unfitWidth() restore the gaps and margins removed by fitWidth()
Layout	unfixFooter()
Layout	unfixLeftPanelPosition() The left panel will open on top the content panel with an overlay

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, 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, 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, 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, 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

Field Detail

FIT_WIDTH

public static final String FIT_WIDTH

See Also:

Constant Field Values

FIT_HEIGHT

public static final String FIT_HEIGHT

See Also:

Constant Field Values

Constructor Detail

Layout

public Layout()

Creates a Layout without a title

Layout

public Layout(String title)

Creates a Layout with a title

Parameters:

title - String title

Method Detail

create

public static Layout create()

Returns:

new Layout instance without a title in the header

create

public static Layout create(String title)

Returns:

new Layout instance with a title in the header

show

public Layout show()

Reveal the layout and append it to the page body

Specified by:

show in interface IsCollapsible<Layout>

Overrides:

show in class BaseDominoElement<elemental2.dom.HTMLDivElement,Layout>

Returns:

same Layout instance

See Also:

Collapsible.show()

show

public Layout show(boolean autoFixLeftPanel)

Reveal the layout and append it to the page body

Parameters:

autoFixLeftPanel - boolean, if true left panel will be fixed and the user wont be able to hide it using the hamburger menu icon while we open the application on large device screen, while it will be collapsible when opened on small screens

Returns:

same Layout instance

show

public Layout show(ColorScheme theme)

Reveal the layout and append it to the page body and apply the specified theme color

Parameters:

theme - ColorScheme

Returns:

same Layout instance

show

public Layout show(ColorScheme theme,
                   boolean autoFixLeftPanel)

Reveal the layout and append it to the page body and apply the specified theme color

Parameters:

theme - ColorScheme

autoFixLeftPanel - boolean, if true left panel will be fixed and and the user wont be able to hide it using the hamburger menu icon while we open the application on large device screen, while it will be collapsible when opened on small screens

Returns:

same Layout instance

remove

public void remove(Layout.LayoutHandler removeHandler)

removes the layout from the page body and call the provided handler

Parameters:

removeHandler - Layout.LayoutHandler

remove

public Layout remove()

removes the layout from the page body

Overrides:

remove in class BaseDominoElement<elemental2.dom.HTMLDivElement,Layout>

Returns:

the same Layout instance

onShow

public Layout onShow(Layout.LayoutHandler layoutHandler)

sets handler to be called when show() is called

Parameters:

layoutHandler - Layout.LayoutHandler

Returns:

sam Layout instance

removeLeftPanel

public Layout removeLeftPanel()

Hides the left panel permanently

Returns:

same Layout instance

addLeftPanel

public Layout addLeftPanel()

un-hide the left panel

Returns:

same Layout instance

toggleRightPanel

public Layout toggleRightPanel()

toggle the state of the right panel, if it is closed it will open and if it is open it will be closed

showRightPanel

public Layout showRightPanel()

Opens the right panel, this will also hide the left panel if it is open

Returns:

same Layout instance

hideRightPanel

public Layout hideRightPanel()

Close the left panel if it is open

Returns:

same Layout instance

toggleLeftPanel

public Layout toggleLeftPanel()

Toggle the state of the left panel, if it is open close it, if closed open it

Returns:

same Layout instance

setLeftPanelSize

public Layout setLeftPanelSize(Layout.LeftPanelSize leftPanelSize)

change the left panel size

Parameters:

leftPanelSize - Layout.LeftPanelSize

Returns:

same Layout instance

getLeftPanelOpenStyle

public Layout.LeftPanelOpenStyle getLeftPanelOpenStyle()

setLeftPanelOpenStyle

public Layout setLeftPanelOpenStyle(Layout.LeftPanelOpenStyle leftPanelOpenStyle)

Change the behavior of the left open/close

Parameters:

leftPanelOpenStyle - Layout.LeftPanelOpenStyle

showLeftPanel

public Layout showLeftPanel()

Opens the left panel

Returns:

same Layout instance

hideLeftPanel

public Layout hideLeftPanel()

Close the left panel

Returns:

same Layout instance

isFooterVisible

public boolean isFooterVisible()

Returns:

boolean, true if the footer is visible

getRightPanel

public DominoElement<elemental2.dom.HTMLElement> getRightPanel()

Returns:

the right panel HTMLElement wrapped as a DominoElement

getLeftPanel

public DominoElement<elemental2.dom.HTMLElement> getLeftPanel()

Returns:

the left panel HTMLElement wrapped as a DominoElement

getContentPanel

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

Returns:

the content panel HTMLDivElement wrapped as a DominoElement

getTopBar

public DominoElement<elemental2.dom.HTMLUListElement> getTopBar()

Returns:

the top bar panel HTMLUListElement wrapped as a DominoElement

getNavigationBar

public NavigationBar getNavigationBar()

Returns:

the NavigationBar

getContentSection

public Content getContentSection()

Returns:

the main Content section

getFooter

public Footer getFooter()

Returns:

the Footer component

hideFooter

public Layout hideFooter()

Returns:

same Layout instance

showFooter

public Layout showFooter()

Returns:

same Layout instance

setTitle

public Layout setTitle(String title)

Parameters:

title - String application title

Returns:

same Layout instance

addActionItem

public elemental2.dom.HTMLElement addActionItem(BaseIcon<?> icon)

Adds an action to the action bar at the right

Parameters:

icon - BaseIcon for the action

Returns:

the HTMLElement of the created action

addActionItem

public elemental2.dom.HTMLElement addActionItem(org.jboss.elemento.IsElement<?> element)

Adds an action to the action bar at the right

Parameters:

element - IsElement action HTMLElement content

Returns:

the HTMLElement of the created action

addActionItem

public elemental2.dom.HTMLElement addActionItem(elemental2.dom.HTMLElement element)

Adds an action to the action bar at the right

Parameters:

element - HTMLElement action HTMLElement content

Returns:

the HTMLElement of the created action

fixLeftPanelPosition

public Layout fixLeftPanelPosition()

Fix the left panel so it open and push the content panel and reduce its width instead of showing on top of it

Returns:

same Layout instance

unfixLeftPanelPosition

public Layout unfixLeftPanelPosition()

The left panel will open on top the content panel with an overlay

Returns:

same Layout instance

spanLeftPanelUp

public Layout spanLeftPanelUp()

the left panel will spread to the top of the browser page and push the header to the right reducing its width

Returns:

same Layout instance

disableLeftPanel

public Layout disableLeftPanel()

Hides the left panel and hide the icon that toggle its open/close state

Returns:

same Layout instance

enableLeftPanel

public Layout enableLeftPanel()

if disable this will show the left panel and show its toggle icon

Returns:

same Layout instance

fixFooter

public Layout fixFooter()

Returns:

same Layout instance

See Also:

Footer#fixed()}

unfixFooter

public Layout unfixFooter()

Returns:

same Layout instance

See Also:

Footer#unfixed()}

setHeaderHeight

public Layout setHeaderHeight(String height)

Parameters:

height - String css height for the header

Returns:

same Layout instance

getAppTitle

public elemental2.dom.Text getAppTitle()

Returns:

Text node of the application title

setContent

public Layout setContent(elemental2.dom.Node node)

clears the content panel and appends the provided Node to it

Overrides:

setContent in class BaseDominoElement<elemental2.dom.HTMLDivElement,Layout>

Parameters:

node - Node the new content

Returns:

same Layout instance

setContent

public Layout setContent(org.jboss.elemento.IsElement<?> element)

clears the content panel and appends the provided element to it

Overrides:

setContent in class BaseDominoElement<elemental2.dom.HTMLDivElement,Layout>

Parameters:

element - IsElement the new content

Returns:

same Layout instance

content

@Deprecated
public Layout content(Consumer<DominoElement<elemental2.dom.HTMLDivElement>> contentConsumer)

Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)

leftPanel

@Deprecated
public Layout leftPanel(Consumer<DominoElement<elemental2.dom.HTMLElement>> leftPanelConsumer)

Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)

rightPanel

@Deprecated
public Layout rightPanel(Consumer<DominoElement<elemental2.dom.HTMLElement>> rightPanelConsumer)

Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)

footer

@Deprecated
public Layout footer(Consumer<Footer> footerConsumer)

Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)

navigationBar

@Deprecated
public Layout navigationBar(Consumer<NavigationBar> navigationBarConsumer)

Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)

topBar

@Deprecated
public Layout topBar(Consumer<DominoElement<elemental2.dom.HTMLUListElement>> topBarConsumer)

Deprecated. not needed, use BaseDominoElement.apply(ElementHandler)

setLogo

public Layout setLogo(elemental2.dom.HTMLImageElement imageElement)

Parameters:

imageElement - HTMLImageElement logo to show on the left side

Returns:

same Layout instance

setLogo

public Layout setLogo(org.jboss.elemento.IsElement<elemental2.dom.HTMLImageElement> imageElement)

Parameters:

imageElement - HTMLImageElement wrapped as IsElement logo to show on the left side

Returns:

same Layout instance

autoFixLeftPanel

public Layout autoFixLeftPanel()

fix the left panel so the user wont be able to hide it using the hamburger menu icon while we open the application on large device screen, while it will be collapsible when opened on small screens

Returns:

same Layout instance

hideNavBarExpand

public Layout hideNavBarExpand()

Hide the menu toggle icon from the navigation bar

Returns:

same Layout instance

hideNavBarExpandOnSmallDown

public Layout hideNavBarExpandOnSmallDown()

Hide the menu toggle icon from the navigation bar on small screens only

Returns:

same Layout instance

hideNavBarExpandOn

public Layout hideNavBarExpandOn(ScreenMedia screenMedia)

Hide the menu toggle icon from the navigation bar on provided screens only

Parameters:

screenMedia - ScreenMedia for which we should the menu toggle

Returns:

same Layout instance

onLeftPanelStateChanged

public Layout onLeftPanelStateChanged(Consumer<Boolean> leftPanelHandler)

Sets a handler to be called when the left open/closed state is changed

Parameters:

leftPanelHandler - Consumer of Boolean, true for open, false for closed

Returns:

same Layout instance

removeLeftPanelHandler

public Layout removeLeftPanelHandler(Consumer<Boolean> leftPanelHandler)

remove the handler that was set with onLeftPanelStateChanged(Consumer)

Parameters:

leftPanelHandler - the handler

Returns:

same Layout instance

fitWidth

public Layout fitWidth()

expands the content panel width to fit the screen without gaps and margins

Returns:

same Layout instance

unfitWidth

public Layout unfitWidth()

restore the gaps and margins removed by fitWidth()

Returns:

same Layout instance

fitHeight

public Layout fitHeight()

expands the content panel height to fit the screen without gaps and margins

Returns:

same Layout instance

unfitHeight

public Layout unfitHeight()

restore the gaps and margins removed by fitHeight()

Returns:

same Layout instance

isLeftPanelVisible

public boolean isLeftPanelVisible()

Returns:

boolean, true if the left panel is visible and open

isRightPanelVisible

public boolean isRightPanelVisible()

Returns:

boolean, true if the right panel is visible and open

isNavigationBarExpanded

@Deprecated
public boolean isNavigationBarExpanded()

Deprecated. not used

isOverlayVisible

public boolean isOverlayVisible()

Returns:

boolean, true if the overlay covering the content is visible

isLeftPanelDisabled

public boolean isLeftPanelDisabled()

Returns:

boolean, true if left panel is disabled

isFixedLeftPanel

public boolean isFixedLeftPanel()

Returns:

boolean, true if left panel is fixed

getLeftPanelSize

public Layout.LeftPanelSize getLeftPanelSize()

Returns:

the Layout.LeftPanelSize

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,Layout>

Returns:

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