@jimka/typescript-ui

Appearance

@jimka/typescript-ui / layout / Card

Class: Card ​

Defined in: src/typescript/lib/layout/Card.ts:25

A layout manager that shows exactly one child component at a time, sizing it to fill the container's inner bounds. The visible child is selected by component ID; all others are hidden.

Extends ​

Constructors ​

new Card() ​

ts
new Card(options?: CardOptions): Card

Defined in: src/typescript/lib/layout/Card.ts:30

Parameters ​

options? ​

CardOptions

Returns ​

Card

Overrides ​

LayoutManager.constructor

Methods ​

attach() ​

ts
attach(container: Component): this

Defined in: src/typescript/lib/layout/LayoutManager.ts:58

Associates this layout manager with a container component.

Parameters ​

container ​

Component

The container component to attach to.

Returns ​

this

Inherited from ​

LayoutManager.attach

delLayoutConstraints() ​

ts
delLayoutConstraints(component: Component): undefined | LayoutConstraints

Defined in: src/typescript/lib/layout/LayoutManager.ts:276

Removes and returns the stored layout constraints for a component.

Parameters ​

component ​

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() ​

ts
detach(): this

Defined in: src/typescript/lib/layout/LayoutManager.ts:67

Dissociates this layout manager from its container.

Returns ​

this

Inherited from ​

LayoutManager.detach

doLayout() ​

ts
doLayout(): void

Defined in: src/typescript/lib/layout/Card.ts:262

Sizes the visible component to fill the container's inner bounds. Visibility transitions are handled in setVisibleComponentId, not here.

Returns ​

void

Overrides ​

LayoutManager.doLayout

getClassName() ​

ts
getClassName(): string

Defined 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 ​

LayoutManager.getClassName

getContainer() ​

ts
getContainer(): null | Component

Defined 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 ​

LayoutManager.getContainer

getId() ​

ts
getId(): string

Defined 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 ​

LayoutManager.getId

getLayoutConstraints() ​

ts
getLayoutConstraints(component: Component): undefined | LayoutConstraints

Defined in: src/typescript/lib/layout/LayoutManager.ts:291

Returns the stored layout constraints for a component.

Parameters ​

component ​

Component

The component to look up.

Returns ​

undefined | LayoutConstraints

The stored constraints, or undefined if none are set.

Inherited from ​

LayoutManager.getLayoutConstraints

getMaxSize() ​

ts
getMaxSize(): null | Size

Defined in: src/typescript/lib/layout/Card.ts:136

Returns the maximum size of the visible child plus the container perimeter.

Returns ​

null | Size

The maximum {width, height}, or null if there is no container or no visible component.

Overrides ​

LayoutManager.getMaxSize

getMinSize() ​

ts
getMinSize(): null | Size

Defined in: src/typescript/lib/layout/Card.ts:101

Returns the minimum size of the visible child plus the container perimeter.

Returns ​

null | Size

The minimum {width, height}, or null if there is no container or no visible component.

Overrides ​

LayoutManager.getMinSize

getPreferredSize() ​

ts
getPreferredSize(): null | Size

Defined in: src/typescript/lib/layout/Card.ts:66

Returns the preferred size of the visible child plus the container perimeter.

Returns ​

null | Size

The preferred {width, height}, or null if there is no container or no visible component.

Overrides ​

LayoutManager.getPreferredSize

getVisibleComponent() ​

ts
getVisibleComponent(): null | Component

Defined in: src/typescript/lib/layout/Card.ts:193

Returns the child component matching visibleComponentId, or the first child if no ID is set. Result is cached; the cache is refreshed when setVisibleComponentId is called or when doLayout runs without a resolved component.

Returns ​

null | Component

The resolved visible component, or null if the container is empty.

getVisibleComponentId() ​

ts
getVisibleComponentId(): null | String

Defined in: src/typescript/lib/layout/Card.ts:57

Returns the ID of the currently visible child component, or null if none is set.

Returns ​

null | String

The visible component ID, or null.

placeComponent() ​

ts
placeComponent(
   component: Component, 
   x: number, 
   y: number, 
   maxWidth: number, 
   maxHeight: number, 
   fill?: null | FillType, 
   anchor?: null | AnchorType): void

Defined 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 ​

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 ​

LayoutManager.placeComponent

setId() ​

ts
setId(id: string): this

Defined 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 ​

LayoutManager.setId

setLayoutConstraints() ​

ts
setLayoutConstraints(component: Component, constraints?: LayoutConstraints): undefined | LayoutConstraints

Defined in: src/typescript/lib/layout/LayoutManager.ts:260

Stores layout constraints for a component, or removes them if constraints is undefined.

Parameters ​

component ​

Component

The component whose constraints are being set.

constraints? ​

LayoutConstraints

Optional. The constraints to store; omit to delete existing constraints.

Returns ​

undefined | LayoutConstraints

The stored constraints, or undefined if they were deleted.

Inherited from ​

LayoutManager.setLayoutConstraints

setVisibleComponentId() ​

ts
setVisibleComponentId(id: String): this

Defined in: src/typescript/lib/layout/Card.ts:174

Selects which child component is visible. Hides the previously-visible child (if different) and shows the new one. Subsequent doLayout calls only re-size the visible child; visibility writes happen here, not on every layout pass.

Parameters ​

id ​

String

The ID of the child component to make visible.

Returns ​

this