{{! For backwards compatibility }}

<%=this.name%>

<%=crossLink(this.type)%> <% if (HAS(this.deprecated)) { %> title="<%=this.deprecationMessage%>"<% } %>>deprecated <% } %> <% if (HAS(this.access)) { %> <%=this.access%> <% } %> <% if (HAS(this.final)) { %> final <% } %> <% if (HAS(this.static)) { %> static <% } %> <% if (HAS(this.optional)) { %> optional <% } %> <% if (HAS(this.required)) { %> required <% } %>
<% if (HAS(this.overwritten_from)) { %>

Inherited from <%=this.overwritten_from.class%> <% if (HAS(this.foundAt)) { %> but overwritten in <% } %> <% } else { %> <% if (HAS(this.extended_from)) { %>

Inherited from <%=this.extended_from%>: <% } else { %> <% EACH(this.providedBy, function() { %>

Provided by the <%=this%> module.

<% }); %>

<% if (HAS(this.foundAt)) { %> Defined in <% } %> <% } %> <% } %> <% if (HAS(this.foundAt)) { %> `<%=this.file%>:<%=this.line%>` <% } %>

<% if (HAS(this.deprecationMessage)) { %>

Deprecated: <%=this.deprecationMessage%>

<% } %> <% if (HAS(this.since)) { %>

Available since <%=this.since%>

<% } %>
<%=this.attrDescription%>
<% if (HAS(this.default)) { %>

Default: <%=this.default%>

<% } %> <% if (HAS(this.emit)) { %>

Fires event <%=this.name%>Change

Fires when the value for the configuration attribute `<%=this.name%>` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e <%=crossLink("EventFacade")%>
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName <%=crossLink("String")%>
      The name of the attribute being set.
    • subAttrName <%=crossLink("String")%>
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
<% } %> <% EACH(this.example, function() { %>

Example:

<%=this%>
<% }); %>