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

Class RowExpander<M>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.ColumnConfig<M,M>

com.sencha.gxt.widget.core.client.grid.RowExpander<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

HasHorizontalAlignment, HasVerticalAlignment, ComponentPlugin<Grid<M>>, BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>, BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>, CollapseItemEvent.HasCollapseItemHandlers<M>, ExpandItemEvent.HasExpandItemHandlers<M>

public class RowExpander<M>
extends ColumnConfig<M,M>
implements ComponentPlugin<Grid<M>>, BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>, ExpandItemEvent.HasExpandItemHandlers<M>, BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>, CollapseItemEvent.HasCollapseItemHandlers<M>

A ColumnConfig subclass and a ComponentPlugin that adds the ability for each row to be expanded, showing custom content that spans all the rows columns.

As with all component plugins, initPlugin(Grid) must be called to initialize the row expander.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RowExpander.RowExpanderAppearance<M>

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

HasHorizontalAlignment.AutoHorizontalAlignmentConstant, HasHorizontalAlignment.HorizontalAlignmentConstant

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

HasVerticalAlignment.VerticalAlignmentConstant

Field Summary

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

Fields inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

ALIGN_BOTTOM, ALIGN_MIDDLE, ALIGN_TOP

Constructor Summary

Constructors

Constructor and Description
RowExpander(Cell<M> contentCell) Creates a new row expander.
RowExpander(IdentityValueProvider<M> valueProvider, Cell<M> contentCell) Creates a new row expander.
RowExpander(IdentityValueProvider<M> valueProvider, Cell<M> contentCell, RowExpander.RowExpanderAppearance<M> appearance) Creates a new row expander.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addBeforeCollapseHandler(BeforeCollapseItemEvent.BeforeCollapseItemHandler<M> handler) Adds a BeforeCollapseItemEvent.BeforeCollapseItemHandler handler for BeforeCollapseItemEvent events.
HandlerRegistration	addBeforeExpandHandler(BeforeExpandItemEvent.BeforeExpandItemHandler<M> handler) Adds a BeforeExpandItemEvent.BeforeExpandItemHandler handler for BeforeExpandItemEvent events.
HandlerRegistration	addCollapseHandler(CollapseItemEvent.CollapseItemHandler<M> handler) Adds a CollapseItemEvent.CollapseItemHandler handler for CollapseItemEvent events.
HandlerRegistration	addExpandHandler(ExpandItemEvent.ExpandItemHandler<M> handler) Adds a ExpandItemEvent.ExpandItemHandler handler for ExpandItemEvent events.
void	collapseRow(int rowIndex) Collapses the given row.
void	expandRow(int rowIndex) Expands the given row.
RowExpander.RowExpanderAppearance<M>	getAppearance()
Cell<M>	getContentCell() Returns the content cell.
void	initPlugin(Grid<M> component) Initializes the plugin.
boolean	isExpanded(int rowIndex) Returns true if the row is expanded.
void	setContentCell(Cell<M> contentCell) Sets the content cell.

Methods inherited from class com.sencha.gxt.widget.core.client.grid.ColumnConfig

getCell, getCellClassName, getColumnHeaderClassName, getColumnStyle, getColumnTextClassName, getColumnTextStyle, getComparator, getHeader, getHorizontalAlignment, getHorizontalHeaderAlignment, getPath, getToolTip, getValueProvider, getVerticalAlignment, getWidget, getWidth, isCellPadding, isFixed, isGroupable, isHidden, isHideable, isMenuDisabled, isResizable, isRowHeader, isSortable, setCell, setCellClassName, setCellPadding, setColumnHeaderClassName, setColumnStyle, setColumnTextClassName, setColumnTextStyle, setComparator, setFixed, setGroupable, setHeader, setHeader, setHidden, setHideable, setHorizontalAlignment, setHorizontalHeaderAlignment, setMenuDisabled, setResizable, setRowHeader, setSortable, setToolTip, setVerticalAlignment, setWidget, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

RowExpander

public RowExpander(Cell<M> contentCell)

Creates a new row expander.

Parameters:

contentCell - the content cell

RowExpander

public RowExpander(IdentityValueProvider<M> valueProvider,
           Cell<M> contentCell)

Creates a new row expander.

Parameters:

valueProvider - the value provider

contentCell - the content cell

RowExpander

public RowExpander(IdentityValueProvider<M> valueProvider,
           Cell<M> contentCell,
           RowExpander.RowExpanderAppearance<M> appearance)

Creates a new row expander.

Parameters:

valueProvider - the value provider

contentCell - the content cell

appearance - the appearance

Method Detail

addBeforeCollapseHandler

public HandlerRegistration addBeforeCollapseHandler(BeforeCollapseItemEvent.BeforeCollapseItemHandler<M> handler)

Description copied from interface: BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers

Adds a BeforeCollapseItemEvent.BeforeCollapseItemHandler handler for BeforeCollapseItemEvent events.

Specified by:

addBeforeCollapseHandler in interface BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>

Parameters:

handler - the handler

Returns:

the registration for the event

addBeforeExpandHandler

public HandlerRegistration addBeforeExpandHandler(BeforeExpandItemEvent.BeforeExpandItemHandler<M> handler)

Description copied from interface: BeforeExpandItemEvent.HasBeforeExpandItemHandlers

Adds a BeforeExpandItemEvent.BeforeExpandItemHandler handler for BeforeExpandItemEvent events.

Specified by:

addBeforeExpandHandler in interface BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>

Parameters:

handler - the handler

Returns:

the registration for the event

addCollapseHandler

public HandlerRegistration addCollapseHandler(CollapseItemEvent.CollapseItemHandler<M> handler)

Description copied from interface: CollapseItemEvent.HasCollapseItemHandlers

Adds a CollapseItemEvent.CollapseItemHandler handler for CollapseItemEvent events.

Specified by:

addCollapseHandler in interface CollapseItemEvent.HasCollapseItemHandlers<M>

Parameters:

handler - the handler

Returns:

the registration for the event

addExpandHandler

public HandlerRegistration addExpandHandler(ExpandItemEvent.ExpandItemHandler<M> handler)

Description copied from interface: ExpandItemEvent.HasExpandItemHandlers

Adds a ExpandItemEvent.ExpandItemHandler handler for ExpandItemEvent events.

Specified by:

addExpandHandler in interface ExpandItemEvent.HasExpandItemHandlers<M>

Parameters:

handler - the handler

Returns:

the registration for the event

collapseRow

public void collapseRow(int rowIndex)

Collapses the given row.

Parameters:

rowIndex - the rowIndex

expandRow

public void expandRow(int rowIndex)

Expands the given row.

Parameters:

rowIndex - the rowIndex

getAppearance

public RowExpander.RowExpanderAppearance<M> getAppearance()

getContentCell

public Cell<M> getContentCell()

Returns the content cell.

Returns:

the content cell

initPlugin

public void initPlugin(Grid<M> component)

Description copied from interface: ComponentPlugin

Initializes the plugin.

Specified by:

initPlugin in interface ComponentPlugin<Grid<M>>

Parameters:

component - the target component

isExpanded

public boolean isExpanded(int rowIndex)

Returns true if the row is expanded.

Parameters:

rowIndex - the row index

Returns:

true if expanded

setContentCell

public void setContentCell(Cell<M> contentCell)

Sets the content cell.

Parameters:

contentCell - the content cell