ListGrid (BroadleafCommerce 5.0.19-SNAPSHOT API)

java.lang.Object
- org.broadleafcommerce.openadmin.web.form.component.ListGrid

```
public class ListGrid
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListGrid.SelectType

static class ListGrid.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListGrid.SelectType`
`static class`	`ListGrid.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`protected AddMethodType`	`addMethodType`
`protected Boolean`	`canFilterAndSort`
`protected String`	`className`
`protected String`	`containingEntityId`
`protected DataWrapper`	`dataWrapper`
`protected String`	`externalEntitySectionKey`
`protected String`	`fetchType`
`protected String`	`fieldBuilder`
`protected FieldWrapper`	`fieldWrapper`
`protected long`	`firstId`
`protected String`	`friendlyName`
`protected Set<Field>`	`headerFields`
`protected boolean`	`hideFriendlyName`
`protected Boolean`	`hideIdColumn`
`protected String`	`idProperty`
`protected Boolean`	`isReadOnly`
`protected boolean`	`isSortable`
`protected String`	`json`
`protected String`	`jsonFieldName`
`protected long`	`lastId`
`protected String`	`listGridType`
`protected int`	`lowerCount`
`protected List<ListGridAction>`	`modalRowActions`
`protected int`	`order`
`protected int`	`pageSize`
`protected String`	`pathOverride`
`protected boolean`	`promptSearch`
`protected List<ListGridRecord>`	`records`
`protected List<ListGridActionGroup>`	`rowActionGroups`
`protected List<ListGridAction>`	`rowActions`
`protected String`	`searchFieldsTemplateOverride`
`protected List<SectionCrumb>`	`sectionCrumbs`
`protected String`	`sectionKey`
`protected String`	`selectizeUrl`
`protected String`	`selectType`
`protected int`	`startIndex`
`protected String`	`subCollectionFieldName`
`protected String`	`templateOverride`
`protected List<ListGridActionGroup>`	`toolbarActionGroups`
`protected List<ListGridAction>`	`toolbarActions`
`protected boolean`	`totalCountLessThanPageSize`
`protected int`	`totalRecords`
`protected int`	`upperCount`

Constructor Summary

Constructors
Constructor and Description

ListGrid()

Constructors
Constructor and Description
`ListGrid()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addModalRowAction(ListGridAction action)`
`void`	`addRowAction(ListGridAction action)`
`void`	`addRowActionGroup(ListGridActionGroup actionGroup)`
`void`	`addToolbarAction(ListGridAction action)`
`void`	`addToolbarActionGroup(ListGridActionGroup actionGroup)`
`Field`	`findHeaderField(String name)`
`ListGridAction`	`findModalRowAction(String actionId)`
`ListGridAction`	`findRowAction(String actionId)`
`ListGridAction`	`findToolbarAction(String actionId)`
`List<ListGridAction>`	`getActiveModalRowActions()` Grabs a filtered list of row actions filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen
`List<ListGridAction>`	`getActiveRowActionGroups()` Grabs a filtered list of row action groupss filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen
`List<ListGridAction>`	`getActiveRowActions()` Grabs a filtered list of row actions filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen
`List<ListGridAction>`	`getActiveToolbarActionGroups()` Grabs a filtered list of toolbar action groupss filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen
`List<ListGridAction>`	`getActiveToolbarActions()` Grabs a filtered list of toolbar actions filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen
`AddMethodType`	`getAddMethodType()`
`Boolean`	`getCanFilterAndSort()`
`String`	`getClassName()`
`Boolean`	`getClickable()`
`String`	`getContainingEntityId()`
`DataWrapper`	`getDataWrapper()`
`String`	`getExternalEntitySectionKey()`
`String`	`getFetchType()`
`String`	`getFieldBuilder()`
`FieldWrapper`	`getFieldWrapper()`
`long`	`getFirstId()`
`String`	`getFriendlyName()`
`Set<Field>`	`getHeaderFields()`
`boolean`	`getHideFriendlyName()`
`Boolean`	`getHideIdColumn()`
`String`	`getIdProperty()`
`Boolean`	`getIsReadOnly()`
`boolean`	`getIsSortable()`
`String`	`getJson()`
`String`	`getJsonFieldName()`
`long`	`getLastId()`
`String`	`getListGridType()`
`int`	`getLowerCount()`
`List<ListGridAction>`	`getModalRowActions()`
`int`	`getOrder()`
`int`	`getPageSize()`
`String`	`getPath()`
`String`	`getPathOverride()`
`List<ListGridRecord>`	`getRecords()`
`List<ListGridActionGroup>`	`getRowActionGroups()`
`List<ListGridAction>`	`getRowActions()`
`String`	`getSearchFieldsTemplateOverride()`
`String`	`getSectionCrumbRepresentation()`
`List<SectionCrumb>`	`getSectionCrumbs()`
`String`	`getSectionKey()`
`String`	`getSelectizeUrl()`
`String`	`getSelectType()`
`int`	`getStartIndex()`
`String`	`getSubCollectionFieldName()`
`String`	`getTemplateOverride()`
`List<ListGridActionGroup>`	`getToolbarActionGroups()`
`List<ListGridAction>`	`getToolbarActions()`
`int`	`getTotalRecords()`
`int`	`getUpperCount()`
`boolean`	`isPromptSearch()`
`boolean`	`isSortable()` This grid is sortable if there is a reorder action defined in the toolbar.
`boolean`	`isTotalCountLessThanPageSize()`
`void`	`removeAllModalRowActions()`
`void`	`removeAllRowActionGroups()`
`void`	`removeAllRowActions()`
`void`	`removeAllToolbarActionGroups()`
`void`	`removeAllToolbarActions()`
`void`	`setAddMethodType(AddMethodType addMethodType)`
`void`	`setCanFilterAndSort(Boolean canFilterAndSort)`
`void`	`setClassName(String className)`
`void`	`setContainingEntityId(String containingEntityId)`
`void`	`setDataWrapper(DataWrapper dataWrapper)`
`void`	`setExternalEntitySectionKey(String externalEntitySectionKey)`
`void`	`setFetchType(String fetchType)`
`void`	`setFieldBuilder(String fieldBuilder)`
`void`	`setFieldWrapper(FieldWrapper fieldWrapper)`
`void`	`setFirstId(long firstId)`
`void`	`setFriendlyName(String friendlyName)`
`void`	`setHeaderFields(Set<Field> headerFields)`
`void`	`setHideFriendlyName(boolean hideFriendlyName)`
`void`	`setHideIdColumn(Boolean hideIdColumn)`
`void`	`setIdProperty(String idProperty)`
`void`	`setIsReadOnly(Boolean readOnly)`
`void`	`setIsSortable(boolean isSortable)`
`void`	`setJson(String json)`
`void`	`setJsonFieldName(String jsonFieldName)`
`void`	`setLastId(long lastId)`
`void`	`setListGridType(ListGrid.Type listGridType)`
`void`	`setListGridTypeString(String listGridType)` Allows for completely custom types other than the ones defined `ListGrid.Type` to assign unique handlers to on the JS side
`void`	`setLowerCount(int lowerCount)`
`void`	`setModalRowActions(List<ListGridAction> modalRowActions)`
`void`	`setOrder(int order)`
`void`	`setPageSize(int pageSize)`
`void`	`setPathOverride(String pathOverride)`
`void`	`setPromptSearch(boolean promptSearch)`
`void`	`setRecords(List<ListGridRecord> records)`
`void`	`setRowActionGroups(List<ListGridActionGroup> rowActionGroups)`
`void`	`setRowActions(List<ListGridAction> rowActions)`
`void`	`setSearchFieldsTemplateOverride(String searchFieldsTemplateOverride)`
`void`	`setSectionCrumbs(List<SectionCrumb> sectionCrumbs)`
`void`	`setSectionKey(String sectionKey)`
`void`	`setSelectizeUrl(String selectizeUrl)`
`void`	`setSelectType(ListGrid.SelectType selectType)`
`void`	`setSelectTypeString(String selectType)`
`void`	`setStartIndex(int startIndex)`
`void`	`setSubCollectionFieldName(String subCollectionFieldName)`
`void`	`setTemplateOverride(String templateOverride)`
`void`	`setToolbarActionGroups(List<ListGridActionGroup> toolbarActionGroups)`
`void`	`setToolbarActions(List<ListGridAction> toolbarActions)`
`void`	`setTotalCountLessThanPageSize(boolean totalCountLessThanPageSize)`
`void`	`setTotalRecords(int totalRecords)`
`void`	`setUpperCount(int upperCount)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

