com.sencha.gxt.widget.core.client.container

Class BorderLayoutContainer.BorderLayoutData

java.lang.Object

com.sencha.gxt.widget.core.client.container.MarginData

com.sencha.gxt.widget.core.client.container.BorderLayoutContainer.BorderLayoutData

All Implemented Interfaces:

HasUiAttributes, HasMargins, HasSize, LayoutData

Enclosing class:

BorderLayoutContainer

public static class BorderLayoutContainer.BorderLayoutData
extends MarginData
implements HasSize, LayoutData

Specifies region layout parameters which control the margin between the regions, the size of the region, the minimum and maximum size, whether the region has a split bar, whether the region is collapsible and other details. The size, split bar and collapsible attributes are specified in the BorderLayoutData for the region adjacent to the center region. The center region is allocated the remaining space.

Constructor Summary

Constructors

Constructor and Description
BorderLayoutContainer.BorderLayoutData() Creates a border layout data with default values for size (100), minSize (50) and maxSize (500).
BorderLayoutContainer.BorderLayoutData(double size) Creates a border layout data with default values for minSize (50) and maxSize (500) and the specified value for size.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxSize() Returns the region's maximum size.
int	getMinSize() Returns the region's minimum size.
double	getSize() Returns the size specification.
boolean	isCollapsed() Returns the collapsed state
boolean	isCollapseHidden() Returns true if the collapse panel is hidden.
boolean	isCollapseMini() Returns true if the mini split bar collapse tool is enabled.
boolean	isCollapsible() Returns true if collapsing is enabled.
boolean	isFloatable() Returns true if the region is floatable.
boolean	isHidden() Returns true if the component is hidden.
boolean	isSplit() Returns true if the region is split.
void	setCollapsed(boolean collapsed) Sets the collapsed state.
void	setCollapseHidden(boolean collapseHidden) True to hide the collapse panel when a region is collapsed (defaults to false).
void	setCollapseMini(boolean collapseMini) True to add a mini-collapase tool in the split bar.
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	setHidden(boolean hidden) True to hide the component.
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	setSize(double size) Sets the size specification.
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 com.sencha.gxt.widget.core.client.container.MarginData

getMargins, setMargins

Methods inherited from class java.lang.Object

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

Constructor Detail

BorderLayoutContainer.BorderLayoutData

public BorderLayoutContainer.BorderLayoutData()

Creates a border layout data with default values for size (100), minSize (50) and maxSize (500).

BorderLayoutContainer.BorderLayoutData

@UiConstructor
public BorderLayoutContainer.BorderLayoutData(double size)

Creates a border layout data with default values for minSize (50) and maxSize (500) and the specified value for size.

Parameters:

size - the region size (height for north and south, width for west and east)

Method Detail

getMaxSize

public int getMaxSize()

Returns the region's maximum size.

Returns:

the maximum size

getMinSize

public int getMinSize()

Returns the region's minimum size.

Returns:

the minimum size

getSize

public double getSize()

Description copied from interface: HasSize

Returns the size specification. Values greater than 1 represent height in pixels. Values between 0 and 1 (inclusive) represent a percent of the height of the container.

Specified by:

getSize in interface HasSize

Returns:

the size specification

isCollapsed

public boolean isCollapsed()

Returns the collapsed state

Returns:

the collapsed state

isCollapseHidden

public boolean isCollapseHidden()

Returns true if the collapse panel is hidden.

Returns:

the collapse hidden state

isCollapseMini

public boolean isCollapseMini()

Returns true if the mini split bar collapse tool is enabled.

Returns:

true if the mini split bar collapse tool is enabled

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

isHidden

public boolean isHidden()

Returns true if the component is hidden.

Returns:

the hidden state

isSplit

public boolean isSplit()

Returns true if the region is split.

Returns:

the split state

setCollapsed

public void setCollapsed(boolean collapsed)

Sets the collapsed state.

Parameters:

collapsed - true to render collapsed

setCollapseHidden

public void setCollapseHidden(boolean collapseHidden)

True to hide the collapse panel when a region is collapsed (defaults to false).

Parameters:

collapseHidden - the collapse hidden state

setCollapseMini

public void setCollapseMini(boolean collapseMini)

True to add a mini-collapase tool in the split bar. Enabling will make the region resizable.

Parameters:

collapseMini - true to add tool

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

setHidden

public void setHidden(boolean hidden)

True to hide the component.

Parameters:

hidden - true to hide

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

setSize

public void setSize(double size)

Description copied from interface: HasSize

Sets the size specification. Values greater than 1 represent height in pixels. Values between 0 and 1 (inclusive) represent a percent of the height of the container.

Specified by:

setSize in interface HasSize

Parameters:

size - the size specification

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