Class ProcessBlock

Object
   |
   +--MoreMotionObject
         |
         +--ProcessBlock

class ProcessBlock

extends MoreMotionObject

Represents a Process Block. A Process Block may contain one or more ProcessRecord objects. This class wraps a container DOM element that can contain child DOM elements.

   <table mo:type="ProcessBlock" mo:name="customers" mo:props="warnColor:'#F5CAC0'" >
     ...
   </table>
 

Field Detail

props

Object props

ProcessBlock Properties Object.



recordManip	The flag that specifies that the process records of this block can be manipulated (add, remove, clone, etc). Please note that record manipulation also requires an additional record in the block to be used as the template. When this flag is true and when this object is initialized it locates the first record in the block and makes it invisible to use it as a template.
selectionColor	The code of a color to use to mark the selected process records of this block
warnColor	The code of a color to use to mark the whole process block background along with a warning such as "No record is selected".

ProcessBlock

ProcessBlock(node)

addRecord

ProcessRecord addRecord()

Creates a new Process Record and appends it at the bottom of the block. If a Process Field exists in the record that needs the record number (e.g. {link CheckBox} then you have to call setRecordNumbers() method of the block.

Returns:
The created Process Record

addRecordBefore

ProcessRecord addRecordBefore(beforeRecordNumber)

Creates a new Process Record and inserts it before the given record number. If a Process Field exists in the record that needs the record number (e.g. {link CheckBox} then you have to call setRecordNumbers() method of the block.

Parameters:
beforeRecordNumber - The number of the record to insert before it

Returns:
The created Process Record

clear

void clear()

Clears the values of all the Process Fields existing in this Process Block

copyRecord

ProcessRecord copyRecord(fromRecordNumber, before)

Copies the specified Process Record. The record that is identified by fromRecordNumber parameter is copied before the record identified by toRecordNumber parameter.

Parameters:
fromRecordNumber - The number of the source record. If this paremeter is null then source is an empty record.
before - Can be a record number or a ProcessRecord. The new record is copied before it.

Returns:
The copied record.

getFirstRecord

ProcessRecord getFirstRecord()

Returns the first Process Record of this block

getForm

ProcessForm getForm()

Returns the Process Form that this Process Block resides in.

getLastRecord

ProcessRecord getLastRecord()

Returns the last Process Record of this block

getRecord

ProcessRecord getRecord(index)

Returns the ProcessRecord object associated with the specified record index. Note: To process all the records of the parent ProcessBlock ProcessRecordIterator object should be used.

Parameters:
index - The index number of the ProcessRecord

getRecordIterator

ProcessRecordIterator getRecordIterator()

Returns a ProcessRecordIterator object to iterate over the process records of this block.

hasInnerPB

Object hasInnerPB()

processAllSelections

void processAllSelections(check)

Checks or unchecks all the process records of this block.

Parameters:
check - Boolean value: true or false

removeAllRecords

void removeAllRecords()

Deletes all the ProcessRecords of this Process Block.

removeWarnColor

void removeWarnColor()

Removes all the marks from the Process Records.

reset

void reset()

Resets the values of all the Process Fields existing in this Process Block

setRecordNumbers

void setRecordNumbers(fields)

Loops over the records of this block and sets the record numbers of the specified ProcessFields existing in the ProcessRecords

Parameters:
fields - The names of the Process Fields separated with commas.

setWarnColor

void setWarnColor()

Sets a background color to all the Process Records in this Process Block to warn the user that no selection is made.

sort

void sort(fieldName, sdir, type)

Sorts the record of this process block

Parameters:
fieldName - The name of the process field to sort
sdir - Either a string that contains the sort direction or a DOM Node to cache and automatize it. Valid values for the sort direction are 'a' for ascending and 'd' for descending
type - The compare type for field values. Valid values are 'n' for number, 's' for string

validate

Boolean validate(acc)

Validates the Process Fields existing in this Process Block.

Returns:
true if all the fields are validates false otherwise.