Class ecm.widget.admin.model._AdminObjectBase


Extends ecm.model._ModelObject.
Base class for all administrative objects
Defined in: <ecm\widget\admin\model\_AdminObjectBase.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
ecm.widget.admin.model._AdminObjectBase()
Fields borrowed from class ecm.model._ModelObject:
categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes Method Name and Description
 
addChild(childObj, isReload)
To add a child node and setup its parent and treeModel automatically
 
closeWidgetInTab(widget)
Send a message to _AdminPaneBase.js to close a widget in the Admin Tabs
 
constructor()
After the constructor is called, setId(id), setName(name) and initialize() should be called to initialize the object
 
getActionLabel(actionID)
To be overwritten to return translated label for an action ID to be displayed on the context menu
 
getChildren(onComplete)
To be overwritten if the children is going to be lazy loaded
 
getIconClass(opened)
To be overwritten to return the class name for the Icon
 
getIdentity()
Returns the identifier for this item
 
getLabel()
To be overwritten to return the label to be displayed on the tree
 
getMenuActions()
To be overwritten to return a list of context menu action IDs
 
getParent()
 
getTreeModel()
 
initialize()
To be overwritten to do all necessary initialization needed by the subclass
 
mayHaveChildren()
To be overwritten to returns true if the item my have children.
 
onClick()
To be overwritten to process the object being clicked on the tree
 
openWidgetInTab(widget)
Send a message to _AdminPaneBase.js to open a widget in the Admin Tabs
 
processAction(actionID)
To be overwritten to process the actionID being invoked from the context menu
 
removeChild(childObj)
To remove a child node
 
setParent(parentObj)
 
setTreeModel(treeModel)
Methods borrowed from class ecm.model._ModelObject:
destroy, onChange, own, refresh, toString

Constructor Detail

ecm.widget.admin.model._AdminObjectBase()

Method Detail

addChild(childObj, isReload)

To add a child node and setup its parent and treeModel automatically
Parameters:
childObj
isReload

closeWidgetInTab(widget)

Send a message to _AdminPaneBase.js to close a widget in the Admin Tabs
Parameters:
widget

constructor()

After the constructor is called, setId(id), setName(name) and initialize() should be called to initialize the object

getActionLabel(actionID)

To be overwritten to return translated label for an action ID to be displayed on the context menu
Parameters:
actionID

getChildren(onComplete)

To be overwritten if the children is going to be lazy loaded
Parameters:
onComplete

getIconClass(opened)

To be overwritten to return the class name for the Icon
Parameters:
opened

getIdentity()

Returns the identifier for this item

getLabel()

To be overwritten to return the label to be displayed on the tree

getMenuActions()

To be overwritten to return a list of context menu action IDs

getParent()

getTreeModel()

initialize()

To be overwritten to do all necessary initialization needed by the subclass

mayHaveChildren()

To be overwritten to returns true if the item my have children.

onClick()

To be overwritten to process the object being clicked on the tree

openWidgetInTab(widget)

Send a message to _AdminPaneBase.js to open a widget in the Admin Tabs
Parameters:
widget

processAction(actionID)

To be overwritten to process the actionID being invoked from the context menu
Parameters:
actionID

removeChild(childObj)

To remove a child node
Parameters:
childObj

setParent(parentObj)

Parameters:
parentObj

setTreeModel(treeModel)

Parameters:
treeModel