Class GoldenLayout

    • Constructor Detail

      • GoldenLayout

        public GoldenLayout()
    • Method Detail

      • getAreas

        public java.lang.String getAreas()
        Gets the current areas template as String.
        Returns:
        the current areas template as String.
      • setAreas

        public void setAreas​(java.lang.String areas)
        Sets a matrix-like areas template, supports only on initial rendering. Notice that areas is only supported for the initial rendering.
        Parameters:
        areas - the template of the goldenlayout.
      • getOrient

        public java.lang.String getOrient()
        Returns:
        the layout dividing orientation.
      • setOrient

        public void setOrient​(java.lang.String orient)
        Sets the initial dividing orientation. vertical: divides to rows to layout vertically first
            
            
            
        horizontal: divides to columns to layout horizontally first
                      
        Parameters:
        orient - "vertical" or "horizontal"
      • getAreasNames

        public java.util.Set<java.lang.String> getAreasNames()
        Returns:
        the current used areas template names.
      • getColumnsSize

        public java.lang.Integer getColumnsSize()
        Returns:
        the size of columns of the areas.
      • getRowsSize

        public java.lang.Integer getRowsSize()
        Returns:
        the size of the rows of the areas.
      • getPanels

        public java.util.List<GoldenPanel> getPanels​(int col,
                                                     int row)
        Get the panels on the specified location.
        Parameters:
        col - the index of column of areas
        row - the index of row of areas
        Returns:
        the GoldenPanels that is on this location. Note that if the index is larger than the maximum index, it will be set to the maximum index.
      • getPanels

        public java.util.List<GoldenPanel> getPanels​(java.lang.String area)
        Get the GoldenPanels of the specified area name.
        Parameters:
        area - of the GoldenPanels
        Returns:
        GoldenPanels that has the specified name.
      • getPanel

        protected GoldenPanel getPanel​(int col,
                                       int row)
      • getPanel

        protected GoldenPanel getPanel​(java.lang.String area)
      • deletePanels

        public void deletePanels​(java.lang.String area)
        Deletes the GoldenPanels of this name.
        Parameters:
        area - of the panels to delete.
      • addPanel

        public void addPanel​(GoldenPanel goldenPanel,
                             int col,
                             int row,
                             java.lang.String region)
        Adds an GoldenPanel to the region of the GoldenPanel at the specified location. col = -1, or row = -1 means add to the region of the whole GoldenLayout. If no GoldenPanel found at the specified location, will append to the specified region of the whole GoldenLayout. If no region specified, or region not found, will append to region east.
        Parameters:
        goldenPanel - the GoldenPanel that will be added.
        col - the index of column of areas
        row - the index of row of areas
        region - north, south, east, west, stack
      • addPanel

        public void addPanel​(GoldenPanel goldenPanel,
                             java.lang.String area,
                             java.lang.String region)
        Adds an GoldenPanel to the region of the specified area GoldenPanel. If no GoldenPanel found with the specified area argument, will append to the specified region of the whole GoldenLayout. If no region specified, or region not found, will append to region east.
        Parameters:
        goldenPanel - the GoldenPanel that will be added.
        area - the area name that will be moved to.
        region - north, south, east, west, stack
      • addPanel

        public void addPanel​(GoldenPanel goldenPanel,
                             GoldenPanel targetGoldenPanel,
                             java.lang.String region)
        Adds an GoldenPanel to the region of the specified area GoldenPanel. If no region specified, or region not found, will append to region east.
        Parameters:
        goldenPanel - the GoldenPanel that will be added.
        targetGoldenPanel - the target GoldenPanel to be dropped to.
        region - north, south, east, west, stack
      • addPanelToRoot

        public void addPanelToRoot​(GoldenPanel goldenPanel,
                                   java.lang.String region)
        Adds an GoldenPanel to the region of the GoldenLayout. This adds the GoldenPanel to the specified region of the whole GoldenLayout.
        Parameters:
        goldenPanel - the GoldenPanel that will be added.
        region - north, south, east, west
      • movePanel

        public void movePanel​(GoldenPanel goldenPanel,
                              int col,
                              int row,
                              java.lang.String region)
        Moves an existing goldenpanel child of this goldenlayout to a specific location by col and row indexes. If no GoldenPanel found at the specified location, will move to the specified region of the whole GoldenLayout. If no region specified, or region not found, will move to region east.
        Parameters:
        goldenPanel - the GoldenPanel that will be moved.
        col - the col index of the location.
        row - the row index of the location.
        region - north, south, east, west, stack
      • movePanel

        public void movePanel​(GoldenPanel goldenPanel,
                              java.lang.String area,
                              java.lang.String region)
        Moves an existing goldenpanel child of this goldenlayout to a specific region of an area. If no GoldenPanel found with the specified area argument, will move to the specified region of the whole GoldenLayout. If no region specified, or region not found, will move to region east.
        Parameters:
        goldenPanel - the GoldenPanel that will be moved.
        area - the area name that will be moved to.
        region - north, south, east, west, stack
      • movePanel

        public void movePanel​(GoldenPanel goldenPanel,
                              GoldenPanel targetGoldenPanel,
                              java.lang.String region)
        Moves an existing goldenpanel child of this goldenlayout to a specific region of an area. If no region specified, or region not found, will move to region east.
        Parameters:
        goldenPanel - the GoldenPanel that will be moved.
        targetGoldenPanel - the target GoldenPanel to be dropped to.
        region - north, south, east, west, stack
      • movePanelToRoot

        public void movePanelToRoot​(GoldenPanel goldenPanel,
                                    java.lang.String region)
        Moves an GoldenPanel to the region of the GoldenLayout. This moves the GoldenPanel to the specified region of the whole GoldenLayout.
        Parameters:
        goldenPanel -
        region -
      • getAreasMatrix

        protected java.util.List<java.util.List<java.lang.String>> getAreasMatrix()
      • onCreate

        public void onCreate​(Event evt)
        Internal use only
        Since:
        8.6.0
      • updateInitialMatrix

        protected java.lang.String updateInitialMatrix​(GoldenPanel dropTarget,
                                                       java.lang.String region,
                                                       java.lang.String area)