className
```
protected String className
```

friendlyName
```
protected String friendlyName
```

idProperty
```
protected String idProperty
```

order
```
protected int order
```

isSortable
```
protected boolean isSortable
```

hideFriendlyName
```
protected boolean hideFriendlyName
```

headerFields
```
protected Set<Field> headerFields
```

records
```
protected List<ListGridRecord> records
```

toolbarActions

protected List<ListGridAction> toolbarActions

rowActions

protected List<ListGridAction> rowActions

toolbarActionGroups

protected List<ListGridActionGroup> toolbarActionGroups

rowActionGroups

protected List<ListGridActionGroup> rowActionGroups

modalRowActions

protected List<ListGridAction> modalRowActions

totalRecords
```
protected int totalRecords
```

startIndex
```
protected int startIndex
```

pageSize
```
protected int pageSize
```

canFilterAndSort
```
protected Boolean canFilterAndSort
```

isReadOnly
```
protected Boolean isReadOnly
```

hideIdColumn
```
protected Boolean hideIdColumn
```

fetchType
```
protected String fetchType
```

firstId
```
protected long firstId
```

lastId
```
protected long lastId
```

upperCount
```
protected int upperCount
```

lowerCount
```
protected int lowerCount
```

totalCountLessThanPageSize

protected boolean totalCountLessThanPageSize

