Class NexcelGroupList

NexcelGroupList

Class Summary
Constructor Attributes Constructor Name and Description
 
NexcelGroupList is a Collection of Groups in the workbook, It is a custom class to handle with all the Group in the WorkBook

Method Summary

Class Detail

NexcelGroupList()
NexcelGroupList is a Collection of Groups in the workbook, It is a custom class to handle with all the Group in the WorkBook
require('NexcelGroupList')

Method Detail

  • <static> NexcelGroupList.add(groupId, groupName, details)
    Adds a new group to the GroupList Collection. The global value of id will be incremented by one to keep new value for upcoming groups.
    Parameters:
    groupId
    The group Id received from database.
    groupName
    The name of teh Group
    details
    It contains all teh details of teh group.like start row, column, header etc..
  • <static> {ArrayList} NexcelGroupList.getGroupObjListOnSheet(sheetId)
    Returns a List of Groups in a Specific Sheet Id.
    Parameters:
    sheetId
    The id of the sheet.
    Returns:
    {ArrayList} A List of GroupObjects in the sheet
  • <static> {ArrayList} NexcelGroupList.getGroupObjListOnWorkBook()
    Returns a List of Groups in a entire WorkBook.
    Returns:
    {ArrayList} A List of GroupObjects in the sheet
  • <static> {ArrayList} NexcelGroupList.getGroupObjListWithGroupFormula(sheetId)
    Returns a List of Groups Which have a GroupFormula
    Parameters:
    sheetId
    Returns:
    {ArrayList}
  • <static> {Integer} NexcelGroupList.getId(groupName)
    Parameters:
    groupName
    The name of the Group.
    Returns:
    {Integer} if the groupName exists it returns Id of teh Group, otherwise false.
  • <static> {ArrayList} NexcelGroupList.getListOfGroupWithGivenCellIsPartOf(sheetId, row, column)
    Returns a List of Groups Which have the cell is a part of
    Parameters:
    sheetId
    row
    Row of teh Cell
    column
    Column of teh cell
    Returns:
    {ArrayList}
  • <static> {Integer} NexcelGroupList.getName(groupId)
    Parameters:
    groupId
    The id of the Group.
    Returns:
    {Integer} if the groupId exists it returns Name of teh Group, otherwise false.
  • <static> {ArrayList} NexcelGroupList.getNameList()
    Returns a List of Groups Names in a entire WorkBook.
    Returns:
    {ArrayList} A List of GroupObjects in the sheet
  • <static> {ArrayList} NexcelGroupList.getNamesSortByName()
    Returns a List of Groups Names in a entire WorkBook sorted by Name.
    Returns:
    {ArrayList} A List of Group names in the sheet
  • <static> {ArrayList} NexcelGroupList.getNamesSortByNameLength()
    Returns a List of Groups Names in a entire WorkBook sorted by Name length.
    Returns:
    {ArrayList} A List of Group names in the sheet
  • <static> {Boolean} NexcelGroupList.isColNameAvailable(groupId)
    Checks whether the groups have the header bar.
    Parameters:
    groupId
    The id of the Group.
    Returns:
    {Boolean} if the group have header exists it returns true otherwise false.
  • <static> {Object} NexcelGroupList.isExist(groupName)
    The function checks whether the given group is available in the GroupList Object , if yest return that object otherwise return false.
    Parameters:
    groupName
    The name of teh Group.
    Returns:
    {Object} if the groupNameexists it returns Object, otherwise false.
  • <static> {Boolean} NexcelGroupList.isGroupFormulaPresent(groupName)
    Checks whether group formula present in the group Object.
    Parameters:
    groupName
    Returns:
    {Boolean}
  • <static> {Void} NexcelGroupList.reName(oldName, newName)
    Renames the Given Group with the new Name.
    Parameters:
    oldName
    newName
    Returns:
    {Void}
  • <static> {Void} NexcelGroupList.setColNameAvailable(groupId)
    It sets whether the First Row is COnsidered as Header, otherwise No header Available.
    Parameters:
    groupId
    The id of the Group.
    Returns:
    {Void}
  • <static> NexcelGroupList.size()
    Returns teh size of teh groups in the Collection.
    Returns:
    size Size of the Collection.