com.itmill.toolkit.ui
Class GridLayout.Area

java.lang.Object
  extended by com.itmill.toolkit.ui.GridLayout.Area
Enclosing class:
GridLayout

public class GridLayout.Area
extends Object

This class defines an area on a grid. An Area is defined by the cells of its upper left corner (column1,row1) and lower right corner (column2,row2).

Since:
3.0
Version:
5.3.0
Author:
IT Mill Ltd.

Constructor Summary
GridLayout.Area(Component component, int column1, int row1, int column2, int row2)
           Construct a new area on a grid.
 
Method Summary
 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.
 int getX1()
          Deprecated. Use getColumn1() instead.
 int getX2()
          Deprecated. Use getColumn2() instead.
 int getY1()
          Deprecated. Use getRow1() instead.
 int getY2()
          Deprecated. Use getRow2() instead.
 boolean overlaps(GridLayout.Area other)
          Tests if the given Area overlaps with an another Area.
protected  void setComponent(Component newComponent)
          Sets the component connected to the area.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridLayout.Area

public GridLayout.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 c is supposed to occupy.
row1 - The row of the upper left corner cell of the area c is supposed to occupy.
column2 - The column of the lower right corner cell of the area c is supposed to occupy.
row2 - The row of the lower right corner cell of the area c is supposed to occupy.
Throws:
GridLayout.OverlapsException - if the new component overlaps with any of the components already in the grid
Method Detail

overlaps

public boolean overlaps(GridLayout.Area other)
Tests if the given Area overlaps with an another Area.

Parameters:
other - the Another Area that's to be tested for overlap with this area.
Returns:
true if other overlaps with this area, false if it doesn't.

getComponent

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

Returns:
the Component.

setComponent

protected void setComponent(Component newComponent)
Sets the component connected to the area.

This function only sets the value in the datastructure and does not send any events or set parents.

Parameters:
newComponent - the new connected overriding the existing one.

getX1

@Deprecated
public int getX1()
Deprecated. Use getColumn1() instead.

See Also:
com.itmill.toolkit.ui.GridLayout#getColumn1()

getColumn1

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

Returns:
the column of the top-left corner cell.

getX2

@Deprecated
public int getX2()
Deprecated. Use getColumn2() instead.

See Also:
com.itmill.toolkit.ui.GridLayout#getColumn2()

getColumn2

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

Returns:
the column of the bottom-right corner cell.

getY1

@Deprecated
public int getY1()
Deprecated. Use getRow1() instead.

See Also:
com.itmill.toolkit.ui.GridLayout#getRow1()

getRow1

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

Returns:
the row of the top-left corner cell.

getY2

@Deprecated
public int getY2()
Deprecated. Use getRow2() instead.

See Also:
com.itmill.toolkit.ui.GridLayout#getRow2()

getRow2

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

Returns:
the row of the bottom-right corner cell.


Copyright © 2000-2009 IT Mill Ltd. All Rights Reserved.