Class actioncenter.standardNode

Extends Ext.tree.TreeNode.
The standard AC tree explorer node.
Defined in: CaceExplorer.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	actioncenter.standardNode(attributes) Default constructor.

Field Summary
Field Attributes	Field Name and Description
<static>	actioncenter.standardNode.actionCenterListener The listener registered on this node.
<static>	actioncenter.standardNode.allowDropOnlyValidChildTypes Only allow drops of valid child types.
<static>	actioncenter.standardNode.childNodesLength The expected number of child nodes.
<static>	actioncenter.standardNode.newNode The new node just added to this node when processCreateNewChild is called.
<static>	actioncenter.standardNode.nodeInProcessCreateChildContId The contribution id of the contribution contained in the callback message when processCreateNewChild is called.
<static>	actioncenter.standardNode.order The ordering of subordinates.
<static>	actioncenter.standardNode.validChildTypes The list of valid child types.

Method Summary
Method Attributes	Method Name and Description
<static>	actioncenter.standardNode.acceptMove(msg, node) Checks to see if this node is subscribed to this new channel and then accepts it as a child and sets it's properties.
<static>	actioncenter.standardNode.adjustViewport() Restores the viewport to the previous position.
<static>	actioncenter.standardNode.afterCreateChild(msg, newNode) Executes after the createChild function.
<static>	actioncenter.standardNode.afterDeleteChild() Executes after the deleteChild function.
<static>	actioncenter.standardNode.afterEditOrder(msg) Executes after the editOrder function.
<static>	actioncenter.standardNode.beforeCreateChild(msg) Executes before the createChild function.
<static>	actioncenter.standardNode.beforeDeleteChild() Executes before the deleteChild function.
<static>	actioncenter.standardNode.beforeEditOrder(msg) Executes before the editOrder function.
<static>	actioncenter.standardNode.captureViewport() Captures the current viewport in order to restore it after any operation that may change it.
<static>	actioncenter.standardNode.cleanUp() Cleans up by closing any open panels, un-subscribing from listening channels, and recursively invoking itself on the children nodes.
<static>	actioncenter.standardNode.collapse(deep, anim, callback, scope) Override Add the ability to disable this feature when needed by the disableCollapse property Collapse this node.
<static>	actioncenter.standardNode.createChild(msg) Creates a child node.
<static>	actioncenter.standardNode.deepCopyContribution(data, type) deepCopyContribution copy the whole node branch
<static>	actioncenter.standardNode.deleteChild(msg) Deletes the child node specified by the message.
<static>	actioncenter.standardNode.editIcon(msg) Edits this node's icon.
<static>	actioncenter.standardNode.editNode(msg) Edits the node.
<static>	actioncenter.standardNode.editOrder(msg) Edits the order of chidlren of this node.
<static>	actioncenter.standardNode.editText(msg) Edits this node's text.
<static>	actioncenter.standardNode.find(prop, value) Find a component under this container at any level by property
<static>	actioncenter.standardNode.findBy(fn, scope) Find a component under this container at any level by a custom function.
<static>	actioncenter.standardNode.findChild(attribute, value, deep) Finds the first child that has the attribute with the specified value.
<static>	actioncenter.standardNode.findChildBy(fn, scope, deep) Finds the first child by a custom function.
<static>	actioncenter.standardNode.findLastVisibleDescendant() Find the last visible node that is the descendant of this node
<static>	actioncenter.standardNode.getShallowSelection(shallowSelectionToken) Creates a
<static>	actioncenter.standardNode.handleMoveContribution(data, type) handleMoveContribution
<static>	actioncenter.standardNode.hasMatchingSubscription(msg) Checks to see if this node is subscribed to the channel specified by the message.
<static>	actioncenter.standardNode.isInView() check whether this node is in the viewport.
<static>	actioncenter.standardNode.isMove(msg) Checks to see if this is a move message and attemps to move it to the new location.
<static>	actioncenter.standardNode.moveContribution(nodes, type, siblingPosition) moveContribution
<static>	actioncenter.standardNode.onAppend(tree, parentNode, node, index) Handles append events.
<static>	actioncenter.standardNode.onBeforeappend(tree, parentNode, node, index) Handles beforeappend events.
<static>	actioncenter.standardNode.onBeforeinsert(tree, parentNode, node, referenceNode) Handles beforeinsert events.
<static>	actioncenter.standardNode.onBeforemove(tree, node, oldParent, newParent, index) Handles beforemove events.
<static>	actioncenter.standardNode.onBeforeremove(tree, parentNode, node) Handles beforeremove events.
<static>	actioncenter.standardNode.onExpand() Handles expand events.
<static>	actioncenter.standardNode.onInsert(tree, parentNode, node, referenceNode) Handles insert events.
<static>	actioncenter.standardNode.onMove(tree, node, oldParent, newParent, index) Handles move events.
<static>	actioncenter.standardNode.onRemove(tree, parentNode, node) Handles remove events.
<static>	actioncenter.standardNode.pasteToThisNode(position, relationshipType) Pastes to the selected node the nodes copied to the clipboard.
<static>	actioncenter.standardNode.processCreateChild(msg) Invokes beforeCreateChild, createChild and afterCreateChild functions.
<static>	actioncenter.standardNode.processDeleteChild(msg) Executes beforeDeleteChild, deleteChild and afterDeleteChild functions.
<static>	actioncenter.standardNode.processEditOrder(msg) Wrapper function that invokes beforeEditOrder, editOrder and afterEditOrder functions.
<static>	actioncenter.standardNode.render(bulkRender) Performs rendering.
<static>	actioncenter.standardNode.setAttributes(msg) Updates appropriate attributes for this contribution in its new location.
<static>	actioncenter.standardNode.shallowCopyContribution(data, type) shallowCopyContribution only copy the selected nodes, not including their descendants
<static>	actioncenter.standardNode.sortAfterLoad() Invokes the sorting after finishing the initial load.
<static>	actioncenter.standardNode.subscribeAllChannels(eagerSubscribe) Subscribes to listen to channels according to this node's configuration.
<static>	actioncenter.standardNode.unsubscribeAllChannels() Unsubscribes from all channels.