promptSearch
```
protected boolean promptSearch
```

addMethodType
```
protected AddMethodType addMethodType
```

listGridType
```
protected String listGridType
```

selectType
```
protected String selectType
```

selectizeUrl
```
protected String selectizeUrl
```

sectionKey
```
protected String sectionKey
```

sectionCrumbs

protected List<SectionCrumb> sectionCrumbs

externalEntitySectionKey

protected String externalEntitySectionKey

containingEntityId
```
protected String containingEntityId
```

subCollectionFieldName

protected String subCollectionFieldName

pathOverride
```
protected String pathOverride
```

searchFieldsTemplateOverride

protected String searchFieldsTemplateOverride

templateOverride
```
protected String templateOverride
```

fieldBuilder
```
protected String fieldBuilder
```

dataWrapper
```
protected DataWrapper dataWrapper
```

json
```
protected String json
```

jsonFieldName
```
protected String jsonFieldName
```

fieldWrapper
```
protected FieldWrapper fieldWrapper
```

Constructor Detail
- ListGrid
```
public ListGrid()
```

Method Detail

getPath
```
public String getPath()
```

getSectionCrumbRepresentation

public String getSectionCrumbRepresentation()

getActiveToolbarActions
```
public List<ListGridAction> getActiveToolbarActions()
```
Grabs a filtered list of toolbar actions filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen

getActiveRowActions
```
public List<ListGridAction> getActiveRowActions()
```
Grabs a filtered list of row actions filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen

getActiveToolbarActionGroups
```
public List<ListGridAction> getActiveToolbarActionGroups()
```
Grabs a filtered list of toolbar action groupss filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen

getActiveRowActionGroups
```
public List<ListGridAction> getActiveRowActionGroups()
```
Grabs a filtered list of row action groupss filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen

getActiveModalRowActions
```
public List<ListGridAction> getActiveModalRowActions()
```
Grabs a filtered list of row actions filtered by whether or not they match the same readonly state as the listgrid and are thus shown on the screen

addRowAction

public void addRowAction(ListGridAction action)

addModalRowAction

public void addModalRowAction(ListGridAction action)

addToolbarAction

public void addToolbarAction(ListGridAction action)

removeAllToolbarActions
```
public void removeAllToolbarActions()
```

removeAllRowActions
```
public void removeAllRowActions()
```

addToolbarActionGroup

public void addToolbarActionGroup(ListGridActionGroup actionGroup)

removeAllToolbarActionGroups

public void removeAllToolbarActionGroups()

