ListGrid (BroadleafCommerce Open Admin Platform 4.0.17-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.Type

Nested Classes
Modifier and Type	Class and Description
`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 String`	`externalEntitySectionKey`
`protected String`	`friendlyName`
`protected Set<Field>`	`headerFields`
`protected Boolean`	`hideIdColumn`
`protected String`	`idProperty`
`protected Boolean`	`isReadOnly`
`protected String`	`listGridType`
`protected int`	`order`
`protected int`	`pageSize`
`protected String`	`pathOverride`
`protected List<ListGridRecord>`	`records`
`protected List<ListGridAction>`	`rowActions`
`protected List<SectionCrumb>`	`sectionCrumbs`
`protected String`	`sectionKey`
`protected int`	`startIndex`
`protected String`	`subCollectionFieldName`
`protected List<ListGridAction>`	`toolbarActions`
`protected int`	`totalRecords`

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`	`addRowAction(ListGridAction action)`
`void`	`addToolbarAction(ListGridAction action)`
`ListGridAction`	`findRowAction(String actionId)`
`ListGridAction`	`findToolbarAction(String actionId)`
`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>`	`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()`
`String`	`getExternalEntitySectionKey()`
`String`	`getFriendlyName()`
`Set<Field>`	`getHeaderFields()`
`Boolean`	`getHideIdColumn()`
`String`	`getIdProperty()`
`String`	`getListGridType()`
`int`	`getOrder()`
`int`	`getPageSize()`
`String`	`getPath()`
`String`	`getPathOverride()`
`Boolean`	`getReadOnly()`
`List<ListGridRecord>`	`getRecords()`
`List<ListGridAction>`	`getRowActions()`
`String`	`getSectionCrumbRepresentation()`
`List<SectionCrumb>`	`getSectionCrumbs()`
`String`	`getSectionKey()`
`int`	`getStartIndex()`
`String`	`getSubCollectionFieldName()`
`List<ListGridAction>`	`getToolbarActions()`
`int`	`getTotalRecords()`
`boolean`	`isSortable()` This grid is sortable if there is a reorder action defined in the toolbar.
`void`	`removeAllRowActions()`
`void`	`removeAllToolbarActions()`
`void`	`setAddMethodType(AddMethodType addMethodType)`
`void`	`setCanFilterAndSort(Boolean canFilterAndSort)`
`void`	`setClassName(String className)`
`void`	`setContainingEntityId(String containingEntityId)`
`void`	`setExternalEntitySectionKey(String externalEntitySectionKey)`
`void`	`setFriendlyName(String friendlyName)`
`void`	`setHeaderFields(Set<Field> headerFields)`
`void`	`setHideIdColumn(Boolean hideIdColumn)`
`void`	`setIdProperty(String idProperty)`
`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`	`setOrder(int order)`
`void`	`setPageSize(int pageSize)`
`void`	`setPathOverride(String pathOverride)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setRecords(List<ListGridRecord> records)`
`void`	`setRowActions(List<ListGridAction> rowActions)`
`void`	`setSectionCrumbs(List<SectionCrumb> sectionCrumbs)`
`void`	`setSectionKey(String sectionKey)`
`void`	`setStartIndex(int startIndex)`
`void`	`setSubCollectionFieldName(String subCollectionFieldName)`
`void`	`setToolbarActions(List<ListGridAction> toolbarActions)`
`void`	`setTotalRecords(int totalRecords)`

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
```

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

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

toolbarActions

protected List<ListGridAction> toolbarActions

rowActions

protected List<ListGridAction> rowActions

totalRecords
```
protected int totalRecords
```

startIndex
```
protected int startIndex
```

pageSize
```
protected int pageSize
```

canFilterAndSort
```
protected Boolean canFilterAndSort
```

isReadOnly
```
protected Boolean isReadOnly
```

hideIdColumn
```
protected Boolean hideIdColumn
```

addMethodType
```
protected AddMethodType addMethodType
```

listGridType
```
protected String listGridType
```

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
```

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

addRowAction

public void addRowAction(ListGridAction action)

addToolbarAction

public void addToolbarAction(ListGridAction action)

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

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

findToolbarAction

public ListGridAction findToolbarAction(String actionId)

findRowAction

public ListGridAction findRowAction(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 -

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

getReadOnly
```
public Boolean getReadOnly()
```

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)
```

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

setHeaderFields

public void setHeaderFields(Set<Field> headerFields)

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)

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()
```

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)

getExternalEntitySectionKey

public String getExternalEntitySectionKey()

setExternalEntitySectionKey

public void setExternalEntitySectionKey(String externalEntitySectionKey)

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

setPathOverride

public void setPathOverride(String pathOverride)

setReadOnly

public void setReadOnly(Boolean readOnly)

setHideIdColumn

public void setHideIdColumn(Boolean hideIdColumn)

getSectionCrumbs

public List<SectionCrumb> getSectionCrumbs()

setSectionCrumbs

public void setSectionCrumbs(List<SectionCrumb> sectionCrumbs)

Class ListGrid

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

className

friendlyName

idProperty

order

headerFields

records

toolbarActions

rowActions

totalRecords

startIndex

pageSize

canFilterAndSort

isReadOnly

hideIdColumn

addMethodType

listGridType

sectionKey

sectionCrumbs

externalEntitySectionKey

containingEntityId

subCollectionFieldName

pathOverride

Constructor Detail

ListGrid

Method Detail

getPath

getSectionCrumbRepresentation

getActiveToolbarActions

getActiveRowActions

addRowAction

addToolbarAction

removeAllToolbarActions

removeAllRowActions

findToolbarAction

findRowAction

isSortable

setListGridType

setListGridTypeString

getCanFilterAndSort

getReadOnly

getClickable

getHideIdColumn

getIdProperty

setIdProperty

getClassName

setClassName

getOrder

setOrder

getHeaderFields

setHeaderFields

getRecords

setRecords

getToolbarActions

setToolbarActions

getRowActions

setRowActions

getStartIndex

setStartIndex

getTotalRecords

setTotalRecords

getPageSize

setPageSize

setCanFilterAndSort

getAddMethodType

setAddMethodType

getListGridType

getContainingEntityId

setContainingEntityId

getSubCollectionFieldName

setSubCollectionFieldName

getFriendlyName

setFriendlyName

getSectionKey