com.sencha.gxt.widget.core.client.grid

Class HeaderGroupConfig

java.lang.Object

com.sencha.gxt.widget.core.client.grid.HeaderGroupConfig

public class HeaderGroupConfig
extends Object

Defines the configuration for a header group. Header groups support rowspan and colspan and horizontal alignment. Groups support both HTML and widget for their content.

Constructor Summary

Constructors

Constructor and Description
HeaderGroupConfig(SafeHtml html) Creates a new header group without rowspan and colspan.
HeaderGroupConfig(SafeHtml text, int rowspan, int colspan) Creates a header group.
HeaderGroupConfig(String html) Creates a new header group without rowspan and colspan.
HeaderGroupConfig(String text, int rowspan, int colspan) Creates a header group.
HeaderGroupConfig(Widget widget, int rowspan, int colspan) Creates a header group.

Method Summary

Methods

Modifier and Type	Method and Description
int	getColspan() Returns the colspan.
int	getColumn() Returns the column.
HasHorizontalAlignment.HorizontalAlignmentConstant	getHorizontalAlignment() Returns the horizontal alignment.
SafeHtml	getHtml() Returns the html.
int	getRow() Returns the row.
int	getRowspan() Returns the rowspan.
Widget	getWidget() Returns the widget.
void	setColspan(int colspan) Sets the colspan (defaults to 1).
void	setColumn(int column) Sets the 0-indexed column
void	setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant horizontalAlignment) Sets the horizontal alignment
void	setHtml(SafeHtml html) Sets the group's html.
void	setRow(int row) Sets the 0-indexed row.
void	setRowspan(int rowspan) Sets the rowspan (defaults to 1).
void	setWidget(Widget widget) Sets the group's widget.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderGroupConfig

public HeaderGroupConfig(String html)

Creates a new header group without rowspan and colspan.

Parameters:

html - the group text

HeaderGroupConfig

public HeaderGroupConfig(SafeHtml html)

Creates a new header group without rowspan and colspan.

Parameters:

html - the group text

HeaderGroupConfig

public HeaderGroupConfig(String text,
                 int rowspan,
                 int colspan)

Creates a header group.

Parameters:

text - the group text

rowspan - the rowspan

colspan - the colspan

HeaderGroupConfig

public HeaderGroupConfig(SafeHtml text,
                 int rowspan,
                 int colspan)

Creates a header group.

Parameters:

text - the group text

rowspan - the rowspan

colspan - the colspan

HeaderGroupConfig

public HeaderGroupConfig(Widget widget,
                 int rowspan,
                 int colspan)

Creates a header group.

Parameters:

widget - the group's widget

rowspan - the rowspan

colspan - the colspan

Method Detail

getColspan

public int getColspan()

Returns the colspan.

Returns:

the colspan

getColumn

public int getColumn()

Returns the column.

Returns:

the column

getHorizontalAlignment

public HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()

Returns the horizontal alignment.

Returns:

the alignment

getHtml

public SafeHtml getHtml()

Returns the html.

Returns:

the html

getRow

public int getRow()

Returns the row.

Returns:

the row

getRowspan

public int getRowspan()

Returns the rowspan.

Returns:

the rowspan

getWidget

public Widget getWidget()

Returns the widget.

Returns:

the widget

setColspan

public void setColspan(int colspan)

Sets the colspan (defaults to 1).

Parameters:

colspan - the colspan

setColumn

public void setColumn(int column)

Sets the 0-indexed column

Parameters:

column - the column

setHorizontalAlignment

public void setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant horizontalAlignment)

Sets the horizontal alignment

Parameters:

horizontalAlignment - the alignment

setHtml

public void setHtml(SafeHtml html)

Sets the group's html.

Parameters:

html - the html text

setRow

public void setRow(int row)

Sets the 0-indexed row.

Parameters:

row - the row

setRowspan

public void setRowspan(int rowspan)

Sets the rowspan (defaults to 1).

Parameters:

rowspan - the rowspan

setWidget

public void setWidget(Widget widget)

Sets the group's widget.

Parameters:

widget - the widget