com.haulmont.cuba.gui.components

Interface SplitPanel

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasSettings

public interface SplitPanel
extends ComponentContainer, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, HasContextHelp, HasSettings, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

A split panel contains two components and lays them vertically or horizontally.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SplitPanel.DockMode Specifies SplitPanel docking direction.
static class	SplitPanel.SplitPositionChangeEvent Event that indicates a change in SplitPanel's splitter position.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static int	ORIENTATION_HORIZONTAL
static int	ORIENTATION_VERTICAL

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
Subscription	addSplitPositionChangeListener(java.util.function.Consumer<SplitPanel.SplitPositionChangeEvent> listener) Adds a listener for SplitPanel.SplitPositionChangeEvents fired by a SplitPanel.
SplitPanel.DockMode	getDockMode()
float	getMaxSplitPosition() Returns the maximum position of the splitter.
SizeUnit	getMaxSplitPositionSizeUnit() Returns the unit of the maximum position of the splitter.
float	getMinSplitPosition() Returns the minimum position of the splitter.
SizeUnit	getMinSplitPositionSizeUnit() Returns the unit of the minimum position of the splitter.
int	getOrientation()
float	getSplitPosition()
SizeUnit	getSplitPositionSizeUnit() Returns the unit of position of the splitter.
int	getSplitPositionUnit() Deprecated.
boolean	isDockable()
boolean	isLocked()
boolean	isSplitPositionReversed() Return from which side position is set.
void	removeSplitPositionChangeListener(java.util.function.Consumer<SplitPanel.SplitPositionChangeEvent> listener) Deprecated. Use Subscription instead
void	setDockable(boolean dockable) Enables or disables SplitPanel dock button.
void	setDockMode(SplitPanel.DockMode dockMode) Sets docking direction.
void	setLocked(boolean locked) Sets whether users are able to change the separator position or not.
void	setMaxSplitPosition(int pos, int unit) Deprecated. Use setMaxSplitPosition(int, SizeUnit)
void	setMaxSplitPosition(int pos, SizeUnit unit) Sets the maximum split position to the given position and unit.
void	setMinSplitPosition(int pos, int unit) Deprecated. Use setMinSplitPosition(int, SizeUnit)
void	setMinSplitPosition(int pos, SizeUnit unit) Sets the minimum split position to the given position and unit.
void	setOrientation(int orientation)
void	setSplitPosition(int pos)
void	setSplitPosition(int pos, int unit) Deprecated. Use setSplitPosition(int, SizeUnit)
void	setSplitPosition(int pos, int unit, boolean reversePosition) Deprecated. Use setSplitPosition(int, SizeUnit, boolean)
void	setSplitPosition(int pos, SizeUnit unit) Set position of split from the left side by default.
void	setSplitPosition(int pos, SizeUnit unit, boolean reversePosition) Set position of split from the left side by default.

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasSettings

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

ORIENTATION_VERTICAL

static final int ORIENTATION_VERTICAL

See Also:

Constant Field Values

ORIENTATION_HORIZONTAL

static final int ORIENTATION_HORIZONTAL

See Also:

Constant Field Values

Method Detail

getOrientation

int getOrientation()

setOrientation

void setOrientation(int orientation)

setSplitPosition

void setSplitPosition(int pos)

setSplitPosition

@Deprecated
void setSplitPosition(int pos,
                                  int unit)

Deprecated. Use setSplitPosition(int, SizeUnit)

setSplitPosition

void setSplitPosition(int pos,
                      SizeUnit unit)

Set position of split from the left side by default.

Parameters:

pos - the new size of the first region.

unit - the unit (from SizeUnit) in which the size is given.

setSplitPosition

@Deprecated
void setSplitPosition(int pos,
                                  int unit,
                                  boolean reversePosition)

Deprecated. Use setSplitPosition(int, SizeUnit, boolean)

Set position of split from the left side by default. If reversePosition is true position will be set from right.

