Class: grouptree

grouptree

new grouptree() → {object}

GROUP TREE
Source:
Returns:
The group tree
Type
object

Methods

buildTree(currentElement, currentDepth) → {object}

Creates the subtree starting with the currentElement and depth
Parameters:
Name Type Description
currentElement object the element to start with
currentDepth number the current menu depth
Source:
Returns:
the subtree structure
Type
object

checkClick(event)

Wrapper to debounce the double click event
Parameters:
Name Type Description
event object the event
Source:

drag(event) → {boolean}

Drag-Function of the grouptree divider
Parameters:
Name Type Description
event object the event object
Source:
Returns:
this is always fals to prevent further actions
Type
boolean

dragStart(event) → {boolean}

DragStart of the grouptree divider to add document event listener
Parameters:
Name Type Description
event object the event object
Source:
Returns:
this is always fals to prevent further actions
Type
boolean

dragStop(event) → {boolean}

DragStop of the grouptree divider to remove previously added document event listener
Parameters:
Name Type Description
event object the event object
Source:
Returns:
this is always fals to prevent further actions
Type
boolean

getCurrentOpenTreeStructure(currentNodeopt) → {object}

Recuse the grouptreedata and generate a shadow with the 'open' state of the nodes.
Parameters:
Name Type Attributes Default Description
currentNode object <optional>
 getPageCount.DATA.grouptreeData the nodes to iterate over. Has to be groupTreeData from getPageCount
Source:
Returns:
List of open paths in the group tree denoted by the url
Type
object

highlightSelectedElement(element)

Highlight a given tree element
Parameters:
Name Type Description
element object the tree element to highlight
Source:

init() → {grouptree}

Initializes a newly created instance of the grouptree
Source:
Returns:
the grouptree object
Type
grouptree

jumpToSelectedGroupElement(groupSelf)

Jump to the given tree element
Parameters:
Name Type Description
groupSelf object the tree element
Source:

keyboardNavigation(keycode)

This is for keyboard input only and jumps into the direction on the tree
Parameters:
Name Type Description
keycode number that was entered
Source:

onClick(event)

The click handler which is debounced and will handle jumping to a page and highlighting a section
Parameters:
Name Type Description
event object the event
Source:

onDBLClick(event)

Execute double click action, that is: open the subreport
Parameters:
Name Type Description
event object the event
Source:

onTouchStart(event)

Touch Handler. Detects a single or a double tap touch
Parameters:
Name Type Description
event object the event
Source:

openCloseNode()

Open or close the the current node
Source:

openGroup(link, type) → {function}

Event Wrapper for each group tree node entry
Parameters:
Name Type Description
link object the link that is going to be opened
type string the type of event that we want
Source:
Returns:
the function that will be used for the type
Type
function

reset(fullopt)

Reset the grouptree so that it will be loaded again when requesting a new page
Parameters:
Name Type Attributes Default Description
full boolean <optional>
 true really load or just remove the tree from DOM
Source:

showTree(visible)

Show/hide the grouptree
Parameters:
Name Type Description
visible boolean show the group tree
Source:

sizeToFit(event) → {boolean}

Resize group tree to fit content. This is the double click handler for the devider bar
Parameters:
Name Type Description
event object the event object
Source:
Returns:
this is always fals to prevent further actions
Type
boolean

toggleTree()

Toggle open / close of the group tree Has to be called as event handler
Source: