UICell
The UICell component groups other components together within its own boundaries.
class UICell
extends UIContainer
Represents a UI component that visually groups other components in a rectangular cell.
See Also
UICoverCell, UIFlowCell, UIListCellAdapter.
Constructor
(...content: UIRenderable[]): UICell
.isFocusable()
(): boolean
Returns true if this component can be focused directly using mouse or touch, or manually using UIComponent.requestFocus. This method may be overridden by derived component classes, but the return value must be constant for each instance.
.isKeyboardFocusable()
(): boolean
Returns true if this component can be focused using the keyboard as well as using other methods (rather than direct manipulation only). This method may be overridden by derived component classes, but the return value must be constant for each instance.
.applyStyle() protected
(style?: UIStyle): void
Applies given style set to individual style objects (e.g. UIComponent.dimensions). This method is overridden by derived classes to copy only applicable styles.
.decoration
Readonly<Decoration>
Options for the appearance of this cell; most of these are overridden by individual properties.
.padding
Offsets
Padding around contained elements (in dp or CSS string, or separate offset values).
.margin
Offsets
Margin around the entire cell (in dp or CSS string, or separate offset values).
.background
string | UIColor
Cell background (UIColor or string), defaults to transparent.
.textColor
string | UIColor
Text color (UIColor or string), defaults to inherit to inherit the text color from a containing cell or background window.
.borderThickness
Offsets
Border thickness (in dp or string with unit, or separate offset values).
.borderColor
string | UIColor
Border color (UIColor or string).
.borderStyle
string
Border style (CSS), defaults to solid.
.borderRadius
string | number
Border radius (in dp or CSS string).
.dropShadow
number
Intensity of drop shadow based on visual ‘elevation’ level (0-1).
.opacity
number
Opacity (0-1; defaults to fully opaque if undefined).
.revealTransition
string
Animated transition that plays when this cell is first rendered.
.exitTransition
string
Animated transition that plays when this cell is removed from a container.
.css
Partial<CSSStyleDeclaration> & { className?: string; }
Other CSS attributes that are applied directly to the container, if supported (plain object).
Note: Changes to individual properties are not observed by the renderer.
.allowFocus
boolean
Inherited from UIContainer.allowFocus.
.allowKeyboardFocus
boolean
Inherited from UIContainer.allowKeyboardFocus.
.layout
Readonly<ContainerLayout>
Inherited from UIContainer.layout.
.asyncContentRendering
boolean
Inherited from UIContainer.asyncContentRendering.
.animatedContentRenderingDuration
number
Inherited from UIContainer.animatedContentRenderingDuration.
.animatedContentRenderingVelocity
number
Inherited from UIContainer.animatedContentRenderingVelocity.
.content
Inherited from UIContainer.content.
.propagateComponentEvent() deprecated
(name: string, inner?: ManagedEvent, event?: any): void
Inherited from UIComponent.propagateComponentEvent.
.delegateEvent() protected
(e: ManagedEvent, propertyName: string): true
Inherited from UIComponent.delegateEvent.
.render()
(callback: RenderCallback<Output<UIRenderable, any>>): void
Inherited from UIComponent.render.
.requestFocus()
(): void
Inherited from UIComponent.requestFocus.
.requestFocusNext()
(): void
Inherited from UIComponent.requestFocusNext.
.requestFocusPrevious()
(): void
Inherited from UIComponent.requestFocusPrevious.
.style
Inherited from UIComponent.style.
.hidden
boolean
Inherited from UIComponent.hidden.
.dimensions
Readonly<Dimensions>
Inherited from UIComponent.dimensions.
.position
Readonly<Position>
Inherited from UIComponent.position.
.accessibleRole
string
Inherited from UIComponent.accessibleRole.
.accessibleLabel
string
Inherited from UIComponent.accessibleLabel.
.lastRenderOutput
Output<this, any>
Inherited from UIComponent.lastRenderOutput.
.isPresetComponent() protected
(): boolean
Inherited from Component.isPresetComponent.
.getParentComponent()
<TParent extends Component = Component>(ParentClass?: ComponentConstructor<TParent>): TParent
Inherited from Component.getParentComponent.
.getBoundParentComponent()
<TParent extends Component>(ParentClass?: ComponentConstructor<TParent>): TParent
Inherited from Component.getBoundParentComponent.
.emitAction()
(name: string, inner?: ManagedEvent, context?: ManagedObject): void
Inherited from Component.emitAction.
.managedId
number
Inherited from ManagedObject.managedId.
.managedState
Inherited from ManagedObject.managedState.
.getReferenceCount() protected
(): number
Inherited from ManagedObject.getReferenceCount.
.getManagedReferrers() protected
(): ManagedObject[]
Inherited from ManagedObject.getManagedReferrers.
.getManagedParent() protected
<TParent extends ManagedObject = ManagedObject>(ParentClass?: ManagedObjectConstructor<TParent>): TParent
Inherited from ManagedObject.getManagedParent.
.emit()
<TEvent extends ManagedEvent = ManagedEvent, TConstructorArgs extends any[] = any[]>(e: string | TEvent | (new (...args: TConstructorArgs) => TEvent), ...constructorArgs: TConstructorArgs): this
Inherited from ManagedObject.emit.
.emitChange()
(name?: string): void
Inherited from ManagedObject.emitChange.
.propagateChildEvents() protected deprecated
(...types: ((new (...args: any[]) => ManagedEvent) | ((e: ManagedEvent) => any))[]): this
Inherited from ManagedObject.propagateChildEvents.
.activateManagedAsync() protected
(): Promise<any>
Inherited from ManagedObject.activateManagedAsync.
.deactivateManagedAsync() protected
(): Promise<void>
Inherited from ManagedObject.deactivateManagedAsync.
.destroyManagedAsync() protected
(): Promise<void>
Inherited from ManagedObject.destroyManagedAsync.
.onManagedStateActivatingAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateActivatingAsync.
.onManagedStateActiveAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateActiveAsync.
.onManagedStateDeactivatingAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateDeactivatingAsync.
.onManagedStateInactiveAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateInactiveAsync.
.onManagedStateDestroyingAsync() protected
(): Promise<void>
Inherited from ManagedObject.onManagedStateDestroyingAsync.
UICell.Presets
extends UIContainer.Presets
UICell presets type, for use with Component.with.
.decoration
Decoration
Options for the appearance of this cell; most of these are overridden by individual properties.
.padding
Offsets
Padding around contained elements (in dp or CSS string, or separate offset values).
.margin
Offsets
Margin around the entire cell (in dp or CSS string, or separate offset values).
.background
string | UIColor
Cell background (UIColor or string).
.textColor
string | UIColor
Text color (UIColor or string), defaults to inherit to inherit the text color from a containing cell or background window.
.borderThickness
Offsets
Border thickness (in dp or string with unit).
.borderColor
string | UIColor
Border color (UIColor or string).
.borderStyle
string
Border style (CSS), defaults to solid.
.borderRadius
string | number
Corner radius (in dp or CSS string, defaults to 0).
.dropShadow
number
Size of drop shadow based on visual ‘elevation’ (0-1).
.opacity
number
Opacity (0-1).
.selectOnFocus
boolean
Set to true to select cells on focus, implies allowFocus as well.
.allowFocus
boolean
Set to true to allow this cell itself to receive input focus using mouse, touch, or UIComponent.requestFocus.
.allowKeyboardFocus
boolean
Set to true to allow this cell itself to receive input focus using the keyboard as well as other methods; implies allowFocus.
.revealTransition
string
Animation that plays when this cell is first rendered.
.exitTransition
string
Animation that plays when this cell is removed from a container.
.css
Partial<CSSStyleDeclaration> & { className?: string; }
Other CSS attributes that are applied directly to the container, if supported (plain object).
.content
Iterable<UIRenderable>
Inherited from UIContainer.Presets.content.
.layout
Partial<{} | ContainerLayout>
Inherited from UIContainer.Presets.layout.
.asyncContentRendering
boolean
Inherited from UIContainer.Presets.asyncContentRendering.
.animatedContentRenderingDuration
number
Inherited from UIContainer.Presets.animatedContentRenderingDuration.
.animatedContentRenderingVelocity
number
Inherited from UIContainer.Presets.animatedContentRenderingVelocity.
.style
string | UIStyle
Inherited from UIComponent.Presets.style.
.hidden
boolean
Inherited from UIComponent.Presets.hidden.
.dimensions
Partial<{} | Dimensions>
Inherited from UIComponent.Presets.dimensions.
.position
Partial<{} | Position>
Inherited from UIComponent.Presets.position.
.accessibleRole
string
Inherited from UIComponent.Presets.accessibleRole.
.accessibleLabel
string
Inherited from UIComponent.Presets.accessibleLabel.
.requestFocus
boolean
Inherited from UIComponent.Presets.requestFocus.