com.vaadin.fluent.api

Interface FluentSplitPanel<THIS extends FluentSplitPanel<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentAbstractComponentContainer<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponentContainer<THIS>, FluentContextClickNotifier<THIS>, FluentHasComponents<THIS>, FluentHasComponents.FluentComponentAttachDetachNotifier<THIS>, FluentSizeable<THIS>, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, Iterable<com.vaadin.ui.Component>, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

FHorizontalSplitPanel, FVerticalSplitPanel

public interface FluentSplitPanel<THIS extends FluentSplitPanel<THIS>>
extends FluentAbstractComponentContainer<THIS>

The base interface for fluent versions of AbstractSplitPanel

See Also:

AbstractSplitPanel

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentHasComponents

FluentHasComponents.FluentComponentAttachDetachNotifier<THIS extends FluentHasComponents<THIS>>

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
default THIS	withFirstComponent(com.vaadin.ui.Component c) Sets the first component of this split panel.
default THIS	withLocked(boolean locked) Lock the SplitPanels position, disabling the user from dragging the split handle.
default THIS	withMaxSplitPosition(float pos, com.vaadin.server.Sizeable.Unit unit) Sets the maximum split position to the given position and unit.
default THIS	withMinSplitPosition(float pos, com.vaadin.server.Sizeable.Unit unit) Sets the minimum split position to the given position and unit.
default THIS	withSecondComponent(com.vaadin.ui.Component c) Sets the second component of this split panel.
default THIS	withSplitPosition(float pos) Moves the position of the splitter.
default THIS	withSplitPosition(float pos, boolean reverse) Moves the position of the splitter.
default THIS	withSplitPosition(float pos, com.vaadin.server.Sizeable.Unit unit) Moves the position of the splitter with given position and unit.
default THIS	withSplitPosition(float pos, com.vaadin.server.Sizeable.Unit unit, boolean reverse) Moves the position of the splitter with given position and unit.
default THIS	withSplitPositionChangeListener(com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeListener listener) Add a listener to handle AbstractSplitPanel.SplitPositionChangeEvents.
default THIS	withSplitterClickListener(com.vaadin.ui.AbstractSplitPanel.SplitterClickListener listener) Add a listener to handle AbstractSplitPanel.SplitterClickEvents.

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentComponentContainer

withComponent, withComponents

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponent, addComponents, getComponentCount, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponent, replaceComponent

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.fluent.api.FluentHasComponents.FluentComponentAttachDetachNotifier

withComponentAttachListener, withComponentDetachListener

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Method Detail

withFirstComponent

default THIS withFirstComponent(com.vaadin.ui.Component c)

Sets the first component of this split panel. Depending on the direction the first component is shown at the top or to the left.

Parameters:

c - The component to use as first component

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setFirstComponent(Component)

withSecondComponent

default THIS withSecondComponent(com.vaadin.ui.Component c)

Sets the second component of this split panel. Depending on the direction the second component is shown at the bottom or to the right.

Parameters:

c - The component to use as second component

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setSecondComponent(Component)

withLocked

default THIS withLocked(boolean locked)

Lock the SplitPanels position, disabling the user from dragging the split handle.

Parameters:

locked - Set true if locked, false otherwise.

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setLocked(boolean)

withMinSplitPosition

default THIS withMinSplitPosition(float pos,
                                  com.vaadin.server.Sizeable.Unit 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 minimum position of the split

unit - the unit (from Sizeable) in which the size is given. Allowed units are UNITS_PERCENTAGE and UNITS_PIXELS

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setMinSplitPosition(float, com.vaadin.server.Sizeable.Unit)

withMaxSplitPosition

default THIS withMaxSplitPosition(float pos,
                                  com.vaadin.server.Sizeable.Unit 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 maximum position of the split

unit - the unit (from Sizeable) in which the size is given. Allowed units are UNITS_PERCENTAGE and UNITS_PIXELS

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setMaxSplitPosition(float, com.vaadin.server.Sizeable.Unit)

withSplitPosition

default THIS withSplitPosition(float pos)

Moves the position of the splitter.

Parameters:

pos - the new size of the first region in the unit that was last used (default is percentage). Fractions are only allowed when unit is percentage.

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setSplitPosition(float)

withSplitPosition

default THIS withSplitPosition(float pos,
                               boolean reverse)

Moves the position of the splitter.

Parameters:

pos - the new size of the region in the unit that was last used (default is percentage). Fractions are only allowed when unit is percentage.

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

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setSplitPosition(float, boolean)

withSplitPosition

default THIS withSplitPosition(float pos,
                               com.vaadin.server.Sizeable.Unit unit)

Moves the position of the splitter with given position and unit.

Parameters:

pos - the new size of the first region. Fractions are only allowed when unit is percentage.

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

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setSplitPosition(float, com.vaadin.server.Sizeable.Unit)

withSplitPosition

default THIS withSplitPosition(float pos,
                               com.vaadin.server.Sizeable.Unit unit,
                               boolean reverse)

Moves the position of the splitter with given position and unit.

Parameters:

pos - the new size of the first region. Fractions are only allowed when unit is percentage.

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

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

Returns:

this for method chaining

See Also:

AbstractSplitPanel.setSplitPosition(float, com.vaadin.server.Sizeable.Unit, boolean)

withSplitPositionChangeListener

default THIS withSplitPositionChangeListener(com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeListener listener)

Add a listener to handle AbstractSplitPanel.SplitPositionChangeEvents.

Parameters:

listener - AbstractSplitPanel.SplitPositionChangeListener to be registered.

Returns:

this for method chaining

See Also:

AbstractSplitPanel.addSplitPositionChangeListener(SplitPositionChangeListener)

withSplitterClickListener

default THIS withSplitterClickListener(com.vaadin.ui.AbstractSplitPanel.SplitterClickListener listener)

Add a listener to handle AbstractSplitPanel.SplitterClickEvents.

Parameters:

listener - AbstractSplitPanel.SplitterClickListener to be registered.

Returns:

this for method chaining

See Also:

AbstractSplitPanel.addSplitterClickListener(SplitterClickListener)