Canvas Toolkit
← Class index

CBoxLayout

Layouts · extends CLayout

Layout that arranges widgets and stretches in a single row or column.

Module layouts/CBoxLayout.js. This class is available through the browser modules in the download.

Declared members

constructor(direction: CBoxLayoutDirection);

Creates a box layout using the specified direction.

direction(): CBoxLayoutDirection;

Returns the layout direction.

addWidget(widget: CWidget, stretch?: number, alignment?: CAlignment | 0): void;

Adds a widget with an optional stretch factor.

addSpacerItem(spacer: CSpacerItem): void;

Adds empty space with its own preferred size and axis policies.

addSpacing(size: number): void;

Adds a fixed gap along this box's direction.

addLayout(layout: CLayout, stretch?: number, alignment?: CAlignment | 0): void;

Adds all widgets from another layout with an optional stretch factor.

sizeHint(): CSize;

Returns the preferred size required by the arranged items.

heightForWidth(width: number): number;
update(): void;

Recalculates and applies item geometries.