Amiro.CMS JS API Reference (available from v5.12) Amiro.Ru / Manual

Class AMI

Base container of Amiro JS API classes.
Defined in: ami.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
AMI()
Base container of Amiro JS API classes.
Method Summary
Method Attributes Method Name and Description
<static>  
AMI.find(search, oParent)
Find element in DOM by id, class or tag.
<static>  
AMI.inherit(oChildClass, oParentClass)
Inherit one class from other and creating superclass definition in child.
<static>  
AMI.scrollTo(oElement, paddingLeftTop)
Animated scroll to any object on page.
Class Detail
AMI()
Base container of Amiro JS API classes.
Method Detail
<static> {mixed} AMI.find(search, oParent)
Find element in DOM by id, class or tag.
Parameters:
{string} search
Search string in format "#idOfElement" or ".classNameOfElement" or "tagName".
{DOM object} oParent
DOM element where target element will be searched.
Returns:
{mixed} Found element or null in case of search by ID, array of elements in other search cases.

<static> {void} AMI.inherit(oChildClass, oParentClass)
Inherit one class from other and creating superclass definition in child.
Example of inheriting classes:
parentClass = function(param1, param2){}
childClass = function(param1, param2){
    AMI.ModuleComponentCustom.superclass.constructor.call(this, param1, param2);
    // Child class methods further
}
AMI.inherit(childClass, parentClass);
Parameters:
{function} oChildClass
Class that should be inherited.
{function} oParentClass
Parent class object.
Returns:
{void}

<static> {void} AMI.scrollTo(oElement, paddingLeftTop)
Animated scroll to any object on page.
Parameters:
{DOM object} oElement
DOM element to scroll to.
{number} paddingLeftTop
Padding from left and top (equal) that shold be left after scrolling if possible.
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Apr 22 2011 12:43:56 GMT+0700 (NOVST)