Class Detail

actioncenter.standardNode(attributes)

Default constructor.

Parameters:
attributes: the node attributes

Field Detail

<static> actioncenter.standardNode.actionCenterListener

The listener registered on this node.

Default Value:: null

<static> actioncenter.standardNode.allowDropOnlyValidChildTypes

Only allow drops of valid child types.

Default Value:: true

<static> actioncenter.standardNode.childNodesLength

The expected number of child nodes.

Default Value:: 0

<static> actioncenter.standardNode.newNode

The new node just added to this node when processCreateNewChild is called.

Default Value:: null

<static> actioncenter.standardNode.nodeInProcessCreateChildContId

The contribution id of the contribution contained in the callback message when processCreateNewChild is called.

Default Value:: null

<static> actioncenter.standardNode.order

The ordering of subordinates.

Default Value:: null

<static> actioncenter.standardNode.validChildTypes

The list of valid child types.

Default Value:: null

Method Detail

<static> actioncenter.standardNode.acceptMove(msg, node)

Checks to see if this node is subscribed to this new channel and then accepts it as a child and sets it's properties.

Parameters:
msg: the message
node: the node to move

Returns:: true if the node is successfully moved

<static> actioncenter.standardNode.adjustViewport()

Restores the viewport to the previous position.

Returns:: void

<static> actioncenter.standardNode.afterCreateChild(msg, newNode)

Executes after the createChild function.

Parameters:
msg: the message
newNode

Returns:: void

<static> actioncenter.standardNode.afterDeleteChild()

Executes after the deleteChild function.

Returns:: void

<static> actioncenter.standardNode.afterEditOrder(msg)

Executes after the editOrder function.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.beforeCreateChild(msg)

