Package com.vaadin.flow.component.masterdetaillayout

Class MasterDetailLayout

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.masterdetaillayout.MasterDetailLayout
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, RouterLayout, Serializable
@Tag("vaadin-master-detail-layout") @NpmPackage(value="@vaadin/master-detail-layout", version="25.2.0-beta1") @JsModule("@vaadin/master-detail-layout/src/vaadin-master-detail-layout.js") public class MasterDetailLayout extends Component implements HasSize, RouterLayout
MasterDetailLayout is a component for building UIs with a master (or primary) area and a detail (or secondary) area that is displayed next to, or overlaid on top of, the master area, depending on configuration and viewport size.
Author:
Vaadin Ltd
See Also:

  • Field Details

  • Constructor Details

    • MasterDetailLayout

      public MasterDetailLayout()
      Creates an empty Master Detail Layout.

    • MasterDetailLayout

      public MasterDetailLayout(String masterSize, String detailSize)
      Creates a Master Detail Layout with the given master and detail sizes.
      Parameters:
      masterSize - the size of the master area in CSS length units
      detailSize - the size of the detail area in CSS length units

    • MasterDetailLayout

      public MasterDetailLayout(float masterSize, Unit masterUnit, float detailSize, Unit detailUnit)
      Creates a Master Detail Layout with the given master and detail sizes.
      Parameters:
      masterSize - the size of the master area
      masterUnit - the unit for the master size
      detailSize - the size of the detail area
      detailUnit - the unit for the detail size

  • Method Details

    • getMaster

      public Component getMaster()
      Gets the component currently in the master area.
      Returns:
      the component in the master area, or null if there is no component in the master area

    • setMaster

      public void setMaster(Component component)
      Sets the component to be displayed in the master area.
      Parameters:
      component - the component to display in the master area, not null

    • getDetail

      public Component getDetail()
      Gets the component currently in the detail area.
      Returns:
      the component in the detail area, or null if there is no component in the detail area

    • setDetail

      public void setDetail(Component component)
      Sets the component to be displayed in the detail area. The details area is automatically shown when the detail component is set, and hidden when the detail component is removed by setting it to null.
      Parameters:
      component - the component to display in the detail area, or null to clear the detail area

    • getDetailPlaceholder

      public Component getDetailPlaceholder()
      Gets the component currently in the detail placeholder area.
      Returns:
      the component in the detail placeholder area, or null if there is no component in the detail placeholder area

    • setDetailPlaceholder

      public void setDetailPlaceholder(Component component)
      Sets the component to be displayed in the detail placeholder area. The placeholder is shown when no detail content is set, and is hidden when the layout is in overlay mode. Unlike the detail content, the placeholder does not become an overlay when there is not enough space.
      Parameters:
      component - the component to display in the detail placeholder area, or null to clear the detail placeholder area

    • onAttach

      protected void onAttach(AttachEvent attachEvent)
      Description copied from class: Component
      Called when the component is attached to a UI.

      This method is invoked before the AttachEvent is fired for the component. Make sure to call super.onAttach when overriding this method.

      Overrides:
      onAttach in class Component
      Parameters:
      attachEvent - the attach event

    • onDetach

      protected void onDetach(DetachEvent detachEvent)
      Description copied from class: Component
      Called when the component is detached from a UI.

      This method is invoked before the DetachEvent is fired for the component.

      Make sure to call super.onDetach when overriding this method.

      Overrides:
      onDetach in class Component
      Parameters:
      detachEvent - the detach event

    • getMasterSize

      public String getMasterSize()
      Gets the size of the master area.
      Returns:
      the size of the master area in CSS length units, or null if the size is not set

    • setMasterSize

      public void setMasterSize(String size)
      Sets the size of the master area in CSS length units. If there is not enough space to show master and detail areas next to each other, the detail area is shown as an overlay. Defaults to 30em.
      Parameters:
      size - the size of the master area in CSS length units

    • setMasterSize

      public void setMasterSize(float size, Unit unit)
      Sets the size of the master area in CSS length units. If there is not enough space to show master and detail areas next to each other, the detail area is shown as an overlay. Defaults to 30em.
      Parameters:
      size - the size of the master area
      unit - the unit

    • setMasterSize

      public void setMasterSize(String size, boolean expand)
      Sets the size of the master area in CSS length units and whether the master area expands to fill available space.
      Parameters:
      size - the size of the master area in CSS length units
      expand - true to expand the master area, false otherwise
      See Also:

    • setMasterSize

      public void setMasterSize(float size, Unit unit, boolean expand)
      Sets the size of the master area in CSS length units and whether the master area expands to fill available space.
      Parameters:
      size - the size of the master area
      unit - the unit
      expand - true to expand the master area, false otherwise
      See Also:

    • getDetailSize

      public String getDetailSize()
      Gets the size of the detail area.
      Returns:
      the size of the detail area in CSS length units, or null if the size is not set

    • setDetailSize

      public void setDetailSize(String size)
      Sets the size of the detail area in CSS length units. When there is not enough space to show master and detail areas next to each other, the detail area is shown as an overlay.

      If not specified, the size is determined automatically by measuring the detail content whenever new content is provided via setDetail(com.vaadin.flow.component.Component). The measured intrinsic size is then cached until the next setDetail(com.vaadin.flow.component.Component) call.

      Parameters:
      size - the size of the detail area in CSS length units

    • setDetailSize

      public void setDetailSize(float size, Unit unit)
      Sets the size of the detail area in CSS length units. When there is not enough space to show master and detail areas next to each other, the detail area is shown as an overlay.

      If not specified, the size is determined automatically by measuring the detail content whenever new content is provided via setDetail(com.vaadin.flow.component.Component). The measured intrinsic size is then cached until the next setDetail(com.vaadin.flow.component.Component) call.

      Parameters:
      size - the size of the detail area
      unit - the unit

    • setDetailSize

      public void setDetailSize(String size, boolean expand)
      Sets the size of the detail area in CSS length units and whether the detail area expands to fill available space.
      Parameters:
      size - the size of the detail area in CSS length units
      expand - true to expand the detail area, false otherwise
      See Also:

    • setDetailSize

      public void setDetailSize(float size, Unit unit, boolean expand)
      Sets the size of the detail area in CSS length units and whether the detail area expands to fill available space.
      Parameters:
      size - the size of the detail area
      unit - the unit
      expand - true to expand the detail area, false otherwise
      See Also:

    • setDetailSize

      public void setDetailSize(String size, String overlaySize)
      Sets the size of the detail area and the size of the detail area when shown as an overlay, both in CSS length units.
      Parameters:
      size - the size of the detail area in CSS length units
      overlaySize - the overlay size in CSS length units
      See Also:

    • setDetailSize

      public void setDetailSize(float size, Unit unit, float overlaySize, Unit overlayUnit)
      Sets the size of the detail area and the size of the detail area when shown as an overlay, both in CSS length units.
      Parameters:
      size - the size of the detail area
      unit - the unit for the detail size
      overlaySize - the overlay size
      overlayUnit - the unit for the overlay size
      See Also:

    • setDetailSize

      public void setDetailSize(String size, boolean expand, String overlaySize)
      Sets the size of the detail area in CSS length units, whether the detail area expands to fill available space, and the size of the detail area when shown as an overlay.
      Parameters:
      size - the size of the detail area in CSS length units
      expand - true to expand the detail area, false otherwise
      overlaySize - the overlay size in CSS length units
      See Also:

    • setDetailSize

      public void setDetailSize(float size, Unit unit, boolean expand, float overlaySize, Unit overlayUnit)
      Sets the size of the detail area, whether the detail area expands to fill available space, and the size of the detail area when shown as an overlay.
      Parameters:
      size - the size of the detail area
      unit - the unit for the detail size
      expand - true to expand the detail area, false otherwise
      overlaySize - the overlay size
      overlayUnit - the unit for the overlay size
      See Also:

    • getOrientation

      public MasterDetailLayout.Orientation getOrientation()
      Gets the orientation of the layout. Defaults to MasterDetailLayout.Orientation.HORIZONTAL.
      Returns:
      the orientation

    • setOrientation

      public void setOrientation(MasterDetailLayout.Orientation orientation)
      Sets the orientation of the layout. Defines how master and detail areas are shown next to each other, and whether size is applied as width or height.
      Parameters:
      orientation - the orientation

    • getOverlayContainment

      public MasterDetailLayout.OverlayContainment getOverlayContainment()
      Gets the overlay containment of the layout. Defaults to MasterDetailLayout.OverlayContainment.LAYOUT.
      Returns:
      the overlay containment

    • setOverlayContainment

      public void setOverlayContainment(MasterDetailLayout.OverlayContainment overlayContainment)
      Sets the containment of the detail area when the layout is in overlay mode. When set to MasterDetailLayout.OverlayContainment.LAYOUT, the overlay is confined to the layout. When set to MasterDetailLayout.OverlayContainment.PAGE, the overlay is confined to the browser's viewport. Defaults to MasterDetailLayout.OverlayContainment.LAYOUT.
      Parameters:
      overlayContainment - the overlay containment

    • getOverlaySize

      public String getOverlaySize()
      Gets the size of the detail area when shown as an overlay.
      Returns:
      the overlay size in CSS length units, or null if the overlay size is not set

    • setOverlaySize

      public void setOverlaySize(String size)
      Sets the size of the detail area when shown as an overlay. When not set, falls back to the detail size. Set to "100%" to make the detail cover the full layout.
      Parameters:
      size - the overlay size in CSS length units

    • setOverlaySize

      public void setOverlaySize(float size, Unit unit)
      Sets the size of the detail area when shown as an overlay. When not set, falls back to the detail size. Set to 100 with
      invalid reference 
      Unit#PCT
      to make the detail cover the full layout.
      Parameters:
      size - the overlay size
      unit - the unit

    • isExpandMaster

      public boolean isExpandMaster()
      Gets whether the master area expands to fill available space. Defaults to false.
      Returns:
      true if the master area expands, false otherwise

    • setExpandMaster

      public void setExpandMaster(boolean expandMaster)
      Sets whether the master area expands to fill available space. When both setExpandMaster(boolean) and setExpandDetail(boolean) are set to true, the master and detail areas share the available space equally.
      Parameters:
      expandMaster - true to expand the master area, false otherwise

    • isExpandDetail

      public boolean isExpandDetail()
      Gets whether the detail area expands to fill available space. Defaults to false.
      Returns:
      true if the detail area expands, false otherwise

    • setExpandDetail

      public void setExpandDetail(boolean expandDetail)
      Sets whether the detail area expands to fill available space. When both setExpandMaster(boolean) and setExpandDetail(boolean) are set to true, the master and detail areas share the available space equally.
      Parameters:
      expandDetail - true to expand the detail area, false otherwise

    • isForceOverlay

      public boolean isForceOverlay()
      Gets whether the layout forces the detail area to be shown as an overlay, even if there is enough space for master and detail to be shown next to each other using the default (split) mode.
      Returns:
      true if the overlay mode is enforced, false otherwise

    • setForceOverlay

      public void setForceOverlay(boolean forceOverlay)
      Sets whether the layout forces the detail area to be shown as an overlay, even if there is enough space for master and detail to be shown next to each other using the default (split) mode.
      Parameters:
      forceOverlay - true if the overlay mode is enforced, false otherwise

    • isAnimationEnabled

      public boolean isAnimationEnabled()
      Gets whether the layout animation is enabled.
      Returns:
      true if the animation is enabled, false otherwise

    • setAnimationEnabled

      public void setAnimationEnabled(boolean enabled)
      Sets whether the layout animation is enabled.
      Parameters:
      enabled - true if the animation is enabled, false otherwise

    • addBackdropClickListener

      public Registration addBackdropClickListener(ComponentEventListener<MasterDetailLayout.BackdropClickEvent> listener)
      Adds a listener for when the backdrop of the details overlay is clicked. The backdrop is the area outside the detail area when it is shown in overlay mode. Can be used to hide the details when the backdrop is clicked.
      Parameters:
      listener - the listener to add, not null
      Returns:
      a registration for removing the listener

    • addDetailEscapePressListener

      public Registration addDetailEscapePressListener(ComponentEventListener<MasterDetailLayout.DetailEscapePressEvent> listener)
      Adds a listener for when the Escape key is pressed within the details area. Can be used to hide the details when the Escape key is pressed.
      Parameters:
      listener - the listener to add, not null
      Returns:
      a registration for removing the listener

    • showRouterLayoutContent

      public void showRouterLayoutContent(HasElement content)
      Description copied from interface: RouterLayout
      Shows the content of the layout which is the router target component annotated with a @Route.

      Note implementors should not care about old @Route content, since it's handled separately by RouterLayout.removeRouterLayoutContent(HasElement) which by default simply removes the old content.

      Specified by:
      showRouterLayoutContent in interface RouterLayout
      Parameters:
      content - the content component or null if the layout content is to be cleared.

    • removeRouterLayoutContent

      public void removeRouterLayoutContent(HasElement oldContent)
      Description copied from interface: RouterLayout
      Removes content that should no longer be shown in this router layout. If RouterLayout.showRouterLayoutContent(HasElement) was previously called with a non-null parameter, then this method will be called with the same parameter immediately before calling RouterLayout.showRouterLayoutContent(HasElement) again.

      By default, the old content is removed from its parent using Element.removeFromParent().

      Specified by:
      removeRouterLayoutContent in interface RouterLayout
      Parameters:
      oldContent - the old content to remove, not null