addRowActionGroup

public void addRowActionGroup(ListGridActionGroup actionGroup)

removeAllRowActionGroups

public void removeAllRowActionGroups()

removeAllModalRowActions

public void removeAllModalRowActions()

findToolbarAction

public ListGridAction findToolbarAction(String actionId)

findRowAction

public ListGridAction findRowAction(String actionId)

findModalRowAction

public ListGridAction findModalRowAction(String actionId)

isSortable
```
public boolean isSortable()
```
This grid is sortable if there is a reorder action defined in the toolbar. If records can be reordered, then the sort functionality doesn't make any sense. Also, map structures are currently unsortable.

Returns:

setListGridType

public void setListGridType(ListGrid.Type listGridType)

setListGridTypeString
```
public void setListGridTypeString(String listGridType)
```
Allows for completely custom types other than the ones defined ListGrid.Type to assign unique handlers to on the JS side

Parameters:

listGridType -

setSelectType

public void setSelectType(ListGrid.SelectType selectType)

setSelectTypeString

public void setSelectTypeString(String selectType)

getCanFilterAndSort
```
public Boolean getCanFilterAndSort()
```

getIsReadOnly
```
public Boolean getIsReadOnly()
```

getClickable
```
public Boolean getClickable()
```

getHideIdColumn
```
public Boolean getHideIdColumn()
```

getIdProperty
```
public String getIdProperty()
```

setIdProperty

public void setIdProperty(String idProperty)

getClassName
```
public String getClassName()
```

setClassName

public void setClassName(String className)

getOrder
```
public int getOrder()
```

setOrder
```
public void setOrder(int order)
```

getIsSortable
```
public boolean getIsSortable()
```

setIsSortable

public void setIsSortable(boolean isSortable)

getHideFriendlyName
```
public boolean getHideFriendlyName()
```

setHideFriendlyName

public void setHideFriendlyName(boolean hideFriendlyName)

getHeaderFields
```
public Set<Field> getHeaderFields()
```

setHeaderFields

public void setHeaderFields(Set<Field> headerFields)

findHeaderField

public Field findHeaderField(String name)

getRecords

public List<ListGridRecord> getRecords()

setRecords

public void setRecords(List<ListGridRecord> records)

getToolbarActions

public List<ListGridAction> getToolbarActions()

setToolbarActions

public void setToolbarActions(List<ListGridAction> toolbarActions)

getRowActions

public List<ListGridAction> getRowActions()

setRowActions

public void setRowActions(List<ListGridAction> rowActions)

getToolbarActionGroups

public List<ListGridActionGroup> getToolbarActionGroups()

setToolbarActionGroups

public void setToolbarActionGroups(List<ListGridActionGroup> toolbarActionGroups)

getRowActionGroups

public List<ListGridActionGroup> getRowActionGroups()

setRowActionGroups

public void setRowActionGroups(List<ListGridActionGroup> rowActionGroups)

getModalRowActions

public List<ListGridAction> getModalRowActions()

setModalRowActions

public void setModalRowActions(List<ListGridAction> modalRowActions)

getStartIndex
```
public int getStartIndex()
```

setStartIndex

public void setStartIndex(int startIndex)

getTotalRecords
```
public int getTotalRecords()
```

setTotalRecords

public void setTotalRecords(int totalRecords)

getPageSize
```
public int getPageSize()
```

setPageSize

public void setPageSize(int pageSize)

setCanFilterAndSort

public void setCanFilterAndSort(Boolean canFilterAndSort)

getAddMethodType

public AddMethodType getAddMethodType()

setAddMethodType

public void setAddMethodType(AddMethodType addMethodType)

getListGridType
```
public String getListGridType()
```

getSelectType
```
public String getSelectType()
```

getContainingEntityId
```
public String getContainingEntityId()
```

setContainingEntityId

public void setContainingEntityId(String containingEntityId)

getSubCollectionFieldName

public String getSubCollectionFieldName()

setSubCollectionFieldName

public void setSubCollectionFieldName(String subCollectionFieldName)

getFriendlyName
```
public String getFriendlyName()
```

setFriendlyName

public void setFriendlyName(String friendlyName)

getSectionKey
```
public String getSectionKey()
```