Executes before the createChild function.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.beforeDeleteChild()

Executes before the deleteChild function.

Returns:: void

<static> actioncenter.standardNode.beforeEditOrder(msg)

Executes before the editOrder function.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.captureViewport()

Captures the current viewport in order to restore it after any operation that may change it.

Returns:: void

<static> actioncenter.standardNode.cleanUp()

Cleans up by closing any open panels, un-subscribing from listening channels, and recursively invoking itself on the children nodes.

Returns:: void

<static> actioncenter.standardNode.collapse(deep, anim, callback, scope)

Override Add the ability to disable this feature when needed by the disableCollapse property Collapse this node.

Parameters:
{Boolean} deep: (optional) True to collapse all children as well
{Boolean} anim: (optional) false to cancel the default animation
{Function} callback: (optional) A callback to be called when expanding this node completes (does not wait for deep expand to complete). Called with 1 parameter, this node.
{Object} scope: (optional) The scope (this reference) in which the callback is executed. Defaults to this TreeNode.

<static> actioncenter.standardNode.createChild(msg)

Creates a child node.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.deepCopyContribution(data, type)

deepCopyContribution copy the whole node branch

Parameters:
data: include the nodes to be copied to this node and the siblingPosition which is the position of the moved nodes in relation with this target node, can be "previous" or "next"
type: the contribution type of the copied nodes

Returns:: void

<static> actioncenter.standardNode.deleteChild(msg)

Deletes the child node specified by the message.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.editIcon(msg)

Edits this node's icon.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.editNode(msg)

Edits the node.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.editOrder(msg)

Edits the order of chidlren of this node.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.editText(msg)

Edits this node's text.

Parameters:
msg: the message

Returns:: void

<static> {Array} actioncenter.standardNode.find(prop, value)

Find a component under this container at any level by property

Parameters:
{String} prop
{String} value

Returns:: {Array} Array of Ext.Components

<static> {Array} actioncenter.standardNode.findBy(fn, scope)

Find a component under this container at any level by a custom function. If the passed function returns true, the component will be included in the results. The passed function is called with the arguments (component, this container).

Parameters:
{Function} fn: The function to call
{Object} scope: (optional)

Returns:: {Array} Array of Ext.Components

<static> {Node} actioncenter.standardNode.findChild(attribute, value, deep)

Finds the first child that has the attribute with the specified value.

Parameters:
{String} attribute: The attribute name
{Mixed} value: The value to search for
{Boolean} deep: (Optional) True to search through nodes deeper than the immediate children

Returns:: {Node} The found child or null if none was found

<static> {Node} actioncenter.standardNode.findChildBy(fn, scope, deep)

Finds the first child by a custom function. The child matches if the function passed returns true.

Parameters:
{Function} fn: A function which must return true if the passed Node is the required Node.
{Object} scope: (optional) The scope (this reference) in which the function is executed. Defaults to the Node being tested.
{Boolean} deep: (Optional) True to search through nodes deeper than the immediate children

Returns:: {Node} The found child or null if none was found

<static> actioncenter.standardNode.findLastVisibleDescendant()

Find the last visible node that is the descendant of this node

Returns:: tree node

<static> actioncenter.standardNode.getShallowSelection(shallowSelectionToken)

Creates a

Parameters:
shallowSelectionToken

<static> actioncenter.standardNode.handleMoveContribution(data, type)

handleMoveContribution

Parameters:
data: the object that contains the data to be moved and the type of move
type: the contribution type of the moved nodes

Returns:: void

<static> actioncenter.standardNode.hasMatchingSubscription(msg)

Checks to see if this node is subscribed to the channel specified by the message.

Parameters:
msg: the relationship message

Returns:: true if there is a matching subscription

<static> actioncenter.standardNode.isInView()

check whether this node is in the viewport.

Returns:: boolean

<static> actioncenter.standardNode.isMove(msg)

Checks to see if this is a move message and attemps to move it to the new location. Returns true if the node is successfully moved.

