| Modifier and Type | Class and Description |
|---|---|
static class |
ColumnConnector.CustomColumn
Class for representing a custom column.
|
| Modifier and Type | Method and Description |
|---|---|
String |
GridConnector.getColumnId(Grid.Column<?,?> column)
Gets the string identifier of the given column in this grid.
|
protected String |
AbstractGridRendererConnector.getColumnId(Grid.Column<?,elemental.json.JsonObject> column)
Gets the column id for a column.
|
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<?,T> |
CellReference.getColumn()
Gets the column objects.
|
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.user.client.ui.Widget |
EditorHandler.getWidget(Grid.Column<?,T> column)
Returns a widget instance that is used to edit the values in the given
column.
|
com.google.gwt.user.client.ui.Widget |
EditorHandler.EditorRequest.getWidget(Grid.Column<?,T> column)
Returns the editor widget used to edit the values of the given
column.
|
protected boolean |
DefaultEditorEventHandler.isEditable(Grid<T> grid,
Grid.Column<?,T> column)
Checks whether the field within the given editor column is editable.
|
void |
RendererCellReference.set(FlyweightCell cell,
int columnIndex,
Grid.Column<?,?> column)
Sets the identifying information for this cell.
|
void |
CellReference.set(int columnIndexDOM,
int columnIndex,
Grid.Column<?,T> column)
Sets the identifying information for this cell.
|
| Modifier and Type | Method and Description |
|---|---|
default void |
EditorHandler.EditorRequest.failure(String errorMessage,
Collection<Grid.Column<?,T>> errorColumns)
Informs Grid that an error occurred while trying to process the
request.
|
| Modifier and Type | Method and Description |
|---|---|
<C> Comparator<C> |
ListSorter.getComparator(Grid.Column<C,T> column)
Retrieve the comparator assigned for a specific grid column.
|
<C> void |
ListSorter.setComparator(Grid.Column<C,T> column,
Comparator<C> comparator)
Assign or remove a comparator for a column.
|
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<?,T> |
ColumnVisibilityChangeEvent.getColumn()
Returns the column where the visibility change occurred.
|
Grid.Column<?,T> |
ColumnResizeEvent.getColumn() |
| Modifier and Type | Method and Description |
|---|---|
List<Grid.Column<?,T>> |
ColumnReorderEvent.getNewColumnOrder()
Gets the new ordering of columns.
|
List<Grid.Column<?,T>> |
ColumnReorderEvent.getOldColumnOrder()
Gets the ordering of columns prior to this event.
|
| Constructor and Description |
|---|
ColumnResizeEvent(Grid.Column<?,T> column)
Constructs a resize event for a grid column.
|
ColumnVisibilityChangeEvent(Grid.Column<?,T> column,
boolean hidden,
boolean userOriginated)
Constructs a visibility change event for a grid column.
|
| Constructor and Description |
|---|
ColumnReorderEvent(List<Grid.Column<?,T>> oldColumnOrder,
List<Grid.Column<?,T>> newColumnOrder,
boolean userOriginated)
Constructs a reorder event for grid columns.
|
ColumnReorderEvent(List<Grid.Column<?,T>> oldColumnOrder,
List<Grid.Column<?,T>> newColumnOrder,
boolean userOriginated)
Constructs a reorder event for grid columns.
|
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<?,?> |
SortOrder.getColumn()
Returns the
GridColumn reference given in the constructor. |
| Modifier and Type | Method and Description |
|---|---|
static Sort |
Sort.by(Grid.Column<?,?> column)
Start building a Sort order by sorting a provided column in ascending
order.
|
static Sort |
Sort.by(Grid.Column<?,?> column,
SortDirection direction)
Start building a Sort order by sorting a provided column.
|
Sort |
Sort.then(Grid.Column<?,?> column)
Continue building a Sort order.
|
Sort |
Sort.then(Grid.Column<?,?> column,
SortDirection direction)
Continue building a Sort order.
|
| Constructor and Description |
|---|
SortOrder(Grid.Column<?,?> column)
Create a sort order descriptor with a default sorting direction value of
SortDirection.ASCENDING. |
SortOrder(Grid.Column<?,?> column,
SortDirection direction)
Create a sort order descriptor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Grid.SelectionColumn
A column that contains CheckBoxes for representing Grid's row selection.
|
| Modifier and Type | Method and Description |
|---|---|
<C extends Grid.Column<?,T>> |
Grid.addColumn(C column)
Adds a column as the last column in the grid.
|
<C extends Grid.Column<?,T>> |
Grid.addColumn(C column,
int index)
Inserts a column into a specific position in the grid.
|
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<C,T> |
Grid.Column.clearExpandRatio()
Clears the column's expand ratio.
|
Grid.Column<?,T> |
Grid.getColumn(int index)
Returns a column by its index in the grid.
|
Grid.Column<C,T> |
Grid.Column.setAssistiveCaption(String caption)
Sets the header aria-label for this column.
|
Grid.Column<Boolean,T> |
Grid.SelectionColumn.setEditable(boolean editable) |
Grid.Column<C,T> |
Grid.Column.setEditable(boolean editable)
Sets whether the values in this column should be editable by the user
when the row editor is active.
|
Grid.Column<Boolean,T> |
Grid.SelectionColumn.setExpandRatio(int ratio) |
Grid.Column<C,T> |
Grid.Column.setExpandRatio(int ratio)
Sets the ratio with which the column expands.
|
Grid.Column<C,T> |
Grid.Column.setHeaderCaption(String caption)
Sets a header caption for this column.
|
Grid.Column<C,T> |
Grid.Column.setHidable(boolean hidable)
Set whether it is possible for the user to hide this column or not.
|
Grid.Column<C,T> |
Grid.Column.setHidden(boolean hidden)
Hides or shows the column.
|
Grid.Column<C,T> |
Grid.Column.setHidingToggleCaption(String hidingToggleCaption)
Sets the hiding toggle's caption for this column.
|
Grid.Column<Boolean,T> |
Grid.SelectionColumn.setMaximumWidth(double pixels) |
Grid.Column<C,T> |
Grid.Column.setMaximumWidth(double pixels)
Sets the maximum width for this column.
|
Grid.Column<Boolean,T> |
Grid.SelectionColumn.setMinimumWidth(double pixels) |
Grid.Column<C,T> |
Grid.Column.setMinimumWidth(double pixels)
Sets the minimum width for this column.
|
Grid.Column<C,T> |
Grid.Column.setRenderer(Renderer<? super C> renderer)
Sets a custom
Renderer for this column. |
Grid.Column<C,T> |
Grid.Column.setResizable(boolean resizable)
Sets whether this column can be resized by the user.
|
Grid.Column<C,T> |
Grid.Column.setSortable(boolean sortable)
Sets whether the column should be sortable by the user.
|
Grid.Column<Boolean,T> |
Grid.SelectionColumn.setWidth(double pixels) |
Grid.Column<C,T> |
Grid.Column.setWidth(double pixels)
Sets the pixel width of the column.
|
| Modifier and Type | Method and Description |
|---|---|
List<Grid.Column<?,T>> |
Grid.getColumns()
Returns a list columns in the grid, including hidden columns.
|
List<Grid.Column<?,T>> |
Grid.getVisibleColumns()
Returns a list of the currently visible columns in the grid.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
Grid.StaticSection.StaticRow.addCell(Grid.Column<?,?> column)
Creates and adds a cell to this row for the given column.
|
protected void |
Grid.StaticSection.addColumn(Grid.Column<?,?> column)
Adds cells for the given column to all the rows within this section.
|
protected void |
Grid.Header.addColumn(Grid.Column<?,?> column) |
void |
Grid.addColumns(Grid.Column<?,T>... columns)
Adds columns as the last columns in the grid.
|
CELLTYPE |
Grid.StaticSection.StaticRow.getCell(Grid.Column<?,?> column)
Returns the cell on given GridColumn.
|
com.google.gwt.user.client.ui.Widget |
Grid.getEditorWidget(Grid.Column<?,T> column)
Returns the editor widget associated with the given column.
|
protected int |
Grid.StaticSection.StaticRow.getSizeOfCellGroup(Grid.Column<?,?> column)
Returns the size of the cell group for the given column.
|
protected com.google.gwt.user.client.ui.Widget |
Grid.Editor.getWidget(Grid.Column<?,T> column)
Returns the editor widget associated with the given column.
|
boolean |
Grid.Editor.isEditorColumnError(Grid.Column<?,T> column)
Returns true if the column has been listed as containing an error.
|
CELLTYPE |
Grid.StaticSection.StaticRow.join(Grid.Column<?,?>... columns)
Merges columns cells in a row.
|
protected void |
Grid.StaticSection.StaticRow.removeCell(Grid.Column<?,?> column)
Removes a cell for the given column from this row.
|
protected void |
Grid.StaticSection.removeColumn(Grid.Column<?,?> column)
Removes cells for the given column from all the rows within this
section.
|
void |
Grid.removeColumn(Grid.Column<?,T> column)
Removes a column from the grid.
|
void |
Grid.setColumnOrder(Grid.Column<?,T>... orderedColumns)
Sets a new column order for the grid.
|
void |
Grid.Editor.setEditorColumnError(Grid.Column<?,T> column,
boolean hasError)
If the given column is indicated to have an error in the editor, sets
the error styles to the corresponding editor cell and lists the
column as having an error.
|
<C> void |
Grid.sort(Grid.Column<C,T> column)
Sorts the Grid data in ascending order along one column.
|
<C> void |
Grid.sort(Grid.Column<C,T> column,
SortDirection direction)
Sorts the Grid data along one column.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Grid.Editor.setEditorError(String errorMessage,
Collection<Grid.Column<?,T>> errorColumns)
Sets an error message for the editor, or removes it if the given
message is
null. |
Copyright © 2021 Vaadin Ltd. All rights reserved.