com.haulmont.cuba.gui.components

Interface SplitPanel

All Superinterfaces:

Component, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.HasSettings

public interface SplitPanel
extends Component.Container, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, Component.HasSettings

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SplitPanel.DockMode Specifies SplitPanel docking direction.
static interface	SplitPanel.PositionUpdateListener Deprecated. Use SplitPanel.SplitPositionChangeListener
static class	SplitPanel.SplitPositionChangeEvent Event that indicates a change in SplitPanel's splitter position.
static interface	SplitPanel.SplitPositionChangeListener Interface for listening for SplitPanel.SplitPositionChangeEvents fired by a SplitPanel.

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addSplitPositionChangeListener(SplitPanel.SplitPositionChangeListener listener)
SplitPanel.DockMode	getDockMode()
int	getOrientation()
SplitPanel.PositionUpdateListener	getPositionUpdateListener() Deprecated. Use removeSplitPositionChangeListener(com.haulmont.cuba.gui.components.SplitPanel.SplitPositionChangeListener)
float	getSplitPosition()
int	getSplitPositionUnit()
boolean	isDockable()
boolean	isLocked()
boolean	isSplitPositionReversed() Return from which side position is set.
void	removeSplitPositionChangeListener(SplitPanel.SplitPositionChangeListener listener)
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) Set maximum available position of split.
void	setMinSplitPosition(int pos, int unit) Set minimum available position of split.
void	setOrientation(int orientation)
void	setPositionUpdateListener(SplitPanel.PositionUpdateListener positionListener) Deprecated. Use addSplitPositionChangeListener(com.haulmont.cuba.gui.components.SplitPanel.SplitPositionChangeListener)
void	setSplitPosition(int pos)
void	setSplitPosition(int pos, int unit)
void	setSplitPosition(int pos, int unit, boolean reversePosition) Set position of split from the left side by default.

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

add, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, 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, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

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

getIcon, setIcon, setIconFromSet

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

getCaption, getDescription, setCaption, setDescription

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

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

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

void setSplitPosition(int pos,
                      int unit)

setSplitPosition

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

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

getSplitPosition

float getSplitPosition()

Returns:

position of the splitter.

getSplitPositionUnit

int getSplitPositionUnit()

Returns:

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

isSplitPositionReversed

boolean isSplitPositionReversed()

Return from which side position is set.

setMinSplitPosition

void setMinSplitPosition(int pos,
                         int unit)

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

setMaxSplitPosition

void setMaxSplitPosition(int pos,
                         int unit)

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

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.

Notice that docking is available only for horizontally oriented SplitPanel.

Parameters:

dockable - dockable

isDockable

boolean isDockable()

Returns:

whether dock button is enabled or not

setDockMode

void setDockMode(SplitPanel.DockMode dockMode)

Sets docking direction.

Notice that docking is available only for horizontally oriented SplitPanel.

Parameters:

dockMode - one of SplitPanel.DockMode options

getDockMode

@Nullable
SplitPanel.DockMode getDockMode()

Returns:

docking direction or null in case of vertically oriented SplitPanel

setPositionUpdateListener

@Deprecated
void setPositionUpdateListener(SplitPanel.PositionUpdateListener positionListener)

Deprecated. Use addSplitPositionChangeListener(com.haulmont.cuba.gui.components.SplitPanel.SplitPositionChangeListener)

getPositionUpdateListener

@Deprecated
SplitPanel.PositionUpdateListener getPositionUpdateListener()

Deprecated. Use removeSplitPositionChangeListener(com.haulmont.cuba.gui.components.SplitPanel.SplitPositionChangeListener)

addSplitPositionChangeListener

void addSplitPositionChangeListener(SplitPanel.SplitPositionChangeListener listener)

removeSplitPositionChangeListener

void removeSplitPositionChangeListener(SplitPanel.SplitPositionChangeListener listener)