com.extjs.gxt.ui.client.widget.layout
Class BorderLayoutData

java.lang.Object
  com.extjs.gxt.ui.client.widget.layout.LayoutData
      com.extjs.gxt.ui.client.widget.layout.BorderLayoutData

public class BorderLayoutData
extends LayoutData

Layout data describing a "region" in a border panel.

Constructor Summary

BorderLayoutData(Style.LayoutRegion region)
Creates a new border layout data.

BorderLayoutData(Style.LayoutRegion region, float size)
Creates a new border layout data.

BorderLayoutData(Style.LayoutRegion region, float size, int min, int max)

Method Summary

Margins	getMargins() Returns the margins.
int	getMaxSize() Returns the region's max size.
int	getMinSize() Returns the region's min size.
Style.LayoutRegion	getRegion() Returns the layout region.
float	getSize() Returns the region's size.
boolean	isCollapsible() Returns true if collapsing is enabled.
boolean	isFloatable() Returns true if the region is floatable.
boolean	isSplit() Returns true if the region is split.
void	setCollapsible(boolean collapsible) True to allow the user to collapse this region (defaults to false).
void	setFloatable(boolean floatable) True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).
void	setMargins(Margins margins) Sets the margins to apply to the region.
void	setMaxSize(int maxSize) Sets the maximum allowable size in pixels for this region (defaults to 500).
void	setMinSize(int minSize) Sets the minimum allowable size in pixels for this region (defaults to 50).
void	setRegion(Style.LayoutRegion region) Sets the region the mapped content panel will be placed.
void	setSize(float size) The region's preferred size.
void	setSplit(boolean split) True to display a SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BorderLayoutData

public BorderLayoutData(Style.LayoutRegion region)

Creates a new border layout data.

Parameters:

region - the region

BorderLayoutData

public BorderLayoutData(Style.LayoutRegion region,
                        float size)

Creates a new border layout data.

Parameters:

region - the region

size - the region's size

BorderLayoutData

public BorderLayoutData(Style.LayoutRegion region,
                        float size,
                        int min,
                        int max)

Method Detail

getMargins

public Margins getMargins()

Returns the margins.

Returns:

the margins

getMaxSize

public int getMaxSize()

Returns the region's max size.

Returns:

the max size

getMinSize

public int getMinSize()

Returns the region's min size.

Returns:

the min size

getRegion

public Style.LayoutRegion getRegion()

Returns the layout region.

Returns:

the region

getSize

public float getSize()

Returns the region's size.

Returns:

the region size

isCollapsible

public boolean isCollapsible()

Returns true if collapsing is enabled.

Returns:

the collapse state

isFloatable

public boolean isFloatable()

Returns true if the region is floatable.

Returns:

the float state

isSplit

public boolean isSplit()

Returns true if the region is split.

Returns:

the split state

setCollapsible

public void setCollapsible(boolean collapsible)

True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown.

Parameters:

collapsible - true to enable collapsing

setFloatable

public void setFloatable(boolean floatable)

True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).

Parameters:

floatable - true to enable floating

setMargins

public void setMargins(Margins margins)

Sets the margins to apply to the region.

Parameters:

margins - the margins

setMaxSize

public void setMaxSize(int maxSize)

Sets the maximum allowable size in pixels for this region (defaults to 500).

Parameters:

maxSize - the max size

setMinSize

public void setMinSize(int minSize)

Sets the minimum allowable size in pixels for this region (defaults to 50).

Parameters:

minSize - the min size

setRegion

public void setRegion(Style.LayoutRegion region)

Sets the region the mapped content panel will be placed.

Parameters:

region - the region

setSize

public void setSize(float size)

The region's preferred size. Values of 1 or less are treated as percentages (defaults to 200).

Parameters:

size - the region size

setSplit

public void setSplit(boolean split)

True to display a SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false). When split = true, it is common to specify a minSize and maxSize for the region.

Parameters:

split - true to enable a split bar