This documentation is currently being moved to our new documentation site.
Please view or edit the documentation there, instead.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.
Table of Contents Model Builder
The Model Builder subcomponent is used by Table of Contents API to convert a flat list of headings into a hierarchical list suitable for the Table of Contents.
Do not use this component directly. The information on this page should be use when customizing Table of Contents.
See Also
Table of Contents API
Table of Contents Heading Calculator
Supported Events | none |
---|---|
| |
Options | none |
|
Methods
This component has public methods that can be invoked by integrators as necessary. These methods are typcially implemented as Invokers, which resolve their arguments from the environment at invocation time. These methods can be configured by the integrator if necessary: arguments can be changed, and in fact the entire implementation function can be replaced by a custom function (though it is likely rare that this would be necessary or desirable).
Configuration of invokers should be carried by creating a grade, using the following pattern:
fluid.defaults("<new name of overriding grade>", { gradeNames: ["<name of grade being overridden", "autoInit"], Â invokers: { <invokerName>: { funcName: <implementation function name>, args: [<array of argument specifications>] } } });
Example of overriding an invoker
The Infusion Pager component has a method called {{acquireDefaultRange}} which, by default, simply returns the total range. An integrator may wish to override this using their own custom function:
fluid.defaults("my.pager", { gradeNames: ["fluid.pager", "autoInit"], Â invokers: { acquireDefaultRange: { funcName: "my.pager.acquireDefaultRange } } });
modelLevelFn
Description | Used by the |
---|---|
Parameters | modelLevel |
Configurable | yes |
Notes | The Model Builder also defines an alternative implementation: |
toModel
Description | Used by the Model Builder to convert a flat list of headings into a hierarchical list using modelLevelFn. |
---|---|
Parameters | headingInfo |
Configurable | yes |
See also |
Subcomponents
Subcomponents can be configured though the parent component's components
option using the following pattern:
parent.component.name(".myContainer", { components: { <subcomponentName>: { options: { <subcomponent options> } } } });
headingCalculator
Description | The |
---|---|
Default implementation |