org.dominokit.domino.ui.collapsible

Class Collapsible

java.lang.Object

org.dominokit.domino.ui.collapsible.Collapsible

All Implemented Interfaces:

IsCollapsible<Collapsible>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

public class Collapsible
extends Object
implements org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>, IsCollapsible<Collapsible>

A component to show and hide element

Collapsible component can wrap any element to provide functionality to show and hide the wrapped element also it allows attaching callbacks when the element is shown/hidden

         Collapsible.create(DominoElement.div().setTextContent("Hello world"))
         .addShowHandler(() -> DomGlobal.console.info("Div visible"))
         .addHideHandler(() -> DomGlobal.console.info("Div visible"));
     

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Collapsible.HideCompletedHandler A callback interface to attach some listener when finish hiding the element
static interface	Collapsible.ShowCompletedHandler A callback interface to attach some listener when showing an element.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOM_UI_SCROLL_HEIGHT

Constructor Summary

Constructors

Constructor and Description
Collapsible(elemental2.dom.HTMLElement element) Creates a collapsible wrapping the element

Method Summary

Modifier and Type	Method and Description
Collapsible	addHideHandler(Collapsible.HideCompletedHandler handler) Add handler to be called when ever the element changed state to hidden
Collapsible	addShowHandler(Collapsible.ShowCompletedHandler handler) Add handler to be called when ever the element changed state to visible
static Collapsible	create(elemental2.dom.HTMLElement element) A factory to create a collapsible wrapping the element
static Collapsible	create(org.jboss.elemento.IsElement<?> isElement) A factory to create a collapsible wrapping the element
elemental2.dom.HTMLElement	element()
CollapseStrategy	getStrategy()
Collapsible	hide() Make the element hidden and call any attached hide handlers
boolean	isCollapsed() checks if the wrapped element is collapsed
boolean	isForceHidden()
boolean	isHidden() Deprecated.
void	removeHideHandler(Collapsible.HideCompletedHandler handler) removes the hide handler
void	removeShowHandler(Collapsible.ShowCompletedHandler handler) removes the show handler
Collapsible	setForceHidden(boolean forceHidden) Disable/Enable force hidden
Collapsible	setStrategy(CollapseStrategy strategy)
Collapsible	show() Make the element visible and call any attached show handlers
Collapsible	toggleDisplay() toggle the element visibility, if its visible it hides it, otherwise it make it visible
Collapsible	toggleDisplay(boolean state) toggle the element visibility based on the flag.

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

Field Detail

DOM_UI_SCROLL_HEIGHT

public static final String DOM_UI_SCROLL_HEIGHT

See Also:

Constant Field Values

Constructor Detail

Collapsible

public Collapsible(elemental2.dom.HTMLElement element)

Creates a collapsible wrapping the element

Parameters:

element - HTMLElement to be wrapped in a collapsible

Method Detail

create

public static Collapsible create(elemental2.dom.HTMLElement element)

A factory to create a collapsible wrapping the element

Parameters:

element - HTMLElement to be wrapped in a collapsible

create

public static Collapsible create(org.jboss.elemento.IsElement<?> isElement)

A factory to create a collapsible wrapping the element

Parameters:

isElement - IsElement to be wrapped in a collapsible

isForceHidden

public boolean isForceHidden()

Returns:

boolean, if true the element is hidden and wont be shown even if we call show()

setForceHidden

public Collapsible setForceHidden(boolean forceHidden)

Disable/Enable force hidden

Parameters:

forceHidden - boolean, if true it will hide the element if it is visible and wont allow the element to be shown unless it is turned off, when turned off the element will remain hidden until we call show()

Returns:

same instance

show

public Collapsible show()

Make the element visible and call any attached show handlers

Specified by:

show in interface IsCollapsible<Collapsible>

Returns:

same collapsible instance

hide

public Collapsible hide()

Make the element hidden and call any attached hide handlers

Specified by:

hide in interface IsCollapsible<Collapsible>

Returns:

same collapsible instance

isHidden

@Deprecated
public boolean isHidden()

Deprecated.

checks if the wrapped element is hidden

Specified by:

isHidden in interface IsCollapsible<Collapsible>

Returns:

boolean, true if the element is hidden.

isCollapsed

public boolean isCollapsed()

checks if the wrapped element is collapsed

Specified by:

isCollapsed in interface IsCollapsible<Collapsible>

Returns:

boolean, true if the element is collapsed.

toggleDisplay

public Collapsible toggleDisplay()

toggle the element visibility, if its visible it hides it, otherwise it make it visible

Specified by:

toggleDisplay in interface IsCollapsible<Collapsible>

Returns:

same collapsible instance

toggleDisplay

public Collapsible toggleDisplay(boolean state)

toggle the element visibility based on the flag.

Specified by:

toggleDisplay in interface IsCollapsible<Collapsible>

Parameters:

state - boolean, if true make the element visible otherwise make it hidden

Returns:

same collapsible instance

addHideHandler

public Collapsible addHideHandler(Collapsible.HideCompletedHandler handler)

Add handler to be called when ever the element changed state to hidden

Parameters:

handler - Collapsible.HideCompletedHandler

Returns:

same Collapsible instance

removeHideHandler

public void removeHideHandler(Collapsible.HideCompletedHandler handler)

removes the hide handler

Parameters:

handler - Collapsible.HideCompletedHandler

addShowHandler

public Collapsible addShowHandler(Collapsible.ShowCompletedHandler handler)

Add handler to be called when ever the element changed state to visible

Parameters:

handler - Collapsible.ShowCompletedHandler

Returns:

same Collapsible instance

removeShowHandler

public void removeShowHandler(Collapsible.ShowCompletedHandler handler)

removes the show handler

Parameters:

handler - Collapsible.ShowCompletedHandler

getStrategy

public CollapseStrategy getStrategy()

Returns:

the current CollapseStrategy used by this Collapsible

setStrategy

public Collapsible setStrategy(CollapseStrategy strategy)

Parameters:

strategy - CollapseStrategy to be used with this collapsible

Returns:

same Collapsible instance

element

public elemental2.dom.HTMLElement element()

Specified by:

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