M
- the model typepublic class RowExpander<M> extends ColumnConfig<M,M> implements ComponentPlugin<Grid<M>>, BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>, ExpandItemEvent.HasExpandItemHandlers<M>, BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>, CollapseItemEvent.HasCollapseItemHandlers<M>
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.Modifier and Type | Class and Description |
---|---|
static interface |
RowExpander.RowExpanderAppearance<M> |
Modifier and Type | Field and Description |
---|---|
protected <any> |
contentCell |
protected Grid<M> |
grid |
ariaIgnore
Constructor and Description |
---|
RowExpander(<any> contentCell)
Creates a new row expander.
|
RowExpander(IdentityValueProvider<M> valueProvider,
<any> contentCell)
Creates a new row expander.
|
RowExpander(IdentityValueProvider<M> valueProvider,
<any> contentCell,
RowExpander.RowExpanderAppearance<M> appearance)
Creates a new row expander.
|
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. |
protected boolean |
beforeExpand(M model,
Element body,
XElement row,
int rowIndex) |
void |
collapseRow(int rowIndex)
Collapses the given row.
|
protected void |
collapseRow(XElement row) |
void |
expandRow(int rowIndex)
Expands the given row.
|
protected void |
expandRow(XElement row) |
RowExpander.RowExpanderAppearance<M> |
getAppearance() |
protected String |
getBodyContent(M model,
int rowIndex) |
<any> |
getContentCell()
Returns the content cell.
|
void |
initPlugin(Grid<M> component)
Initializes the plugin.
|
boolean |
isExpanded(int rowIndex)
Returns true if the row is expanded.
|
protected boolean |
isExpanded(XElement row) |
protected void |
onMouseDown(RowClickEvent event) |
void |
setContentCell(<any> contentCell)
Sets the content cell.
|
protected void |
toggleRow(XElement row) |
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, setHidden, setHideable, setHorizontalAlignment, setHorizontalHeaderAlignment, setMenuDisabled, setResizable, setRowHeader, setSortable, setToolTip, setVerticalAlignment, setWidget, setWidth
public RowExpander(<any> contentCell)
contentCell
- the content cellpublic RowExpander(IdentityValueProvider<M> valueProvider, <any> contentCell)
valueProvider
- the value providercontentCell
- the content cellpublic RowExpander(IdentityValueProvider<M> valueProvider, <any> contentCell, RowExpander.RowExpanderAppearance<M> appearance)
valueProvider
- the value providercontentCell
- the content cellappearance
- the appearancepublic HandlerRegistration addBeforeCollapseHandler(BeforeCollapseItemEvent.BeforeCollapseItemHandler<M> handler)
BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers
BeforeCollapseItemEvent.BeforeCollapseItemHandler
handler for BeforeCollapseItemEvent
events.addBeforeCollapseHandler
in interface BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>
handler
- the handlerpublic HandlerRegistration addBeforeExpandHandler(BeforeExpandItemEvent.BeforeExpandItemHandler<M> handler)
BeforeExpandItemEvent.HasBeforeExpandItemHandlers
BeforeExpandItemEvent.BeforeExpandItemHandler
handler for BeforeExpandItemEvent
events.addBeforeExpandHandler
in interface BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>
handler
- the handlerpublic HandlerRegistration addCollapseHandler(CollapseItemEvent.CollapseItemHandler<M> handler)
CollapseItemEvent.HasCollapseItemHandlers
CollapseItemEvent.CollapseItemHandler
handler for CollapseItemEvent
events.addCollapseHandler
in interface CollapseItemEvent.HasCollapseItemHandlers<M>
handler
- the handlerpublic HandlerRegistration addExpandHandler(ExpandItemEvent.ExpandItemHandler<M> handler)
ExpandItemEvent.HasExpandItemHandlers
ExpandItemEvent.ExpandItemHandler
handler for ExpandItemEvent
events.addExpandHandler
in interface ExpandItemEvent.HasExpandItemHandlers<M>
handler
- the handlerpublic void collapseRow(int rowIndex)
rowIndex
- the rowIndexpublic void expandRow(int rowIndex)
rowIndex
- the rowIndexpublic RowExpander.RowExpanderAppearance<M> getAppearance()
public <any> getContentCell()
public void initPlugin(Grid<M> component)
ComponentPlugin
initPlugin
in interface ComponentPlugin<Grid<M>>
component
- the target componentpublic boolean isExpanded(int rowIndex)
rowIndex
- the row indexpublic void setContentCell(<any> contentCell)
contentCell
- the content cellprotected void collapseRow(XElement row)
protected void expandRow(XElement row)
protected boolean isExpanded(XElement row)
protected void onMouseDown(RowClickEvent event)
protected void toggleRow(XElement row)
Copyright © 2018. All rights reserved.