Module org.snapfx

Package org.snapfx.sidebar

Enum Class DockSideBarMode

java.lang.Object

java.lang.Enum<DockSideBarMode>

org.snapfx.sidebar.DockSideBarMode

All Implemented Interfaces:

Serializable, Comparable<DockSideBarMode>, Constable

public enum DockSideBarMode
extends Enum<DockSideBarMode>

Controls sidebar visibility behavior in SnapFX.

This mode only affects framework sidebar UI availability and rendering behavior. Sidebar model state (for example pinned nodes and per-side panel widths) remains stored in DockGraph so hosts can switch modes without losing sidebar state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always render left/right sidebar strips, even when they are empty.
AUTO	Render sidebars only when a side currently contains pinned sidebar nodes.
NEVER	Disable framework sidebar UI and sidebar move context-menu actions.

Method Summary

Modifier and Type	Method	Description
static DockSideBarMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DockSideBarMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS

public static final DockSideBarMode ALWAYS

Always render left/right sidebar strips, even when they are empty.

This allows direct drag-and-drop into empty sidebars.

AUTO

public static final DockSideBarMode AUTO

Render sidebars only when a side currently contains pinned sidebar nodes.

NEVER

public static final DockSideBarMode NEVER

Disable framework sidebar UI and sidebar move context-menu actions.

Sidebar model state is preserved but hidden while this mode is active.

Method Details

values

public static DockSideBarMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DockSideBarMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null