com.vaadin.flow.component.splitlayout.
Class SplitLayout
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.splitlayout.GeneratedVaadinSplitLayout<SplitLayout>
-
- com.vaadin.flow.component.splitlayout.SplitLayout
-
All Implemented Interfaces:
AttachNotifier
,ClickNotifier<SplitLayout>
,DetachNotifier
,HasElement
,HasSize
,HasStyle
,HasTheme
,Serializable
@NpmPackage(value="@vaadin/split-layout",version="23.5.12") @NpmPackage(value="@vaadin/vaadin-split-layout",version="23.5.12") public class SplitLayout extends GeneratedVaadinSplitLayout<SplitLayout> implements HasSize
Split Layout is a component with two content areas and a draggable split handle between them.
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SplitLayout.Orientation
numeration of all available orientation for VaadinSplitLayout component
static class
SplitLayout.SplitterDragendEvent<T extends GeneratedVaadinSplitLayout<T>>
-
Nested classes/interfaces inherited from class com.vaadin.flow.component.splitlayout.GeneratedVaadinSplitLayout
GeneratedVaadinSplitLayout.IronResizeEvent<R extends GeneratedVaadinSplitLayout<R>>
-
-
Constructor Summary
Constructors Constructor Description SplitLayout()
Constructs an empty SplitLayout.
SplitLayout(Component primaryComponent, Component secondaryComponent)
Constructs a SplitLayout with the given initial components to set to the primary and secondary splits.
SplitLayout(Component primaryComponent, Component secondaryComponent, SplitLayout.Orientation orientation)
Constructs a SplitLayout with the given initial components to set to the primary and secondary splits and with the orientation.
SplitLayout(SplitLayout.Orientation orientation)
Constructs a SplitLayout with the orientation.
-
Method Summary
All Methods Modifier and Type Method Description Registration
addSplitterDragendListener(ComponentEventListener<SplitLayout.SplitterDragendEvent<SplitLayout>> listener)
Adds a listener for the
splitter-dragend
event, which is fired when the user has stopped resizing the splitter with drag and drop.void
addThemeVariants(SplitLayoutVariant... variants)
Adds theme variants to the component.
void
addToPrimary(Component... components)
Sets the given components to the primary split of this layout, i.e.
void
addToSecondary(Component... components)
Sets the given components to the secondary split of this layout, i.e.
SplitLayout.Orientation
getOrientation()
Get the orientation of the SplitLayout.
Component
getPrimaryComponent()
Get the component currently set to the primary split.
Component
getSecondaryComponent()
Get the component currently set to the secondary split.
void
remove(Component... components)
Removes the given child components from this component.
void
removeAll()
Removes the primary and the secondary components.
void
removeThemeVariants(SplitLayoutVariant... variants)
Removes theme variants from the component.
void
setOrientation(SplitLayout.Orientation orientation)
Set the orientation of the SplitLayout.
void
setPrimaryStyle(String styleName, String value)
Set a style to the component in the primary split.
void
setSecondaryStyle(String styleName, String value)
Set a style to the component in the secondary split.
void
setSplitterPosition(double position)
Sets the relative position of the splitter in percentages.
-
Methods inherited from class com.vaadin.flow.component.splitlayout.GeneratedVaadinSplitLayout
addIronResizeListener, getOrientationString, setOrientation
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.ClickNotifier
addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
Methods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
-
-
-
Constructor Detail
-
SplitLayout
public SplitLayout()
Constructs an empty SplitLayout.
-
SplitLayout
public SplitLayout(Component primaryComponent, Component secondaryComponent)
Constructs a SplitLayout with the given initial components to set to the primary and secondary splits.
Parameters:
primaryComponent
- the component set to the primary splitsecondaryComponent
- the component set to the secondary split
-
SplitLayout
public SplitLayout(SplitLayout.Orientation orientation)
Constructs a SplitLayout with the orientation.
Parameters:
orientation
- the orientation set to the layout
-
SplitLayout
public SplitLayout(Component primaryComponent, Component secondaryComponent, SplitLayout.Orientation orientation)
Constructs a SplitLayout with the given initial components to set to the primary and secondary splits and with the orientation.
Parameters:
primaryComponent
- the component set to the primary splitsecondaryComponent
- the component set to the secondary splitorientation
- the orientation set to the layout
-
-
Method Detail
-
setOrientation
public void setOrientation(SplitLayout.Orientation orientation)
Set the orientation of the SplitLayout.
Default value is
SplitLayout.Orientation.HORIZONTAL
.Parameters:
orientation
- the orientation of the SplitLayout. Valid enumerate values are VERTICAL and HORIZONTAL, nevernull
-
getOrientation
public SplitLayout.Orientation getOrientation()
Get the orientation of the SplitLayout.
Default value is
SplitLayout.Orientation.HORIZONTAL
.NOTE: This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
orientation
property of the SplitLayout.
-
addToPrimary
public void addToPrimary(Component... components)
Sets the given components to the primary split of this layout, i.e. the left split if in horizontal mode and the top split if in vertical mode.
Note: Calling this method with multiple arguments will wrap the components inside a
<div>
element.Note: Removing the primary component through the component API will move the secondary component to the primary split, causing this layout to desync with the server. This is a known issue.
Overrides:
addToPrimary
in classGeneratedVaadinSplitLayout<SplitLayout>
Parameters:
components
- The components to add.See Also:
-
getPrimaryComponent
public Component getPrimaryComponent()
Get the component currently set to the primary split.
Returns:
the primary component, may be null
-
addToSecondary
public void addToSecondary(Component... components)
Sets the given components to the secondary split of this layout, i.e. the right split if in horizontal mode and the bottom split if in vertical mode.
Note: Calling this method with multiple arguments will wrap the components inside a
<div>
element.Overrides:
addToSecondary
in classGeneratedVaadinSplitLayout<SplitLayout>
Parameters:
components
- The components to add.See Also:
-
getSecondaryComponent
public Component getSecondaryComponent()
Get the component currently set to the secondary split.
Returns:
the primary component, may be null
-
setSplitterPosition
public void setSplitterPosition(double position)
Sets the relative position of the splitter in percentages. The given value is used to set how much space is given to the primary component relative to the secondary component. In horizontal mode this is the width of the component and in vertical mode this is the height. The given value will automatically be clamped to the range [0, 100]. Note that when using vertical orientation, this method only works if the split layout has an explicit height, either as an absolute value or as percentage. When using a percentage value, ensure that ancestors have an explicit height as well.
Parameters:
position
- the relative position of the splitter, in percentages
-
setPrimaryStyle
public void setPrimaryStyle(String styleName, String value)
Set a style to the component in the primary split.
Parameters:
styleName
- name of the style to setvalue
- the value to set
-
setSecondaryStyle
public void setSecondaryStyle(String styleName, String value)
Set a style to the component in the secondary split.
Parameters:
styleName
- name of the style to setvalue
- the value to set
-
remove
public void remove(Component... components)
Description copied from class:
GeneratedVaadinSplitLayout
Removes the given child components from this component.
Overrides:
remove
in classGeneratedVaadinSplitLayout<SplitLayout>
Parameters:
components
- The components to remove.
-
removeAll
public void removeAll()
Removes the primary and the secondary components.
Overrides:
removeAll
in classGeneratedVaadinSplitLayout<SplitLayout>
-
addSplitterDragendListener
public Registration addSplitterDragendListener(ComponentEventListener<SplitLayout.SplitterDragendEvent<SplitLayout>> listener)
Adds a listener for the
splitter-dragend
event, which is fired when the user has stopped resizing the splitter with drag and drop.Overrides:
addSplitterDragendListener
in classGeneratedVaadinSplitLayout<SplitLayout>
Parameters:
listener
- the listener to addReturns:
a registration for removing the listener
-
addThemeVariants
public void addThemeVariants(SplitLayoutVariant... variants)
Adds theme variants to the component.
Overrides:
addThemeVariants
in classGeneratedVaadinSplitLayout<SplitLayout>
Parameters:
variants
- theme variants to add
-
removeThemeVariants
public void removeThemeVariants(SplitLayoutVariant... variants)
Removes theme variants from the component.
Overrides:
removeThemeVariants
in classGeneratedVaadinSplitLayout<SplitLayout>
Parameters:
variants
- theme variants to remove
-
-