Module org.snapfx

Package org.snapfx.model

Interface DockContainer

All Superinterfaces:

DockElement

All Known Implementing Classes:

DockSplitPane, DockTabPane

public interface DockContainer
extends DockElement

Interface for container elements in the DockGraph. Containers can hold multiple DockElement instances.

Method Summary

Modifier and Type	Method	Description
void	addChild(DockElement element)	Adds a child element.
default void	cleanupIfEmpty()	Auto-cleanup: removes this container from its parent when it becomes empty.
javafx.collections.ObservableList<DockElement>	getChildren()	Returns the list of child elements.
default boolean	isEmpty()	Returns whether the container is empty.
void	removeChild(DockElement element)	Removes a child element.

Methods inherited from interface org.snapfx.model.DockElement

getId, getParent, removeFromParent, setParent

Method Details

getChildren

javafx.collections.ObservableList<DockElement> getChildren()

Returns the list of child elements.

Returns:

mutable observable child list

addChild

void addChild(DockElement element)

Adds a child element.

Parameters:

element - child element to add

removeChild

void removeChild(DockElement element)

Removes a child element.

Parameters:

element - child element to remove

isEmpty

default boolean isEmpty()

Returns whether the container is empty.

Returns:

true when getChildren() is empty

cleanupIfEmpty

default void cleanupIfEmpty()

Auto-cleanup: removes this container from its parent when it becomes empty.