@jimka/typescript-ui / layout / Row
Class: Row
Defined in: src/typescript/lib/layout/Row.ts:23
A layout manager that divides the container height equally among all children and places them top-to-bottom with a configurable gap.
Extends
Constructors
new Row()
new Row(options?: RowOptions): RowDefined in: src/typescript/lib/layout/Row.ts:27
Parameters
options?
Returns
Overrides
Methods
attach()
attach(container: Component): thisDefined in: src/typescript/lib/layout/LayoutManager.ts:58
Associates this layout manager with a container component.
Parameters
container
The container component to attach to.
Returns
this
Inherited from
delLayoutConstraints()
delLayoutConstraints(component: Component): undefined | LayoutConstraintsDefined in: src/typescript/lib/layout/LayoutManager.ts:276
Removes and returns the stored layout constraints for a component.
Parameters
component
The component whose constraints should be removed.
Returns
undefined | LayoutConstraints
The removed constraints, or undefined if none were stored.
Inherited from
LayoutManager.delLayoutConstraints
detach()
detach(): thisDefined in: src/typescript/lib/layout/LayoutManager.ts:67
Dissociates this layout manager from its container.
Returns
this
Inherited from
doLayout()
doLayout(): voidDefined in: src/typescript/lib/layout/Row.ts:194
Divides the container height equally among children and places them top-to-bottom with gaps.
Returns
void
Overrides
getClassName()
getClassName(): stringDefined in: src/typescript/lib/core/BaseObject.ts:44
Returns the runtime class name of this object.
Returns
string
The name of the constructor function as a string.
Inherited from
getContainer()
getContainer(): null | ComponentDefined in: src/typescript/lib/layout/LayoutManager.ts:78
Returns the container component this layout manager is attached to.
Returns
null | Component
The attached container, or null if not attached.
Inherited from
getGap()
getGap(): numberDefined in: src/typescript/lib/layout/Row.ts:54
Returns the pixel gap between rows.
Returns
number
The current gap in pixels.
getId()
getId(): stringDefined in: src/typescript/lib/core/BaseObject.ts:24
Returns the unique identifier for this object.
Returns
string
The UUID string assigned at construction time.
Inherited from
getLayoutConstraints()
getLayoutConstraints(component: Component): undefined | LayoutConstraintsDefined in: src/typescript/lib/layout/LayoutManager.ts:291
Returns the stored layout constraints for a component.
Parameters
component
The component to look up.
Returns
undefined | LayoutConstraints
The stored constraints, or undefined if none are set.
Inherited from
LayoutManager.getLayoutConstraints
getMaxSize()
getMaxSize(): null | SizeDefined in: src/typescript/lib/layout/Row.ts:156
Computes the maximum size as the minimum child maximum dimensions stacked vertically with gaps.
Returns
null | Size
The maximum {width, height}, or null if no container is attached.
Overrides
getMinSize()
getMinSize(): null | SizeDefined in: src/typescript/lib/layout/Row.ts:116
Computes the minimum size as the maximum child minimum dimensions stacked vertically with gaps.
Returns
null | Size
The minimum {width, height}, or null if no container is attached.
Overrides
getPreferredSize()
getPreferredSize(): null | SizeDefined in: src/typescript/lib/layout/Row.ts:76
Computes the preferred size as the maximum child preferred dimensions stacked vertically with gaps.
Returns
null | Size
The preferred {width, height}, or null if no container is attached.
Overrides
LayoutManager.getPreferredSize
placeComponent()
placeComponent(
component: Component,
x: number,
y: number,
maxWidth: number,
maxHeight: number,
fill?: null | FillType,
anchor?: null | AnchorType): voidDefined in: src/typescript/lib/layout/LayoutManager.ts:126
Positions and sizes a child component within the given bounds, respecting fill and anchor constraints.
Parameters
component
The child component to position.
x
number
Left edge of the cell in the container's coordinate space.
y
number
Top edge of the cell in the container's coordinate space.
maxWidth
number
Available width for the component.
maxHeight
number
Available height for the component.
fill?
Optional. Fill strategy overriding the component's own constraints.
null | FillType
anchor?
Optional. Anchor point overriding the component's own constraints.
null | AnchorType
Returns
void
Remarks
The method checks the component's stored LayoutConstraints first; the fill and anchor parameters serve as fallbacks. After positioning, doLayout is called on the child so nested layouts are updated in a single pass.
Inherited from
setGap()
setGap(gap: number): thisDefined in: src/typescript/lib/layout/Row.ts:63
Sets the pixel gap between rows and triggers a re-layout.
Parameters
gap
number
Gap size in pixels.
Returns
this
setId()
setId(id: string): thisDefined in: src/typescript/lib/core/BaseObject.ts:33
Sets the unique identifier for this object.
Parameters
id
string
The new identifier string to assign.
Returns
this
Inherited from
setLayoutConstraints()
setLayoutConstraints(component: Component, constraints?: LayoutConstraints): undefined | LayoutConstraintsDefined in: src/typescript/lib/layout/LayoutManager.ts:260
Stores layout constraints for a component, or removes them if constraints is undefined.
Parameters
component
The component whose constraints are being set.
constraints?
Optional. The constraints to store; omit to delete existing constraints.
Returns
undefined | LayoutConstraints
The stored constraints, or undefined if they were deleted.