A5.PanelLayoutPanel Object
Description
Definition of a panel in the panel layout.
Properties
- srcA5.PanelCardA5.PanelNavigatorA5.PanelLayout
The panel class.
- namestring
The name of the panel. Used to access the panel in the layout, such as when calling the A5.PanelLayout.setActivePanel method.
- titlestring
The title (display friendly HTML) of the panel.
- showboolean
Whether or not to show the panel in the layout. The default value is true.
- sizestring
The size (width if the flow is horizontal and height if the flow is vertical) of the panel in the layout. Values can be in CSS units (for example "250px", or "3in"), use a flex syntax (for example "flex(1)" and "flex(2)" - if a layout had two panels in it with each of these values then one panel would be 1/3 the width and the other 2/3), or use a percentage of the available space (for example "50%"). The default is "flex(1)".
- minSizestring
The minimum size (width if the flow is horizontal and height if the flow is vertical) of the panel in the layout. Values must be in absolute CSS units (for example "250px", or "3in").
- dockstring
The dock behavior for the panel. Values can be "none", "collapse-before", "collapse-after", "auto-collapse-before" and "auto-collapse-after". The collapse before/after will always dock the panel while the auto collapse will only dock the panel if there is not enough room to layout all the panels.
- controlsobject
Layout control bindings.
- prevobject
A previous panel button.
- hasboolean
Whether or not the panel has a previous panel button. The default value is false.
- idstring
The ID of the button element (which must already be in the DOM). The default is "{panel.id}.CTRL.PREV".
- settingsobject
The button settings.
- nextobject
A next panel button.
- hasboolean
Whether or not the panel has a next panel button. The default value is false.
- idstring
The ID of the button element (which must already be in the DOM). The default is "{panel.id}.CTRL.NEXT".
- settingsobject
The button settings.
- flowCollapseobject
A collapse flow button to toggle the visibility of all panels before the current panel in the flow.
- hasboolean
Whether or not the panel has a collapse flow button. The default value is false.
- idstring
The ID of the button element (which must already be in the DOM). The default is "{panel.id}.CTRL.FLOWCOLLAPSE".
- settingsobject
The button settings.
- statesobject
Settings for the each state
- collapseobject
Settings for the collapse state.
- htmlstring
The HTML to put in the button when it will collapse the flow. The default is "«".
- expandobject
Settings for the expand state.
- htmlstring
The HTML to put in the button when it will expand the flow. The default is "»".
- isDockedboolean
Whether or not the panel is docked. The default value is false.