Class Index | File Index

Classes


Namespace baja.nav

Nav Root
Defined in: nav.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
baja.nav.attach(event, the)
Attach an event handler to listen for navigation events.
<static>  
baja.nav.detach(hName, func)
Detach an Event Handler.
<static>  
baja.nav.getHandlers(hName)
Return an array of event handlers.
<static>  
baja.nav.hasHandlers(hName)
Return true if there any handlers registered for the given handler name.
Namespace Detail
baja.nav
Method Detail
<static> baja.nav.attach(event, the)
Attach an event handler to listen for navigation events.

Please note, navigation events only cover 'add', 'remove', 'renamed' and 'reordered'.

For a list of all the event handlers and some of this method's more advanced features, please see baja.Subscriber#attach.

Parameters:
{String} event
handler name.
{Function} the
event handler function.
See:
baja.Subscriber
baja.nav.detach
baja.nav.getHandlers
baja.nav.hasHandlers

<static> baja.nav.detach(hName, func)
Detach an Event Handler.

If no arguments are used with this method then all events are removed.

For some of this method's more advanced features, please see baja.Subscriber#detach.

Parameters:
{String} hName Optional
the name of the handler to detach.
{Function} func Optional
the function to remove. It's recommended to supply this just in case other scripts have added event handlers.
See:
baja.Subscriber
baja.nav.attach
baja.nav.getHandlers
baja.nav.hasHandlers

<static> {Array} baja.nav.getHandlers(hName)
Return an array of event handlers.

To access multiple handlers, insert a space between the handler names.

Parameters:
{String} hName
the name of the handler
Returns:
{Array}
See:
baja.Subscriber
baja.nav.detach
baja.nav.attach
baja.nav.hasHandlers

<static> {Boolean} baja.nav.hasHandlers(hName)
Return true if there any handlers registered for the given handler name.

If no handler name is specified then test to see if there are any handlers registered at all.

Multiple handlers can be tested for by using a space character between the names.

Parameters:
{String} hName Optional
the name of the handler. If undefined, then see if there are any handlers registered at all.
Returns:
{Boolean}
See:
baja.Subscriber
baja.Component#detach
baja.Component#attach
baja.Component#getHandlers

Documentation generated by JsDoc Toolkit 2.3.2