setSectionKey

public void setSectionKey(String sectionKey)

getSelectizeUrl
```
public String getSelectizeUrl()
```

setSelectizeUrl

public void setSelectizeUrl(String selectizeUrl)

getExternalEntitySectionKey

public String getExternalEntitySectionKey()

setExternalEntitySectionKey

public void setExternalEntitySectionKey(String externalEntitySectionKey)

getPathOverride
```
public String getPathOverride()
```

setPathOverride

public void setPathOverride(String pathOverride)

getSearchFieldsTemplateOverride

public String getSearchFieldsTemplateOverride()

setSearchFieldsTemplateOverride

public void setSearchFieldsTemplateOverride(String searchFieldsTemplateOverride)

getTemplateOverride
```
public String getTemplateOverride()
```

setTemplateOverride

public void setTemplateOverride(String templateOverride)

setIsReadOnly

public void setIsReadOnly(Boolean readOnly)

setHideIdColumn

public void setHideIdColumn(Boolean hideIdColumn)

getSectionCrumbs

public List<SectionCrumb> getSectionCrumbs()

setSectionCrumbs

public void setSectionCrumbs(List<SectionCrumb> sectionCrumbs)

getFieldBuilder
```
public String getFieldBuilder()
```

setFieldBuilder

public void setFieldBuilder(String fieldBuilder)

getFieldWrapper
```
public FieldWrapper getFieldWrapper()
```

setFieldWrapper

public void setFieldWrapper(FieldWrapper fieldWrapper)

getDataWrapper
```
public DataWrapper getDataWrapper()
```

setDataWrapper

public void setDataWrapper(DataWrapper dataWrapper)

getJson
```
public String getJson()
```

setJson
```
public void setJson(String json)
```

getJsonFieldName
```
public String getJsonFieldName()
```

setJsonFieldName

public void setJsonFieldName(String jsonFieldName)

getFetchType
```
public String getFetchType()
```

setFetchType

public void setFetchType(String fetchType)

getFirstId
```
public long getFirstId()
```

setFirstId
```
public void setFirstId(long firstId)
```

getLastId
```
public long getLastId()
```

setLastId
```
public void setLastId(long lastId)
```

getUpperCount
```
public int getUpperCount()
```

setUpperCount

public void setUpperCount(int upperCount)

getLowerCount
```
public int getLowerCount()
```

setLowerCount

public void setLowerCount(int lowerCount)

isTotalCountLessThanPageSize

public boolean isTotalCountLessThanPageSize()

setTotalCountLessThanPageSize

public void setTotalCountLessThanPageSize(boolean totalCountLessThanPageSize)

isPromptSearch
```
public boolean isPromptSearch()
```

setPromptSearch

public void setPromptSearch(boolean promptSearch)

Class ListGrid

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

className

friendlyName

idProperty

order

isSortable

hideFriendlyName

headerFields

records

toolbarActions

rowActions

toolbarActionGroups

rowActionGroups

modalRowActions

totalRecords

startIndex

pageSize

canFilterAndSort

isReadOnly

hideIdColumn

fetchType

firstId

lastId

upperCount

lowerCount

totalCountLessThanPageSize

promptSearch

addMethodType

listGridType

selectType

selectizeUrl

sectionKey

sectionCrumbs

externalEntitySectionKey

containingEntityId

subCollectionFieldName

pathOverride

searchFieldsTemplateOverride

templateOverride

fieldBuilder

dataWrapper

json

jsonFieldName

fieldWrapper

Constructor Detail

ListGrid

Method Detail

getPath

getSectionCrumbRepresentation

getActiveToolbarActions

getActiveRowActions

getActiveToolbarActionGroups

getActiveRowActionGroups

getActiveModalRowActions

addRowAction

addModalRowAction

addToolbarAction

removeAllToolbarActions

removeAllRowActions

addToolbarActionGroup

removeAllToolbarActionGroups

addRowActionGroup

removeAllRowActionGroups

removeAllModalRowActions

findToolbarAction

findRowAction

findModalRowAction

isSortable

setListGridType

setListGridTypeString

setSelectType

setSelectTypeString

getCanFilterAndSort

getIsReadOnly