Parameters:
msg: the message

Returns:: true if the node is successfully moved

<static> actioncenter.standardNode.moveContribution(nodes, type, siblingPosition)

moveContribution

Parameters:
nodes: the nodes to be moved to this node
type: the contribution type of the moved nodes
siblingPosition: the position of the moved nodes in relation with this target node, can be "previous" or "next" *

Returns:: void

<static> actioncenter.standardNode.onAppend(tree, parentNode, node, index)

Handles append events.

Parameters:
tree: the tree
parentNode: the parent node
node: the node
index: the index

Returns:: true

<static> actioncenter.standardNode.onBeforeappend(tree, parentNode, node, index)

Handles beforeappend events.

Parameters:
tree: the tree
parentNode: the parent node
node: the node
index: the index

Returns:: true

<static> actioncenter.standardNode.onBeforeinsert(tree, parentNode, node, referenceNode)

Handles beforeinsert events.

Parameters:
tree: the tree
parentNode: the parent node
node: the node
referenceNode: the reference node

Returns:: true

<static> actioncenter.standardNode.onBeforemove(tree, node, oldParent, newParent, index)

Handles beforemove events.

Parameters:
tree: the tree
node: the node
oldParent: the old parent node
newParent: the new parent node
index: the index

Returns:: true

<static> actioncenter.standardNode.onBeforeremove(tree, parentNode, node)

Handles beforeremove events.

Parameters:
tree: the tree
parentNode: the parent node
node: the node

Returns:: true

<static> actioncenter.standardNode.onExpand()

Handles expand events.

Returns:: void

<static> actioncenter.standardNode.onInsert(tree, parentNode, node, referenceNode)

Handles insert events.

Parameters:
tree: the tree
parentNode: the parent node
node: the node
referenceNode: the reference node

Returns:: true

<static> actioncenter.standardNode.onMove(tree, node, oldParent, newParent, index)

Handles move events.

Parameters:
tree: the tree
node: the node
oldParent: the old parent node
newParent: the new parent node
index: the index

Returns:: true

<static> actioncenter.standardNode.onRemove(tree, parentNode, node)

Handles remove events.

Parameters:
tree: the tree
parentNode: the parent node
node: the node

Returns:: true

<static> actioncenter.standardNode.pasteToThisNode(position, relationshipType)

Pastes to the selected node the nodes copied to the clipboard.

Parameters:
position
relationshipType

Returns:: void

<static> actioncenter.standardNode.processCreateChild(msg)

Invokes beforeCreateChild, createChild and afterCreateChild functions.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.processDeleteChild(msg)

Executes beforeDeleteChild, deleteChild and afterDeleteChild functions.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.processEditOrder(msg)

Wrapper function that invokes beforeEditOrder, editOrder and afterEditOrder functions.

Parameters:
msg: the message

Returns:: void

<static> actioncenter.standardNode.render(bulkRender)

Performs rendering.

Parameters:
bulkRender: indicates if this is a bulk-render call

Returns:: void

<static> actioncenter.standardNode.setAttributes(msg)

Updates appropriate attributes for this contribution in its new location.

Parameters:
msg: the contribution message

Returns:: void

<static> actioncenter.standardNode.shallowCopyContribution(data, type)

shallowCopyContribution only copy the selected nodes, not including their descendants

Parameters:
data: include the nodes to be copied to this node and the siblingPosition which is the position of the moved nodes in relation with this target node, can be "previous" or "next"
type: the contribution type of the copied nodes

Returns:: void

<static> actioncenter.standardNode.sortAfterLoad()

Invokes the sorting after finishing the initial load.

Returns:: void

<static> actioncenter.standardNode.subscribeAllChannels(eagerSubscribe)

Subscribes to listen to channels according to this node's configuration.

Parameters:
eagerSubscribe

Returns:: void

<static> actioncenter.standardNode.unsubscribeAllChannels()

Unsubscribes from all channels.

Returns:: void

Classes

Class actioncenter.standardNode