Subversion Repositories public iLand

<div id="attr_{{name}}" class="attr item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">

    <a name="config_{{name}}"></a> {{! For backwards compatibility }}

    <h3 class="name"><code>{{name}}</code></h3>

    <span class="type">{{#crossLink type}}{{/crossLink}}</span>

    {{#if deprecated}}

        <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>

    {{/if}}

    {{#if access}}

        <span class="flag {{access}}">{{access}}</span>

    {{/if}}

    {{#if final}}

        <span class="flag final">final</span>

    {{/if}}

    {{#if static}}

        <span class="flag static">static</span>

    {{/if}}

    {{#if optional}}

        <span class="flag optional">optional</span>

    {{/if}}

    {{#if required}}

        <span class="flag required">required</span>

    {{/if}}

    {{#if readonly}}

        <span class="flag readonly">readonly</span>

    {{/if}}

    <div class="meta">

        {{#if overwritten_from}}

            <p>Inherited from

            <a href="{{crossLinkRaw overwritten_from/class}}#attr_{{overwritten_from/name}}">

                {{overwritten_from/class}}

            </a>

            {{#if foundAt}}

            but overwritten in

            {{/if}}

        {{else}}

            {{#if extended_from}}

                <p>Inherited from

                <a href="{{crossLinkRaw extended_from}}#attr_{{name}}">{{extended_from}}</a>:

            {{else}}

                {{#providedBy}}

                    <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>

                {{/providedBy}}

                <p>

                {{#if foundAt}}

                Defined in

                {{/if}}

            {{/if}}

        {{/if}}

        {{#if foundAt}}

        <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>

        {{/if}}

        </p>

        {{#if deprecationMessage}}

            <p>Deprecated: {{deprecationMessage}}</p>

        {{/if}}

        {{#if since}}

            <p>Available since {{since}}</p>

        {{/if}}

    </div>

    <div class="description">

        {{{attrDescription}}}

    </div>

    {{#if default}}

        <p><strong>Default:</strong> {{default}}</p>

    {{/if}}

    {{#if emit}}

        <div class="emits box">

            <h4>Fires event <code>{{name}}Change</code></h4>

            <p>

            Fires when the value for the configuration attribute `{{{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.

            </p>

            <div class="params">

                <h4>Parameters:</h4>

                <ul class="params-list">

                    <li class="param">

                        <code class="param-name">e</code>

                        <span class="type">{{#crossLink "EventFacade"}}{{/crossLink}}</span>

                        <div class="param-description">

                            An Event Facade object with the following

                            attribute-specific properties added:

                        </div>

                        <ul class="params-list">

                            <li class="param">

                                <code class="param-name">prevVal</code>

                                <span class="type">Any</span>

                                <div class="param-description">The value of the attribute, prior to it being set.</div>

                            </li>

                            <li class="param">

                                <code class="param-name">newVal</code>

                                <span class="type">Any</span>

                                <div class="param-description">The value the attribute is to be set to.</div>

                            </li>

                            <li class="param">

                                <code class="param-name">attrName</code>

                                <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>

                                <div class="param-description">The name of the attribute being set.</div>

                            </li>

                            <li class="param">

                                <code class="param-name">subAttrName</code>

                                <span class="type">{{#crossLink "String"}}{{/crossLink}}</span>

                                <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

                            </li>

                        </ul>

                    </li>

                </ul>

            </div>

        </div>

    {{/if}}

    {{#example}}

        <div class="example">

            <h4>Example:</h4>

            <div class="example-content">

                {{{.}}}

            </div>

        </div>

    {{/example}}

</div>