org.broadleafcommerce.openadmin.web.form.component

Class ListGrid

java.lang.Object

org.broadleafcommerce.openadmin.web.form.component.ListGrid

public class ListGrid
extends java.lang.Object

Nested Class Summary

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 java.lang.Boolean	canFilterAndSort
protected java.lang.String	className
protected java.lang.String	containingEntityId
protected java.lang.String	externalEntitySectionKey
protected java.lang.String	friendlyName
protected java.util.Set<Field>	headerFields
protected java.lang.Boolean	hideIdColumn
protected java.lang.String	idProperty
protected java.lang.Boolean	isReadOnly
protected java.lang.String	listGridType
protected int	order
protected int	pageSize
protected java.lang.String	pathOverride
protected java.util.List<ListGridRecord>	records
protected java.util.List<ListGridAction>	rowActions
protected java.lang.String	sectionKey
protected int	startIndex
protected java.lang.String	subCollectionFieldName
protected java.util.List<ListGridAction>	toolbarActions
protected int	totalRecords

Constructor Summary

Constructors

Constructor and Description
ListGrid()

Method Summary

Modifier and Type	Method and Description
void	addRowAction(ListGridAction action)
void	addToolbarAction(ListGridAction action)
AddMethodType	getAddMethodType()
java.lang.Boolean	getCanFilterAndSort()
java.lang.String	getClassName()
java.lang.Boolean	getClickable()
java.lang.String	getContainingEntityId()
java.lang.String	getExternalEntitySectionKey()
java.lang.String	getFriendlyName()
java.util.Set<Field>	getHeaderFields()
java.lang.Boolean	getHideIdColumn()
java.lang.String	getIdProperty()
java.lang.String	getListGridType()
int	getOrder()
int	getPageSize()
java.lang.String	getPath()
java.lang.String	getPathOverride()
java.lang.Boolean	getReadOnly()
java.util.List<ListGridRecord>	getRecords()
java.util.List<ListGridAction>	getRowActions()
java.lang.String	getSectionKey()
int	getStartIndex()
java.lang.String	getSubCollectionFieldName()
java.util.List<ListGridAction>	getToolbarActions()
int	getTotalRecords()
boolean	isSortable() This grid is sortable if there is a reorder action defined in the toolbar.
void	setAddMethodType(AddMethodType addMethodType)
void	setCanFilterAndSort(java.lang.Boolean canFilterAndSort)
void	setClassName(java.lang.String className)
void	setContainingEntityId(java.lang.String containingEntityId)
void	setExternalEntitySectionKey(java.lang.String externalEntitySectionKey)
void	setFriendlyName(java.lang.String friendlyName)
void	setHeaderFields(java.util.Set<Field> headerFields)
void	setHideIdColumn(java.lang.Boolean hideIdColumn)
void	setIdProperty(java.lang.String idProperty)
void	setListGridType(ListGrid.Type listGridType)
void	setOrder(int order)
void	setPageSize(int pageSize)
void	setPathOverride(java.lang.String pathOverride)
void	setReadOnly(java.lang.Boolean readOnly)
void	setRecords(java.util.List<ListGridRecord> records)
void	setRowActions(java.util.List<ListGridAction> rowActions)
void	setSectionKey(java.lang.String sectionKey)
void	setStartIndex(int startIndex)
void	setSubCollectionFieldName(java.lang.String subCollectionFieldName)
void	setToolbarActions(java.util.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 java.lang.String className

friendlyName

protected java.lang.String friendlyName

idProperty

protected java.lang.String idProperty

order

protected int order

headerFields

protected java.util.Set<Field> headerFields

records

protected java.util.List<ListGridRecord> records

toolbarActions

protected java.util.List<ListGridAction> toolbarActions

rowActions

protected java.util.List<ListGridAction> rowActions

totalRecords

protected int totalRecords

startIndex

protected int startIndex

pageSize

protected int pageSize

canFilterAndSort

protected java.lang.Boolean canFilterAndSort

isReadOnly

protected java.lang.Boolean isReadOnly

hideIdColumn

protected java.lang.Boolean hideIdColumn

addMethodType

protected AddMethodType addMethodType

listGridType

protected java.lang.String listGridType

sectionKey

protected java.lang.String sectionKey

externalEntitySectionKey

protected java.lang.String externalEntitySectionKey

containingEntityId

protected java.lang.String containingEntityId

subCollectionFieldName

protected java.lang.String subCollectionFieldName

pathOverride

protected java.lang.String pathOverride

Constructor Detail

ListGrid

public ListGrid()

Method Detail

getPath

public java.lang.String getPath()

addRowAction

public void addRowAction(ListGridAction action)

addToolbarAction

public void addToolbarAction(ListGridAction action)

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)

getCanFilterAndSort

public java.lang.Boolean getCanFilterAndSort()

getReadOnly

public java.lang.Boolean getReadOnly()

getClickable

public java.lang.Boolean getClickable()

getHideIdColumn

public java.lang.Boolean getHideIdColumn()

getIdProperty

public java.lang.String getIdProperty()

setIdProperty

public void setIdProperty(java.lang.String idProperty)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String className)

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

getHeaderFields

public java.util.Set<Field> getHeaderFields()

setHeaderFields

public void setHeaderFields(java.util.Set<Field> headerFields)

getRecords

public java.util.List<ListGridRecord> getRecords()

setRecords

public void setRecords(java.util.List<ListGridRecord> records)

getToolbarActions

public java.util.List<ListGridAction> getToolbarActions()

setToolbarActions

public void setToolbarActions(java.util.List<ListGridAction> toolbarActions)

getRowActions

public java.util.List<ListGridAction> getRowActions()

setRowActions

public void setRowActions(java.util.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(java.lang.Boolean canFilterAndSort)

getAddMethodType

public AddMethodType getAddMethodType()

setAddMethodType

public void setAddMethodType(AddMethodType addMethodType)

getListGridType

public java.lang.String getListGridType()

getContainingEntityId

public java.lang.String getContainingEntityId()

setContainingEntityId

public void setContainingEntityId(java.lang.String containingEntityId)

getSubCollectionFieldName

public java.lang.String getSubCollectionFieldName()

setSubCollectionFieldName

public void setSubCollectionFieldName(java.lang.String subCollectionFieldName)

getFriendlyName

public java.lang.String getFriendlyName()

setFriendlyName

public void setFriendlyName(java.lang.String friendlyName)

getSectionKey

public java.lang.String getSectionKey()

setSectionKey

public void setSectionKey(java.lang.String sectionKey)

getExternalEntitySectionKey

public java.lang.String getExternalEntitySectionKey()

setExternalEntitySectionKey

public void setExternalEntitySectionKey(java.lang.String externalEntitySectionKey)

getPathOverride

public java.lang.String getPathOverride()

setPathOverride

public void setPathOverride(java.lang.String pathOverride)

setReadOnly

public void setReadOnly(java.lang.Boolean readOnly)

setHideIdColumn

public void setHideIdColumn(java.lang.Boolean hideIdColumn)