Class Index | File Index

Classes


Class baja.Slot


Extends BaseBajaObj.
Slot

A Niagara Complex is made up of Slots. A Slot can be a Property, Action or a Topic. This is the base class for all Slots in BajaScript.

A new object should never be directly created with this Constructor.
Defined in: comp.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
baja.Slot(slotName, displayName)
Method Summary
Method Attributes Method Name and Description
<private>  
Return the display name of the Slot.
<private>  
$setDisplayName(displayName)
Set the display name of the Slot.
 
Return the name of the Slot.
 
Is the Slot an Action?
 
Is the Slot frozen?
 
Is the Slot a Property?
 
Is the Slot a Topic?
 
Return a String representation of the Slot.
Methods borrowed from class BaseBajaObj:
equals, valueOf
Class Detail
baja.Slot(slotName, displayName)
Parameters:
{String} slotName
the name of the Slot.
{String} displayName
the display name of the Slot.
Method Detail
<private> {String} $getDisplayName()
Return the display name of the Slot.

Please note, this method is intended for INTERNAL use by Tridium only. An external developer should never call this method.

Returns:
{String}

<private> $setDisplayName(displayName)
Set the display name of the Slot.

Please note, this method is intended for INTERNAL use by Tridium only. An external developer should never call this method.

Parameters:
{String} displayName

{String} getName()
Return the name of the Slot.
Returns:
{String}

{Boolean} isAction()
Is the Slot an Action?
Returns:
{Boolean}

{Boolean} isFrozen()
Is the Slot frozen?
Returns:
{Boolean}

{Boolean} isProperty()
Is the Slot a Property?
Returns:
{Boolean}

{Boolean} isTopic()
Is the Slot a Topic?
Returns:
{Boolean}

{String} toString()
Return a String representation of the Slot.
Returns:
{String}

Documentation generated by JsDoc Toolkit 2.3.2