com.google.gwt.layout.client

Class Layout.Layer

java.lang.Object

com.google.gwt.layout.client.Layout.Layer

Enclosing class:

Layout

public class Layout.Layer
extends Object

This class is used to set the position and size of child elements.

Each child element has three values associated with each axis: {left, right, width} on the horizontal axis, and {top, bottom, height} on the vertical axis. Precisely two of three values may be set at a time, or the system will be over- or under-contrained. For this reason, the following methods are provided for setting these values:

• setLeftRight(double, com.google.gwt.dom.client.Style.Unit, double, com.google.gwt.dom.client.Style.Unit)
• setLeftWidth(double, com.google.gwt.dom.client.Style.Unit, double, com.google.gwt.dom.client.Style.Unit)
• setRightWidth(double, com.google.gwt.dom.client.Style.Unit, double, com.google.gwt.dom.client.Style.Unit)
• setTopBottom(double, com.google.gwt.dom.client.Style.Unit, double, com.google.gwt.dom.client.Style.Unit)
• setTopHeight(double, com.google.gwt.dom.client.Style.Unit, double, com.google.gwt.dom.client.Style.Unit)
• setBottomHeight(double, com.google.gwt.dom.client.Style.Unit, double, com.google.gwt.dom.client.Style.Unit)

By default, each layer is set to fill the entire parent (i.e., {left, top, right, bottom} = {0, 0, 0, 0}).

Method Summary

Methods

Modifier and Type	Method and Description
Element	getContainerElement() Gets the container element associated with this layer.
Object	getUserObject() Gets the user-data associated with this layer.
void	setBottomHeight(double bottom, Style.Unit bottomUnit, double height, Style.Unit heightUnit) Sets the layer's bottom and height values.
void	setChildHorizontalPosition(Layout.Alignment position) Sets the child element's horizontal position within the layer.
void	setChildVerticalPosition(Layout.Alignment position) Sets the child element's vertical position within the layer.
void	setLeftRight(double left, Style.Unit leftUnit, double right, Style.Unit rightUnit) Sets the layer's left and right values.
void	setLeftWidth(double left, Style.Unit leftUnit, double width, Style.Unit widthUnit) Sets the layer's left and width values.
void	setRightWidth(double right, Style.Unit rightUnit, double width, Style.Unit widthUnit) Sets the layer's right and width values.
void	setTopBottom(double top, Style.Unit topUnit, double bottom, Style.Unit bottomUnit) Sets the layer's top and bottom values.
void	setTopHeight(double top, Style.Unit topUnit, double height, Style.Unit heightUnit) Sets the layer's top and height values.
void	setVisible(boolean visible) Sets the layer's visibility.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Method Detail

getContainerElement

public Element getContainerElement()

Gets the container element associated with this layer.

This is the element that sits between the parent and child elements. It is normally necessary to operate on this element only when you need to modify CSS properties that are not directly modeled by the Layer class.

Returns:

the container element

getUserObject

public Object getUserObject()

Gets the user-data associated with this layer.

Returns:

the layer's user-data object

setBottomHeight

public void setBottomHeight(double bottom,
                   Style.Unit bottomUnit,
                   double height,
                   Style.Unit heightUnit)

Sets the layer's bottom and height values.

Parameters:

bottom -

bottomUnit -

height -

heightUnit -

setChildHorizontalPosition

public void setChildHorizontalPosition(Layout.Alignment position)

Sets the child element's horizontal position within the layer.

Parameters:

position -

setChildVerticalPosition

public void setChildVerticalPosition(Layout.Alignment position)

Sets the child element's vertical position within the layer.

Parameters:

position -

setLeftRight

public void setLeftRight(double left,
                Style.Unit leftUnit,
                double right,
                Style.Unit rightUnit)

Sets the layer's left and right values.

Parameters:

left -

leftUnit -

right -

rightUnit -

setLeftWidth

public void setLeftWidth(double left,
                Style.Unit leftUnit,
                double width,
                Style.Unit widthUnit)

Sets the layer's left and width values.

Parameters:

left -

leftUnit -

width -

widthUnit -

setRightWidth

public void setRightWidth(double right,
                 Style.Unit rightUnit,
                 double width,
                 Style.Unit widthUnit)

Sets the layer's right and width values.

Parameters:

right -

rightUnit -

width -

widthUnit -

setTopBottom

public void setTopBottom(double top,
                Style.Unit topUnit,
                double bottom,
                Style.Unit bottomUnit)

Sets the layer's top and bottom values.

Parameters:

top -

topUnit -

bottom -

bottomUnit -

setTopHeight

public void setTopHeight(double top,
                Style.Unit topUnit,
                double height,
                Style.Unit heightUnit)

Sets the layer's top and height values.

Parameters:

top -

topUnit -

height -

heightUnit -

setVisible

public void setVisible(boolean visible)

Sets the layer's visibility.

Parameters:

visible -