A type alias for a split layout alignment. A type alias for a accordion layout alignment.
A type alias for a split layout orientation. A type alias for a accordion layout orientation.
Construct a new accordion layout.
The options for initializing the layout.
The default orientation will be vertical.
Titles must be rotated for horizontal accordion panel using CSS: see accordionpanel.css
The renderer used by the accordion layout.
Get the content alignment for the split layout.
This is the alignment of the widgets in the layout direction.
The alignment has no effect if the widgets can expand to fill the entire split layout.
Set the content alignment for the split layout.
This is the alignment of the widgets in the layout direction.
The alignment has no effect if the widgets can expand to fill the entire split layout.
Get the fit policy for the layout.
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.
Some layout implementations may ignore the fit policy.
Set the fit policy for the layout.
The fit policy controls the computed size constraints which are applied to the parent widget by the layout.
Some layout implementations may ignore the fit policy.
Changing the fit policy will clear the current size constraint for the parent widget and then re-fit the parent.
A read-only array of the split handles in the layout.
Test whether the layout is disposed.
Get the layout orientation for the split layout.
Set the layout orientation for the split layout.
Get the parent widget of the layout.
This is set automatically when installing the layout on the parent widget. The parent widget should not be set directly by user code.
Set the parent widget of the layout.
This is set automatically when installing the layout on the parent widget. The parent widget should not be set directly by user code.
Get the inter-element spacing for the split layout.
Set the inter-element spacing for the split layout.
The section title height or width depending on the orientation.
The section title height or width depending on the orientation.
A read-only array of the section titles in the panel.
A read-only array of the widgets in the layout.
Get the absolute sizes of the widgets in the layout.
A new array of the absolute sizes of the widgets.
This method does not measure the DOM nodes.
Attach a widget to the parent's DOM node.
The current index of the widget in the layout.
The widget to attach to the parent.
Detach a widget from the parent's DOM node.
The previous index of the widget in the layout.
Dispose of the resources held by the layout.
Perform layout initialization which requires the parent widget.
Insert a widget into the layout at the specified index.
The index at which to insert the widget.
The widget to insert into the layout.
The index will be clamped to the bounds of the widgets.
If the widget is already added to the layout, it will be moved.
An index which is non-integral.
Create an iterator over the widgets in the layout.
A new iterator over the widgets in the layout.
Move the offset position of a split handle.
The index of the handle of the interest.
The desired offset position of the handle.
The position is relative to the offset parent.
This will move the handle as close as possible to the desired position. The sibling widgets will be adjusted as necessary.
Move a widget in the parent's DOM node.
The previous index of the widget in the layout.
The current index of the widget in the layout.
The widget to move in the parent.
A message handler invoked on an 'after-attach' message.
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on an 'after-detach' message.
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on an 'after-hide' message.
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on an 'after-show' message.
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on a 'before-attach' message.
A message handler invoked on a 'before-detach' message.
The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on a 'before-hide' message.
The default implementation of this method forwards the message to all non-hidden widgets. It assumes all widget nodes are attached to the parent widget node.
This may be reimplemented by subclasses as needed.
A message handler invoked on a 'before-show' message.
A message handler invoked on a 'child-hidden' message.
A message handler invoked on a 'child-removed' message.
This will remove the child widget from the layout.
Subclasses should not typically reimplement this method.
A message handler invoked on a 'child-shown' message.
A message handler invoked on a 'fit-request' message.
A message handler invoked on a 'resize' message.
A message handler invoked on an 'update-request' message.
Process a message sent to the parent widget.
The message sent to the parent widget.
This method is called by the parent widget to process a message.
Subclasses may reimplement this method as needed.
Get the relative sizes of the widgets in the layout.
A new array of the relative sizes of the widgets.
The returned sizes reflect the sizes of the widgets normalized relative to their siblings.
This method does not measure the DOM nodes.
Remove a widget from the layout.
The widget to remove from the layout.
A widget is automatically removed from the layout when its parent
is set to null. This method should only be invoked directly when
removing a widget from a layout which has yet to be installed on a
parent widget.
This method does not modify the widget's parent.
Remove the widget at a given index from the layout.
The index of the widget to remove.
A widget is automatically removed from the layout when its parent
is set to null. This method should only be invoked directly when
removing a widget from a layout which has yet to be installed on a
parent widget.
This method does not modify the widget's parent.
An index which is non-integral.
Set the relative sizes for the widgets in the layout.
The relative sizes for the widgets in the panel.
Update the layout after setting relative sizes. Default is True.
Extra values are ignored, too few will yield an undefined layout.
The actual geometry of the DOM nodes is updated asynchronously.
Update the item position.
Item index
Whether the layout is horizontal or not
Left position in pixels
Top position in pixels
Item height
Item width
Item size
Get the split layout stretch factor for the given widget.
The widget of interest.
The split layout stretch factor for the widget.
Set the split layout stretch factor for the given widget.
The widget of interest.
The value for the stretch factor.
Generated using TypeDoc
A layout which arranges its widgets into collapsible resizable sections.