setSplitPosition

void setSplitPosition(int pos,
                      SizeUnit unit,
                      boolean reversePosition)

Set position of split from the left side by default. If reversePosition is true position will be set from right.

Parameters:

pos - the new size of the first region.

unit - the unit (from SizeUnit) in which the size is given.

reversePosition - if set to true the split splitter position is measured by the second region else it is measured by the first region

getSplitPosition

float getSplitPosition()

Returns:

position of the splitter.

getSplitPositionUnit

@Deprecated
int getSplitPositionUnit()

Deprecated.

Returns:

unit of the splitter position. See Component.UNITS_PIXELS and Component.UNITS_PERCENTAGE

getSplitPositionSizeUnit

SizeUnit getSplitPositionSizeUnit()

Returns the unit of position of the splitter.

Returns:

unit of position of the splitter

isSplitPositionReversed

boolean isSplitPositionReversed()

Return from which side position is set.

setMinSplitPosition

@Deprecated
void setMinSplitPosition(int pos,
                                     int unit)

Deprecated. Use setMinSplitPosition(int, SizeUnit)

Set minimum available position of split. Minimum position of split will be set from the right if position is reversed.

setMinSplitPosition

void setMinSplitPosition(int pos,
                         SizeUnit unit)

Sets the minimum split position to the given position and unit. If the split position is reversed, maximum and minimum are also reversed.

Parameters:

pos - the new size of the first region.

unit - the unit (from SizeUnit) in which the size is given.

getMinSplitPosition

float getMinSplitPosition()

Returns the minimum position of the splitter.

Returns:

minimum position of the splitter

getMinSplitPositionSizeUnit

SizeUnit getMinSplitPositionSizeUnit()

Returns the unit of the minimum position of the splitter.

Returns:

unit of the minimum position of the splitter

setMaxSplitPosition

@Deprecated
void setMaxSplitPosition(int pos,
                                     int unit)

Deprecated. Use setMaxSplitPosition(int, SizeUnit)

Set maximum available position of split. Maximum position of split will be set from the right if position is reversed.

setMaxSplitPosition

void setMaxSplitPosition(int pos,
                         SizeUnit unit)

Sets the maximum split position to the given position and unit. If the split position is reversed, maximum and minimum are also reversed.

Parameters:

pos - the new size of the first region.

unit - the unit (from SizeUnit) in which the size is given.

getMaxSplitPosition

float getMaxSplitPosition()

Returns the maximum position of the splitter.

Returns:

maximum position of the splitter

getMaxSplitPositionSizeUnit

SizeUnit getMaxSplitPositionSizeUnit()

Returns the unit of the maximum position of the splitter.

Returns:

unit of the maximum position of the splitter

setLocked

void setLocked(boolean locked)

Sets whether users are able to change the separator position or not.

Parameters:

locked - locked

isLocked

boolean isLocked()

Returns:

whether users are able to change the separator position or not.

setDockable

void setDockable(boolean dockable)

Enables or disables SplitPanel dock button.

Parameters:

dockable - dockable

isDockable

boolean isDockable()

Returns:

whether dock button is enabled or not

setDockMode

void setDockMode(SplitPanel.DockMode dockMode)

Sets docking direction.

Parameters:

dockMode - one of SplitPanel.DockMode options

getDockMode

@Nullable
SplitPanel.DockMode getDockMode()

Returns:

docking direction

addSplitPositionChangeListener

Subscription addSplitPositionChangeListener(java.util.function.Consumer<SplitPanel.SplitPositionChangeEvent> listener)

Adds a listener for SplitPanel.SplitPositionChangeEvents fired by a SplitPanel.

Parameters:

listener - a listener to add

removeSplitPositionChangeListener

@Deprecated
void removeSplitPositionChangeListener(java.util.function.Consumer<SplitPanel.SplitPositionChangeEvent> listener)

Deprecated. Use Subscription instead