Col (type in module tri )

Methods

• Col(props)

  Constructor of the the Col object. Performs the following functions:

  • classifies the Col type into 'virt' (col property points to a function) or 'field'
  • assigns a cid property that makes the each column unique in the entire system across all Tables.
  • Builds a column map table based on the cid

  Parameters

  • props – {Object} –

    Properties array used to define the column in static object.

• getActions($scope, oObj)

  Builds an array of Action objects from a Col whose type is 'actions'. The following algorithm is used to build the array.

  • returns an empty array if the type is not 'actions'
  • Adds defualt editRecord and dropRecord actions unless the Col addDefault property is false
  • hooks the methClass, method, click, whatClass function pointers into the $scope.

  Parameters

  • $scope – {scope} –

    of HTML caller

  • oObj – {Object} –

    obsolete. not referenced.

  Returns

  {Object[]} –

  array of Action objects

• getField()

  Returns field name in table column is related to. For type = 'virt' the constant 'field' is returned.

  Returns

  {string} –

  related field name

• getHint()

  Returns the hint field that is added to Standard Editor input fields as a 'title=' string. If hint in the column definition is a function it is called with the signature this.hint(scope,this). Otherwise the string value is returned.

  Returns

  {string} –

  computed hint.

• getID()

  Returns the getTitle value with blanks replaced by '-'. Used in the HTML templates to create element IDs based on the column name that can be refenced in the CSS.

  Returns

  {string} –

  title modified

• getListHint()

  Returns the hint field that is added to the list columns of the Lister. The field is assumed to be a function which is called with signature this.listHint(scope,oObj,this) where oObj is the row being displayed.

  Returns

  {string} –

  computed hint.

• getPlace()

  Returns the place-holder field that is added to Standard Editor input fields as a 'placeHolder=' string. If place in the column definition is a function it is called with the signature this.place(scope,this). Otherwise the string value is returned.

  Returns

  {string} –

  computed place-holder.

• getTitle()

  Returns the Col title

  Returns

  {string} –

  Col name used for public display

• getValue(scope, oObj, nMax)

  Returns the value of oObj for the Col. Invokes any necessary functions to calculate the value. If the nMax field is present the computed string is checked that is does not exceed that length. If it does it is shortened and the string ... added such that the string's length equals the nMax field.

  Parameters

  • scope – {Object} –

    The present scope

  • oObj – {Object} –

    the data object to extract the Col from.

  • nMax – {number} –

    optional max string length returned

  Returns

  {string} –

  the computed value

• select(scope, oCols, sType)

  Extends the supplied array of Col objects with this Col if it matches the sType parameter which can have the following values:

  • '=list' - matches columns of type not 'list' and whose 'showList' value returns true.
  • '=edit' - matches columns of type 'virt', 'action', 'list' and 'actions' and whose default 'showEdit' value returns true else those whose specified showEdit value returns 'true'
  • '=cust' - matches columns of type '=cust' or whose specified 'showCust' value returns true.
  • null - matches all columns

  Parameters

  • scope – {Object} –

    caller scope

  • oCols – {Object[]} –

    array of Col objects to extend

  • sType – {string} –

    to match against Col type. sType = null matches all.