| Package | Description |
|---|---|
| com.vaadin.data.provider | |
| com.vaadin.ui | |
| com.vaadin.ui.components.grid | |
| com.vaadin.ui.renderers |
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<T,?> |
GridSortOrder.getSorted()
Gets the column this sorting information is attached to.
|
| Modifier and Type | Method and Description |
|---|---|
static <T> GridSortOrderBuilder<T> |
GridSortOrder.asc(Grid.Column<T,?> by)
Creates a new grid sort builder with given sorting using ascending sort
direction.
|
protected GridSortOrder<T> |
GridSortOrderBuilder.createSortOrder(Grid.Column<T,?> by,
SortDirection direction) |
static <T> GridSortOrderBuilder<T> |
GridSortOrder.desc(Grid.Column<T,?> by)
Creates a new grid sort builder with given sorting using descending sort
direction.
|
GridSortOrderBuilder<T> |
GridSortOrderBuilder.thenAsc(Grid.Column<T,?> by) |
GridSortOrderBuilder<T> |
GridSortOrderBuilder.thenDesc(Grid.Column<T,?> by) |
| Constructor and Description |
|---|
GridSortOrder(Grid.Column<T,?> column,
SortDirection direction)
Construct sorting information for usage in a
Grid. |
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<T,?> |
Grid.addColumn(String propertyName)
Adds a new column with the given property name.
|
Grid.Column<T,?> |
Grid.addColumn(String propertyName,
AbstractRenderer<? super T,?> renderer)
Adds a new column with the given property name and renderer.
|
<V> Grid.Column<T,V> |
Grid.addColumn(ValueProvider<T,V> valueProvider)
Adds a new text column to this
Grid with a value provider. |
<V> Grid.Column<T,V> |
Grid.addColumn(ValueProvider<T,V> valueProvider,
AbstractRenderer<? super T,? super V> renderer)
Adds a new column to this
Grid with typed renderer and value
provider. |
<V,P> Grid.Column<T,V> |
Grid.addColumn(ValueProvider<T,V> valueProvider,
ValueProvider<V,P> presentationProvider,
AbstractRenderer<? super T,? super P> renderer)
Adds a new column to this
Grid with value provider, presentation
provider and typed renderer. |
<V> Grid.Column<T,V> |
Grid.addColumn(ValueProvider<T,V> valueProvider,
ValueProvider<V,String> presentationProvider)
Adds a new column to this
Grid with value provider and
presentation provider. |
<V extends Component> |
Grid.addComponentColumn(ValueProvider<T,V> componentProvider)
Adds a column that shows components.
|
Grid.Column<T,V> |
Grid.Column.clearExpandRatio()
Clears the expand ratio for this column.
|
protected <V,P> Grid.Column<T,V> |
Grid.createColumn(ValueProvider<T,V> valueProvider,
ValueProvider<V,P> presentationProvider,
AbstractRenderer<? super T,? super P> renderer)
Creates a column instance from a value provider, presentation provider
and a renderer.
|
Grid.Column<?,?> |
Grid.ColumnResizeEvent.getColumn()
Returns the column that was resized.
|
Grid.Column<T,?> |
Grid.ItemClick.getColumn()
Returns the clicked column.
|
Grid.Column<T,?> |
Grid.GridContextClickEvent.getColumn()
Returns the clicked column.
|
Grid.Column<?,?> |
Grid.ColumnVisibilityChangeEvent.getColumn()
Gets the column that became hidden or visible.
|
Grid.Column<T,?> |
Grid.getColumn(String columnId)
Gets a
Grid.Column of this grid by its identifying string. |
protected Grid.Column<T,?> |
Grid.getColumnByInternalId(String columnId)
Returns a column identified by its internal id.
|
Grid.Column<T,?> |
TreeGrid.getHierarchyColumn()
Get the currently set hierarchy column.
|
Grid.Column<T,V> |
Grid.Column.setAssistiveCaption(String caption)
Sets the header aria-label for this column.
|
Grid.Column<T,V> |
Grid.Column.setCaption(String caption)
Sets the header caption for this column.
|
Grid.Column<T,V> |
Grid.Column.setComparator(SerializableComparator<T> comparator)
Sets a comparator to use with in-memory sorting with this column.
|
Grid.Column<T,V> |
Grid.Column.setDescriptionGenerator(DescriptionGenerator<T> cellDescriptionGenerator)
Sets the description generator that is used for generating
descriptions for cells in this column.
|
Grid.Column<T,V> |
Grid.Column.setDescriptionGenerator(DescriptionGenerator<T> cellDescriptionGenerator,
ContentMode tooltipContentMode)
Sets the description generator that is used for generating
descriptions for cells in this column.
|
Grid.Column<T,V> |
Grid.Column.setEditable(boolean editable)
Sets whether this Column has a component displayed in Editor or not.
|
Grid.Column<T,V> |
Grid.Column.setEditorBinding(Binder.Binding<T,?> binding)
Sets an editor binding for this column.
|
<F,C extends HasValue<F> & Component> |
Grid.Column.setEditorComponent(C editorComponent)
Sets a component to use for editing values of this columns in the
editor row.
|
<C extends HasValue<V> & Component> |
Grid.Column.setEditorComponent(C editorComponent,
Setter<T,V> setter)
Sets a component and setter to use for editing values of this column
in the editor row.
|
Grid.Column<T,V> |
Grid.Column.setExpandRatio(int expandRatio)
Sets the ratio with which the column expands.
|
Grid.Column<T,V> |
Grid.Column.setHandleWidgetEvents(boolean handleWidgetEvents)
Sets whether Grid should handle events in this Column from Components
and Widgets rendered by certain Renderers.
|
Grid.Column<T,V> |
Grid.Column.setHidable(boolean hidable)
Sets whether this column can be hidden by the user.
|
Grid.Column<T,V> |
Grid.Column.setHidden(boolean hidden)
Hides or shows the column.
|
Grid.Column<T,V> |
Grid.Column.setHidingToggleCaption(String hidingToggleCaption)
Sets the caption of the hiding toggle for this column.
|
Grid.Column<T,V> |
Grid.Column.setId(String id)
Sets the user-defined identifier to map this column.
|
Grid.Column<T,V> |
Grid.Column.setMaximumWidth(double pixels)
Sets the maximum width for this column.
|
Grid.Column<T,V> |
Grid.Column.setMinimumWidth(double pixels)
Sets the minimum width for this column.
|
Grid.Column<T,V> |
Grid.Column.setMinimumWidthFromContent(boolean minimumWidthFromContent)
Sets whether the width of the contents in the column should be
considered minimum width for this column.
|
Grid.Column<T,V> |
Grid.Column.setRenderer(Renderer<? super V> renderer)
Sets the Renderer for this Column.
|
<P> Grid.Column<T,V> |
Grid.Column.setRenderer(ValueProvider<V,P> presentationProvider,
Renderer<? super P> renderer)
Sets the Renderer for this Column.
|
Grid.Column<T,V> |
Grid.Column.setResizable(boolean resizable)
Sets whether this column can be resized by the user.
|
Grid.Column<T,V> |
Grid.Column.setSortable(boolean sortable)
Sets whether the user can sort this column or not.
|
Grid.Column<T,V> |
Grid.Column.setSortOrderProvider(SortOrderProvider provider)
Sets the sort orders when sorting this column.
|
Grid.Column<T,V> |
Grid.Column.setSortProperty(String... properties)
Sets strings describing back end properties to be used when sorting
this column.
|
Grid.Column<T,V> |
Grid.Column.setStyleGenerator(StyleGenerator<T> cellStyleGenerator)
Sets the style generator that is used for generating class names for
cells in this column.
|
Grid.Column<T,V> |
Grid.Column.setWidth(double pixelWidth)
Sets the width (in pixels).
|
Grid.Column<T,V> |
Grid.Column.setWidthUndefined()
Marks the column width as undefined.
|
| Modifier and Type | Method and Description |
|---|---|
List<Grid.Column<T,?>> |
Grid.getColumns()
Gets an unmodifiable collection of all columns currently in this
Grid. |
| Modifier and Type | Method and Description |
|---|---|
<V> void |
Grid.fireColumnVisibilityChangeEvent(Grid.Column<T,V> column,
boolean hidden,
boolean userOriginated) |
protected String |
Grid.getInternalIdForColumn(Grid.Column<T,?> column)
Returns the internal id for given column.
|
protected String |
Grid.AbstractGridExtension.getInternalIdForColumn(Grid.Column<T,?> column) |
void |
Grid.removeColumn(Grid.Column<T,?> column)
Removes the given column from this
Grid. |
protected void |
Grid.setColumnId(String id,
Grid.Column<T,?> column)
Sets a user-defined identifier for given column.
|
void |
Grid.setColumnOrder(Grid.Column<T,?>... columns)
Sets a new column order for the grid.
|
void |
TreeGrid.setHierarchyColumn(Grid.Column<T,?> column)
Set the column that displays the hierarchy of this grid's data.
|
void |
Grid.sort(Grid.Column<T,?> column)
Sort this Grid in ascending order by a specified column.
|
void |
Grid.sort(Grid.Column<T,?> column,
SortDirection direction)
Sort this Grid in user-specified direction by a column.
|
| Constructor and Description |
|---|
ColumnResizeEvent(Grid<?> source,
Grid.Column<?,?> column,
boolean userOriginated) |
ColumnVisibilityChangeEvent(Grid<?> source,
Grid.Column<?,?> column,
boolean hidden,
boolean isUserOriginated)
Constructor for a column visibility change event.
|
GridContextClickEvent(Grid<T> source,
MouseEventDetails mouseEventDetails,
GridConstants.Section section,
int rowIndex,
T item,
Grid.Column<T,?> column)
Creates a new context click event.
|
ItemClick(Grid<T> source,
Grid.Column<T,?> column,
T item,
MouseEventDetails mouseEventDetails,
int rowIndex)
Creates a new
ItemClick event containing the given item and
Column originating from the given Grid. |
| Modifier and Type | Method and Description |
|---|---|
protected abstract Grid.Column<?,?> |
StaticSection.getColumnByInternalId(String internalId) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
StaticSection.StaticRow.addCell(Grid.Column<?,?> column)
Adds a cell to this section for given column.
|
CELL |
StaticSection.StaticRow.getCell(Grid.Column<?,?> column)
Returns the cell in this section that corresponds to the given
column.
|
HeaderCell |
HeaderRow.getCell(Grid.Column<?,?> column)
Returns the cell on this row corresponding to the given column.
|
FooterCell |
FooterRow.getCell(Grid.Column<?,?> column)
Returns the cell on this row corresponding to the given column.
|
protected abstract String |
StaticSection.getInternalIdForColumn(Grid.Column<?,?> column) |
HeaderCell |
HeaderRow.join(Grid.Column<?,?>... columnsToMerge)
Merges cells corresponding to the given columns in the row.
|
HeaderCell |
Header.Row.join(Grid.Column<?,?>... columnsToMerge) |
FooterCell |
FooterRow.join(Grid.Column<?,?>... columnsToMerge)
Merges cells corresponding to the given columns in the row.
|
FooterCell |
Footer.Row.join(Grid.Column<?,?>... columnsToMerge) |
| Modifier and Type | Method and Description |
|---|---|
String |
EditorErrorGenerator.apply(Map<Component,Grid.Column<T,?>> fieldToColumn,
BinderValidationStatus<T> status)
Generates an error message from given validation status object.
|
| Modifier and Type | Method and Description |
|---|---|
Grid.Column<T,?> |
ClickableRenderer.RendererClickEvent.getColumn()
Returns the
Grid.Column where the click event originated. |
Grid.Column<T,V> |
AbstractRenderer.getParent() |
| Modifier and Type | Method and Description |
|---|---|
protected Class<Grid.Column> |
AbstractRenderer.getSupportedParentType()
Deprecated.
|
| Constructor and Description |
|---|
RendererClickEvent(Grid<T> source,
T item,
Grid.Column<T,?> column,
MouseEventDetails mouseEventDetails) |
Copyright © 2019 Vaadin Ltd. All rights reserved.