Package com.vaadin.ui

Class GridLayout.Area

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    GridLayout
    public class GridLayout.Area
extends java.lang.Object
implements java.io.Serializable
    Defines a rectangular area of cells in a GridLayout.

    Also maintains a reference to the component contained in the area.

    The area is specified by the cell coordinates of its upper left corner (column1,row1) and lower right corner (column2,row2). As otherwise with GridLayout, the column and row coordinates start from zero.

    Since:
    3.0
    Author:
    Vaadin Ltd.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Area​(com.vaadin.shared.ui.gridlayout.GridLayoutState.ChildComponentData childData, Component component)  
      Area​(Component component, int column1, int row1, int column2, int row2)
      Construct a new area on a grid.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getColumn1()
      Gets the column of the top-left corner cell.
      int getColumn2()
      Gets the column of the bottom-right corner cell.
      Component getComponent()
      Gets the component connected to the area.
      int getRow1()
      Gets the row of the top-left corner cell.
      int getRow2()
      Gets the row of the bottom-right corner cell.
      boolean overlaps​(GridLayout.Area other)
      Tests if this Area overlaps with another Area.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Area

        public Area​(Component component,
            int column1,
            int row1,
            int column2,
            int row2)

        Construct a new area on a grid.

        Parameters:
        component - the component connected to the area.
        column1 - The column of the upper left corner cell of the area. The leftmost column has index 0.
        row1 - The row of the upper left corner cell of the area. The topmost row has index 0.
        column2 - The column of the lower right corner cell of the area. The leftmost column has index 0.
        row2 - The row of the lower right corner cell of the area. The topmost row has index 0.

      • Area

        public Area​(com.vaadin.shared.ui.gridlayout.GridLayoutState.ChildComponentData childData,
            Component component)

    • Method Detail

      • overlaps

        public boolean overlaps​(GridLayout.Area other)
        Tests if this Area overlaps with another Area.
        Parameters:
        other - the other Area that is to be tested for overlap with this area
        Returns:
        true if other area overlaps with this on, false if it does not.

      • getComponent

        public Component getComponent()
        Gets the component connected to the area.
        Returns:
        the Component.

      • getColumn1

        public int getColumn1()
        Gets the column of the top-left corner cell.
        Returns:
        the column of the top-left corner cell.

      • getColumn2

        public int getColumn2()
        Gets the column of the bottom-right corner cell.
        Returns:
        the column of the bottom-right corner cell.

      • getRow1

        public int getRow1()
        Gets the row of the top-left corner cell.
        Returns:
        the row of the top-left corner cell.

      • getRow2

        public int getRow2()
        Gets the row of the bottom-right corner cell.
        Returns:
        the row of the bottom-right corner cell.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object