Package org.broadleafcommerce.openadmin.web.form.component

Class ListGrid

java.lang.Object
org.broadleafcommerce.openadmin.web.form.component.ListGrid
public class ListGrid extends Object

  • Field Details

    • 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

    • multiSelectCheckBoxOnly

      protected boolean multiSelectCheckBoxOnly

    • addMethodType

      protected AddMethodType addMethodType

    • listGridType

      protected String listGridType

    • selectType

      protected String selectType

    • selectizeUrl

      protected String selectizeUrl

    • manualFetch

      protected Boolean manualFetch

    • helpText

      protected String helpText

    • 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 Details

    • ListGrid

      public ListGrid()

  • Method Details

    • 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:

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

    • setSelectTypeString

      public void setSelectTypeString(String selectType)

    • getCanFilterAndSort

      public Boolean getCanFilterAndSort()

    • setCanFilterAndSort

      public void setCanFilterAndSort(Boolean canFilterAndSort)

    • getIsReadOnly

      public Boolean getIsReadOnly()

    • setIsReadOnly

      public void setIsReadOnly(Boolean readOnly)

    • getClickable

      public Boolean getClickable()

    • getHideIdColumn

      public Boolean getHideIdColumn()

    • setHideIdColumn

      public void setHideIdColumn(Boolean hideIdColumn)

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

    • isEmpty

      public boolean isEmpty()

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

    • getAddMethodType

      public AddMethodType getAddMethodType()

    • setAddMethodType

      public void setAddMethodType(AddMethodType addMethodType)

    • getListGridType

      public String getListGridType()

    • setListGridType

      public void setListGridType(ListGrid.Type listGridType)

    • getSelectType

      public String getSelectType()

    • setSelectType

      public void setSelectType(ListGrid.SelectType selectType)

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

    • getManualFetch

      public Boolean getManualFetch()

    • setManualFetch

      public void setManualFetch(Boolean manualFetch)

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

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

    • getHelpText

      public String getHelpText()

    • setHelpText

      public void setHelpText(String helpText)

    • isMultiSelectCheckBoxOnly

      public boolean isMultiSelectCheckBoxOnly()

    • setMultiSelectCheckBoxOnly

      public void setMultiSelectCheckBoxOnly(boolean multiSelectCheckBoxOnly)

    • addCssClass

      public void addCssClass(String className)

    • removeCssClass

      public void removeCssClass(String className)

    • clearCssClasses

      public void clearCssClasses()

    • getCssClassNames

      public String getCssClassNames()

    • getFirstSearchableFieldFriendlyName

      public String getFirstSearchableFieldFriendlyName()

    • isHtmlEscapeMainEntityLink

      public boolean isHtmlEscapeMainEntityLink()

    • setHtmlEscapeMainEntityLink

      public void setHtmlEscapeMainEntityLink(boolean htmlEscapeMainEntityLink)