METHODS

Return HOME

METHODS ARGUMENTS LEGEND:

 - attributeName: Attribute Name for the Menu or Cell.
 - attributeList: JSON object list with Attribute Name and values.
 - dataid: Name of ID in the DataSet information.
 - elid: DOMelement ID in the Menu
 - menuid: Name of ID in the jMenu Initialization
 - refresh: Refresh attribute? true force DOMelement updates.
 - sharedkey: Name of Key in shared memory;
 - sharedvalue: Valume of Key in the shared memory.
 - state: Boolean for State Mode, true enable the action.

METHODS FUNCTIONS:

 - destroy()

     Arguments:
         No arguments required

     Return: 
         Boolen: True | False

 - getAttribute( attributeName )

     Arguments:
         attributeName: no required, defaults: list all attributes (if missed).

     Return:
         JSON: list of values or
         Value: Attribute Value

 - getAttributeCell( dataid, attributeName )

    Arguments:
         dataid: required.
         attributeName: not required, defaults: list all attributes (if missed).

     Return:
         JSON:
            notfound: Number of not mapped DOMelement.
            data: attributes in each DOMelements

 - getAttributeId( elid, attributeName )

     Arguments:
         elid: required.

     Return:
         JSON:
            notfound: Number of not mapped DOMelement.
            data: attributes in each DOMelements.

 - getBlinker()

     Arguments:
         No arguments required.

     Return:
         Boolean: The current blinker mode

 - getDisableCell( dataid )

     Arguments:
         dataid: required

     Return:
         JSON:
            off: Number of disabled cell
            on: Number of enabled cell
            notfound: Number of not mapped DOMelement.

 - getDisableId( elid )

     Arguments:
         elid: required

     Return:
         JSON:
            off: Number of disabled cell
            on: Number of enabled cell
            notfound: Number of not mapped DOMelement.

 - getDisplay()

     Arguments:
         No arguments required.

     Return:
         Boolean: The current display mode

 - getDisplayCell( dataid )

     Arguments:
         dataid: required.

     Return:
         JSON:
            off: Number of display: false
            on: Number of display: true

 - getDisplayId( elid )

     Arguments:
         elid: required.

     Return:
         JSON:
            off: Number of display: false
            on: Number of display: true

 - getElementById( dataid )

     Arguments:
         dataid: required.

     Return:
         Array: List of DOMelements

 - getHiddenCell( dataid )

     Arguments:
         dataid: required.

     Return:
         JSON:
            off: Number of hidden: true
            on: Number of hidden: false

 - getHiddenId( elid )

     Arguments:
         elid: required.

     Return:
         JSON:
            off: Number of hidden: true
            on: Number of hidden: false

 - getMenuId()

     Arguments:
         No arguments required.

     Return:
         Value: The menu-item-id, jMenu Initialization

 - getMenuIdByEL( elid )

     Arguments:
         elid: required.

     Return:
         Value: The menu-item-id, jMenu Initialization

 - getTableId()

     Arguments:
         No arguments required.

     Return:
         Value: The dynamic name table.id assigned
         (valid only linear and list menu type)

 - getBlinkerCell( dataid )

     Arguments:
         dataid: required.

     Return:
         JSON:
            off: Number of blinker: false
            on: Number of blinker: true
            notfound: Number of cell without blinker setting

 - getSharedMemory( sharedkey )

     Arguments:
         sharedkey: required.

     Return:
         JSON: Shared Area Values

 - getSync()

     Arguments:
         No arguments required.

     Return:
         Boolen: The current sync mode

 - getVersion()

     Arguments:
         No arguments required.

     Return:
         Value: The current version

 - refresh()

     Arguments:
         no arguments

     Return:
         Boolean: True done, false ignored.

 - refreshCell( dataid )

     Arguments:
         dataid: required.

     Return:
         JSON:
            changed: Number of Cells.

 - refreshEL( elid )

     Arguments:
         elid: required.

     Return:
         JSON:
            changed: Number of Cells.

 - setAttribute( { attribrutesList }, refresh )

     Arguments:
         attributeList: required.
         refresh: true force update Cell, false ignore update cell, defaults: false

     Return:
         JSON:
            added: Number of new itens
            changed: Number of changes
            refresh: true done, false ignored

 - setAttributeCell( dataid, {atributesList}, refresh )

     Arguments:
         dataid: required.
         attributeList: required.
         refresh: not required, defaults: false

     Return:
         JSON:
            added: Number of new itens
            changed: Number of changes
            refresh: see: refreshCell return value

 - setAttributeId( elid, {atributesList}, refresh )

     Arguments:
         elid: required.
         attributeList: required.
         refresh: not required, defaults: false

     Return:
         JSON:
            added: Number of new itens
            changed: Number of changes
            refresh: see: refreshCell return value

 - setBlinker( state )

     Arguments:
         state: required

     Return:
         Boolean: The current blinker mode

 - setBlinkerCell( dataid, state )

     Arguments:
         dataid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setBlinkerId( elid, state )

     Arguments:
         elid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setDisableCell( dataid, state )

     Arguments:
         dataid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setDisableId( elid, state )

     Arguments:
         elid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setDisplay( state )

     Arguments:
         No arguments required.

     Return:
         Boolean: The current display mode

 - setDisplayCell( dataid, state )

     Arguments:
         dataid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setDisplayId( elid, state )

     Arguments:
         elid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setHiddenCell( dataid, state )

     Arguments:
         dataid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setHiddenId( elid, state )

     Arguments:
         elid: required.
         state: required.

     Return:
         JSON:
            already: Number of no changes done
            changed: Number of changes
            state: The current state changed

 - setSharedMemory( sharedkey, sharedvalue )

     Arguments:
         sharedkey: required.
         sharedvalue: required.

     Return:
         no return data

 - setSync( state )

     Arguments:
         state: required.

     Return:
         Boolean: The current sync mode

ENDED