Layout Controls
The Layout Controls subcomponent is used by UI Options to manage the controls for customizing the layout of the page. The options described on this page can be configured through the options of the main UI Options components. Three version of UI Options are available:
Do not use this component directly. The information on this page should be use when customizing one of the three versions.
See Also
Links Controls
Text Controls
Full Page UI Options
Full Page UI Options (with Preview)
Fat Panel UI Options
|
|
|
|
|
Supported Events
Listeners can be attached to any supported events through a component's listeners option. Values can be a function reference (not a string function name) or an anonymous function definition, as illustrated below:
var myComponent = component.name("#myContainerID", {
listeners: {
eventName1: functionName,
eventName2: function (params) {
...
}
}
});
For information on the different types of events, see Infusion Event System.
The following events are supported by the Layout Controls subcomponent:
onUIOptionsRefresh
Description |
This event fires any time the layout settings are saved or reset, or when the user cancels their changes to the interface. |
|---|---|
Type |
default |
Parameters |
none |
Availability |
Infusion 1.4 and later |
Options
Configurable subcomponents can be configured though the parent component's options by passing a JavaScript object containing options for the subcomponent:
parent.component.name(".myContainer", {
<subcomponentName>: {
options: {
<subcomponent options>
}
}
});
The following options are supported by the Layout Controls subcomponent:
Selectors
Description |
... See below. |
|---|
Selectors
One of the options that can be provided to the component is a set of CSS-based selectors identifying where in the DOM different elements can be found. The value for the option is itself a Javascript object containing name/value pairs:
selectors: {
selector1Name: "selector 1 string",
selector2Name: "selector 2 string",
...
}
The component defines defaults for these selectors: If you use those defaults in your markup, you do not need to specify the selectors option. If you do choose to override any of the selectors, you can specify your custom selector using this option.
The following selectors are supported by the Layout Controls subcomponent:
toc
Description |
Container for the control to request a table of contents (by default, a checkbox). |
|---|---|
Default |
".flc-uiOptions-toc" |
Example |
selectors: {
toc: "#toc"
}
|