Package org.zkoss.zkmax.zul

Class Portallayout

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl
    public class Portallayout
extends XulElement
    A portal layout lays out a container which can have multiple columns, and each column may contain one or more panel. Portal layout provides a way to drag-and-drop panel into other portalchildren from the same portal layout.

    Available in ZK EE

    Use Portallayout need assign width (either present or pixel) on every Portalchildren, or we cannot make sure about layout look.

    Events:
    onPortalMove.

    Default getZclass(): z-portallayout.

    Since:
    3.5.0
    Author:
    jumperchen
    See Also:
    Serialized Form

    • Constructor Detail

      • Portallayout

        public Portallayout()

    • Method Detail

      • setOrient

        public void setOrient​(java.lang.String orient)
               throws WrongValueException
        Sets the orient.
        Parameters:
        orient - either "horizontal" or "vertical".
        Throws:
        WrongValueException
        Since:
        7.0.0

      • getOrient

        public java.lang.String getOrient()
        Returns the orient.

        Default: vertical

        Since:
        7.0.0

      • isVertical

        public boolean isVertical()
        Returns whether it is a vertical portallayout.
        Since:
        7.0.0

      • getPanel

        public Panel getPanel​(int col,
                      int row)
        Returns the specified panel, or null if not available.
        Parameters:
        col - which Portalchildren to fetch (starting at 0).
        row - which Panel to fetch (starting at 0).

      • setPanel

        public boolean setPanel​(Panel panel,
                        int col,
                        int row)
        Sets the specified panel via the position(col and row).
        Parameters:
        panel - a new panel component
        col - which Portalchildren to fetch (starting at 0).
        row - which Panel to fetch (starting at 0).
        Returns:
        If false, the added panel fails.

      • getPosition

        public int[] getPosition​(Panel panel)
        Returns an int array[col, row] that indicates the specified panel located within this portal layout. If not found, [-1, -1] is assumed.

      • setMaximizedMode

        public void setMaximizedMode​(java.lang.String mode)
        Sets the mode of the panel to maximize according to "whole" or "column". "Whole" is meaning the size related to the portal layout itself. Otherwise, the size is related to portal children, that is called "column".

        Default: "column"

        Parameters:
        mode - the mode which could be one of "whole" and "column".
        Since:
        5.0.0

      • getMaximizedMode

        public java.lang.String getMaximizedMode()
        Returns the mode of the maximized panel.

        Default: "column"

        Since:
        5.0.0

      • onPortalDrop

        public void onPortalDrop​(PortalDropEvent event)
        Process the onPortalDrop event sent when the portal drop.

        Default: move the portal

        Since:
        9.5.1