com.qcadoo.view.api.components

Interface GridComponent

All Superinterfaces:

ComponentMessagesHolder, ComponentState

public interface GridComponent
extends ComponentState

Represents grid component

Since:

0.4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.qcadoo.view.api.ComponentState

ComponentState.MessageType

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getColumnNames() Returns column names of the current grid
Map<String,com.qcadoo.view.internal.components.grid.GridComponentColumn>	getColumns()
List<Map<String,String>>	getColumnValuesOfAllRecords() Returns column values of the current grid of all records
List<Map<String,String>>	getColumnValuesOfSelectedRecords() Returns column values of the current grid of selected records
List<Entity>	getEntities() Returns current content of grid
Map<String,String>	getFilters() Gets current filters.
FilterValueHolder	getFilterValue() Gets current criteria modifier parameters value.
GridComponentMultiSearchFilter	getMultiSearchFilter()
List<Entity>	getSelectedEntities() Gets all selected entities
Set<Long>	getSelectedEntitiesIds() Gets ids of all selected entities
Set<String>	getUserHiddenColumns()
void	reloadEntities() Reload content of grid
void	removeFilterForField(String field)
void	setCustomRestriction(CustomRestriction customRestriction) Adds restriction to this grid
void	setEditable(boolean isEditable) Defines if this grid should be editable
void	setEntities(List<Entity> entities) Sets new content of grid Warning: Paging, searching and sorting can not work when grid content is put directly by this method.
void	setFilters(Map<String,String> filters) Sets current filters.
void	setFilterValue(FilterValueHolder value) Sets filter value which will be send to criteria modifier hook.
void	setSelectedEntitiesIds(Set<Long> selectedEntities) Sets new collection of selected entities

Methods inherited from interface com.qcadoo.view.api.ComponentState

getFieldValue, getLocale, getName, getUuid, isEnabled, isHasError, isVisible, performEvent, setEnabled, setFieldValue, setVisible

Methods inherited from interface com.qcadoo.view.api.ComponentMessagesHolder

addMessage, addMessage, addMessage, addMessage, addMessage, addTranslatedMessage, addTranslatedMessage, addTranslatedMessage

Method Detail

getColumnNames

Map<String,String> getColumnNames()

Returns column names of the current grid

Returns:

column names

getColumns

Map<String,com.qcadoo.view.internal.components.grid.GridComponentColumn> getColumns()

getColumnValuesOfAllRecords

List<Map<String,String>> getColumnValuesOfAllRecords()

Returns column values of the current grid of all records

Returns:

column values

getColumnValuesOfSelectedRecords

List<Map<String,String>> getColumnValuesOfSelectedRecords()

Returns column values of the current grid of selected records

Returns:

column values

getEntities

List<Entity> getEntities()

Returns current content of grid

Returns:

all content entities of this grid

getFilters

Map<String,String> getFilters()

Gets current filters.

Returns:

Current filters.

Since:

1.4

getFilterValue

FilterValueHolder getFilterValue()

Gets current criteria modifier parameters value. To modify them use setFilterValue method.

Returns:

Current criteria modifier parameters value.

Since:

1.2.1

getMultiSearchFilter

GridComponentMultiSearchFilter getMultiSearchFilter()

getSelectedEntities

List<Entity> getSelectedEntities()

Gets all selected entities

Returns:

all selected entities

getSelectedEntitiesIds

Set<Long> getSelectedEntitiesIds()

Gets ids of all selected entities

Returns:

ids of all selected entities

getUserHiddenColumns

Set<String> getUserHiddenColumns()

reloadEntities

void reloadEntities()

Reload content of grid

removeFilterForField

void removeFilterForField(String field)

setCustomRestriction

void setCustomRestriction(CustomRestriction customRestriction)

Adds restriction to this grid

Parameters:

customRestriction - additional restriction to this grid

setEditable

void setEditable(boolean isEditable)

Defines if this grid should be editable

Parameters:

isEditable - true if this grid should be editable, false if not

setEntities

void setEntities(List<Entity> entities)

Sets new content of grid Warning: Paging, searching and sorting can not work when grid content is put directly by this method. 'setCustomRestriction' should be used instead wherever possible

Parameters:

entities - new content of grid

setFilters

void setFilters(Map<String,String> filters)

Sets current filters.

Since:

1.6.1

setFilterValue

void setFilterValue(FilterValueHolder value)

Sets filter value which will be send to criteria modifier hook. Set this value in beforeRender hook to make it work correctly.

Parameters:

value -

Since:

1.2.1

setSelectedEntitiesIds

void setSelectedEntitiesIds(Set<Long> selectedEntities)

Sets new collection of selected entities

Parameters:

selectedEntities - ids of selected entities