ViewBase

Defined in: ui/core/view-base/index.ts

Ns View ​

ViewBase

Extends ​

• Observable

Extended by ​

• ActionItem
• SegmentedBarItem
• TabViewItem
• FormattedString
• Span

Constructors ​

Constructor ​

new ViewBase(): ViewBase;

Defined in: ui/core/view-base/index.ts

Returns ​

ViewBase

Overrides ​

Observable.constructor

Properties ​

_automaticallyAdjustsScrollViewInsets ​

_automaticallyAdjustsScrollViewInsets: boolean;

Defined in: ui/core/view-base/index.ts

_context ​

_context: any;

Defined in: ui/core/view-base/index.ts

_cssState ​

_cssState: CssState;

Defined in: ui/core/view-base/index.ts

_defaultPaddingBottom ​

protected _defaultPaddingBottom: number;

Defined in: ui/core/view-base/index.ts

_defaultPaddingLeft ​

protected _defaultPaddingLeft: number;

Defined in: ui/core/view-base/index.ts

_defaultPaddingRight ​

protected _defaultPaddingRight: number;

Defined in: ui/core/view-base/index.ts

_defaultPaddingTop ​

protected _defaultPaddingTop: number;

Defined in: ui/core/view-base/index.ts

_domId ​

_domId: number;

Defined in: ui/core/view-base/index.ts

_ignoreFlexMinWidthHeightReset ​

_ignoreFlexMinWidthHeightReset: boolean;

Defined in: ui/core/view-base/index.ts

_isAddedToNativeVisualTree ​

_isAddedToNativeVisualTree: boolean;

Defined in: ui/core/view-base/index.ts

_isPaddingRelative ​

protected _isPaddingRelative: boolean;

Defined in: ui/core/view-base/index.ts

_isStyleScopeHost ​

_isStyleScopeHost: boolean;

Defined in: ui/core/view-base/index.ts

_oldBottom ​

_oldBottom: number;

Defined in: ui/core/view-base/index.ts

_oldLeft ​

_oldLeft: number;

Defined in: ui/core/view-base/index.ts

_oldRight ​

_oldRight: number;

Defined in: ui/core/view-base/index.ts

_oldTop ​

_oldTop: number;

Defined in: ui/core/view-base/index.ts

_styleScope ​

_styleScope: StyleScope;

Defined in: ui/core/view-base/index.ts

_suspendNativeUpdatesCount ​

_suspendNativeUpdatesCount: number;

Defined in: ui/core/view-base/index.ts

Determines the depth of suspended updates. When the value is 0 the current property updates are not batched nor scoped and must be immediately applied. If the value is 1 or greater, the current updates are batched and does not have to provide immediate update. Do not set this field, the _batchUpdate method is responsible to keep the count up to date, as well as adding/rmoving the view to/from the visual tree.

alignSelf ​

alignSelf: AlignSelf;

Defined in: ui/core/view-base/index.ts

(Android-only) Overrides the alignItems value for the child.

Ns Property ​

bindingContext ​

bindingContext: any;

Defined in: ui/core/view-base/index.ts

Ns Property ​

className ​

className: string;

Defined in: ui/core/view-base/index.ts

Gets or sets the CSS class name for this view.

Ns Property ​

col ​

col: number;

Defined in: ui/core/view-base/index.ts

The column for the element. The columns are 0-indexed, so the first column is indicated by 0.

Ns Property ​

colSpan ​

colSpan: number;

Defined in: ui/core/view-base/index.ts

The number of columns for the element to span across.

Ns Property ​

column ​

column: number;

Defined in: ui/core/view-base/index.ts

The column for the element. The columns are 0-indexed, so the first column is indicated by 0.

Ns Property ​

columnSpan ​

columnSpan: number;

Defined in: ui/core/view-base/index.ts

Ns Property ​

cssClasses ​

readonly cssClasses: Set<string>;

Defined in: ui/core/view-base/index.ts

cssPseudoClasses ​

readonly cssPseudoClasses: Set<string>;

Defined in: ui/core/view-base/index.ts

defaultVisualState ​

defaultVisualState: string;

Defined in: ui/core/view-base/index.ts

Default visual state, defaults to 'normal'

Ns Property ​

dock ​

dock: "left" | "right" | "top" | "bottom";

Defined in: ui/core/view-base/index.ts

Dock position of the view within its parent.

Ns Property ​

domNode ​

domNode: DOMNode;

Defined in: ui/core/view-base/index.ts

effectiveBorderBottomWidth ​

effectiveBorderBottomWidth: number;

Defined in: ui/core/view-base/index.ts

effectiveBorderLeftWidth ​

effectiveBorderLeftWidth: number;

Defined in: ui/core/view-base/index.ts

effectiveBorderRightWidth ​

effectiveBorderRightWidth: number;

Defined in: ui/core/view-base/index.ts

effectiveBorderTopWidth ​

effectiveBorderTopWidth: number;

Defined in: ui/core/view-base/index.ts

effectiveHeight ​

effectiveHeight: number;

Defined in: ui/core/view-base/index.ts

effectiveLeft ​

effectiveLeft: number;

Defined in: ui/core/view-base/index.ts

effectiveMarginBottom ​

effectiveMarginBottom: number;

Defined in: ui/core/view-base/index.ts

effectiveMarginLeft ​

effectiveMarginLeft: number;

Defined in: ui/core/view-base/index.ts

effectiveMarginRight ​

effectiveMarginRight: number;

Defined in: ui/core/view-base/index.ts

effectiveMarginTop ​

effectiveMarginTop: number;

Defined in: ui/core/view-base/index.ts

effectiveMinHeight ​

effectiveMinHeight: number;

Defined in: ui/core/view-base/index.ts

effectiveMinWidth ​

effectiveMinWidth: number;

Defined in: ui/core/view-base/index.ts

effectiveTop ​

effectiveTop: number;

Defined in: ui/core/view-base/index.ts

effectiveWidth ​

effectiveWidth: number;

Defined in: ui/core/view-base/index.ts

flexGrow ​

flexGrow: number;

Defined in: ui/core/view-base/index.ts

Indicates that the child should grow in size, if necessary. Sets how much the child will grow in proportion to the rest of the child elements in the flex container.

Ns Property ​

flexShrink ​

flexShrink: number;

Defined in: ui/core/view-base/index.ts

Indicates that the child should shrink when the row runs out of space. Sets how much the flex item will shrink in proportion to the rest of the child elements in the flex container. When not specified, its value is set to 1.

Ns Property ​

flexWrapBefore ​

flexWrapBefore: boolean;

Defined in: ui/core/view-base/index.ts

When true, forces the item to wrap onto a new line.

Ns Property ​

hidden ​

hidden: boolean;

Defined in: ui/core/view-base/index.ts

Gets or sets the visual state of the view.

Ns Property ​

id ​

id: string;

Defined in: ui/core/view-base/index.ts

Gets or sets the id for this view.

Ns Property ​

isCollapsed ​

isCollapsed: any;

Defined in: ui/core/view-base/index.ts

Returns true if visibility is set to 'collapse'. Default(false) set in prototype Readonly property

left ​

left: LengthType;

Defined in: ui/core/view-base/index.ts

Gets or sets the distance, in pixels, between the left edge of the child and the left edge of its parent.

Ns Property ​

mIsRootView ​

mIsRootView: boolean;

Defined in: ui/core/view-base/index.ts

if _setupAsRootView is called it means it is not supposed to be added to a parent. However parent can be set before for the purpose of CSS variables/classes. That variable ensures that _addViewToNativeVisualTree is not called in _setupAsRootView

nativeViewProtected ​

nativeViewProtected: any;

Defined in: ui/core/view-base/index.ts

read-only. If you want to set out-of-band the nativeView use the setNativeView method.

order ​

order: number;

Defined in: ui/core/view-base/index.ts

Sets the order in which child elements inside a Flex appear in relation to one another.

Ns Property ​

parent ​

parent: ViewBase;

Defined in: ui/core/view-base/index.ts

Gets the parent view. This property is read-only.

recycleNativeView ​

recycleNativeView: "auto" | "always" | "never";

Defined in: ui/core/view-base/index.ts

reusable ​

reusable: boolean;

Defined in: ui/core/view-base/index.ts

Gets or sets if the view is reusable. Reusable views are not automatically destroyed when removed from the View tree.

Ns Property ​

row ​

row: number;

Defined in: ui/core/view-base/index.ts

The row for the element. The rows are 0-indexed, so the first row is indicated by 0.

Ns Property ​

rowSpan ​

rowSpan: number;

Defined in: ui/core/view-base/index.ts

The number of rows for the element to span across.

Ns Property ​

sharedTransitionIgnore ​

sharedTransitionIgnore: boolean;

Defined in: ui/core/view-base/index.ts

Opt out of shared transition under different binding conditions

Ns Property ​

sharedTransitionTag ​

sharedTransitionTag: string;

Defined in: ui/core/view-base/index.ts

Gets or sets the shared transition tag for animated view transitions

Ns Property ​

top ​

top: LengthType;

Defined in: ui/core/view-base/index.ts

Gets or sets the distance, in pixels, between the top edge of the child and the top edge of its parent.

Ns Property ​

viewController ​

viewController: any;

Defined in: ui/core/view-base/index.ts

returns the native UIViewController.

createdEvent ​

static createdEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to creation event

Ns Event ​

created

disposeNativeViewEvent ​

static disposeNativeViewEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to disposeNativeView event

Ns Event ​

disposeNativeView

loadedEvent ​

static loadedEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to loaded event.

Ns Event ​

loaded

propertyChangeEvent ​

static propertyChangeEvent: string;

Defined in: data/observable/index.ts

String value used when hooking to propertyChange event.

Ns Event ​

propertyChange

Inherited from ​

Observable.propertyChangeEvent

unloadedEvent ​

static unloadedEvent: string;

Defined in: ui/core/view-base/index.ts

String value used when hooking to unloaded event.

Ns Event ​

unloaded

Accessors ​

android ​

Get Signature ​

get android(): any;

Defined in: ui/core/view-base/index.ts

Returns ​

any

class ​

Get Signature ​

get class(): string;

Defined in: ui/core/view-base/index.ts

Returns ​

string

Set Signature ​

set class(v: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

effectivePaddingBottom ​

Get Signature ​

get effectivePaddingBottom(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

set effectivePaddingBottom(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

effectivePaddingLeft ​

Get Signature ​

get effectivePaddingLeft(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

set effectivePaddingLeft(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

effectivePaddingRight ​

Get Signature ​

get effectivePaddingRight(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

set effectivePaddingRight(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

effectivePaddingTop ​

Get Signature ​

get effectivePaddingTop(): number;

Defined in: ui/core/view-base/index.ts

Returns ​

number

Set Signature ​

set effectivePaddingTop(v: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

ios ​

Get Signature ​

get ios(): any;

Defined in: ui/core/view-base/index.ts

Returns ​

any

isLoaded ​

Get Signature ​

get isLoaded(): boolean;

Defined in: ui/core/view-base/index.ts

Returns ​

boolean

nativeView ​

Get Signature ​

get nativeView(): any;

Defined in: ui/core/view-base/index.ts

Returns ​

any

Set Signature ​

set nativeView(value: any): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

page ​

Get Signature ​

get page(): Page;

Defined in: ui/core/view-base/index.ts

Gets owner page. This is a read-only property.

Returns ​

Page

parentNode ​

Get Signature ​

get parentNode(): ViewBase;

Defined in: ui/core/view-base/index.ts

Gets the template parent or the native parent. Sets the template parent.

Returns ​

ViewBase

Set Signature ​

set parentNode(node: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

style ​

Get Signature ​

get style(): Style;

Defined in: ui/core/view-base/index.ts

Gets the style object associated to this view.

Returns ​

Style

Set Signature ​

set style(inlineStyle: Style): void;

Defined in: ui/core/view-base/index.ts

Ns Property ​

Parameters ​

Returns ​

void

typeName ​

Get Signature ​

get typeName(): string;

Defined in: ui/core/view-base/index.ts

Gets the name of the constructor function for this instance. E.g. for a Button class this will return "Button".

Returns ​

string

visualState ​

Get Signature ​

get visualState(): string;

Defined in: ui/core/view-base/index.ts

Deprecated ​

Returns ​

string

Methods ​

_addView() ​

_addView(view: ViewBase, atIndex?: number): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_addViewCore() ​

_addViewCore(view: ViewBase, atIndex?: number): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Parameters ​

Returns ​

void

_addViewToNativeVisualTree() ​

_addViewToNativeVisualTree(view: ViewBase, atIndex?: number): boolean;

Defined in: ui/core/view-base/index.ts

Performs the core logic of adding a child view to the native visual tree. Returns true if the view's native representation has been successfully added, false otherwise. Method is intended to be overridden by inheritors and used as "protected".

Parameters ​

Returns ​

boolean

_addVisualState() ​

_addVisualState(state: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_applyXmlAttribute() ​

_applyXmlAttribute(attribute: string, value: string): boolean;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

boolean

Deprecated ​

This used to be the way to set attribute values in early {N} versions. Now attributes are expected to be set as plain properties on the view instances.

_batchUpdate() ​

_batchUpdate<T>(callback: () => T): T;

Defined in: ui/core/view-base/index.ts

Allow multiple updates to be performed on the instance at once.

Type Parameters ​

Parameters ​

Returns ​

T

_childIndexToNativeChildIndex() ​

_childIndexToNativeChildIndex(index?: number): number;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

number

_createPropertyChangeData() ​

_createPropertyChangeData(
   propertyName: string, 
   value: any, 
   oldValue?: any): PropertyChangeData;

Defined in: data/observable/index.ts

This method is intended to be overriden by inheritors to provide additional implementation.

Parameters ​

Returns ​

PropertyChangeData

Inherited from ​

Observable._createPropertyChangeData

_dialogClosed() ​

_dialogClosed(): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Returns ​

void

_emit() ​

_emit(eventName: string): void;

Defined in: data/observable/index.ts

Parameters ​

Returns ​

void

Inherited from ​

Observable._emit

_goToVisualState() ​

_goToVisualState(state: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

Deprecated ​

Use View._addVisualState() and View._removeVisualState() instead.

_inheritStyles() ​

_inheritStyles(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_inheritStyleScope() ​

_inheritStyleScope(styleScope: StyleScope): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_layoutParent() ​

_layoutParent(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

_onRootViewReset() ​

_onRootViewReset(): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Returns ​

void

_parentChanged() ​

_parentChanged(oldParent: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_removeView() ​

_removeView(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Core logic for removing a child view from this instance. Used by the framework to handle lifecycle events more centralized. Do not use outside the UI Stack implementation.

Parameters ​

Returns ​

void

_removeViewCore() ​

_removeViewCore(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Parameters ​

Returns ​

void

_removeViewFromNativeVisualTree() ​

_removeViewFromNativeVisualTree(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Method is intended to be overridden by inheritors and used as "protected"

Parameters ​

Returns ​

void

_removeVisualState() ​

_removeVisualState(state: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_resumeNativeUpdates() ​

_resumeNativeUpdates(type: SuspendType): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_setDefaultPaddings() ​

_setDefaultPaddings(insets: any): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_setupAsRootView() ​

_setupAsRootView(context: any): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_setupUI() ​

_setupUI(
   context: any, 
   atIndex?: number, 
   parentIsLoaded?: boolean): void;

Defined in: ui/core/view-base/index.ts

Setups the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

Parameters ​

Returns ​

void

_shouldDelayLayout() ​

_shouldDelayLayout(): boolean;

Defined in: ui/core/view-base/index.ts

When returning true the callLoaded method will be run in setTimeout Method is intended to be overridden by inheritors and used as "protected"

Returns ​

boolean

_suspendNativeUpdates() ​

_suspendNativeUpdates(type: SuspendType): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

_tearDownUI() ​

_tearDownUI(force?: boolean): void;

Defined in: ui/core/view-base/index.ts

Tears down the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

Parameters ​

Returns ​

void

addEventListener() ​

addEventListener(
   eventName: string, 
   callback: (data: EventData) => void, 
   thisArg?: any, 
   once?: boolean): void;

Defined in: data/observable/index.ts

Adds a listener for the specified event name.

Parameters ​

Returns ​

void

Inherited from ​

Observable.addEventListener

addPseudoClass() ​

protected addPseudoClass(name: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

Unstable ​

A widget can call this method to add a matching css pseudo class.

bind() ​

bind(options: BindingOptions, source?: Object): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

callLoaded() ​

callLoaded(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

callUnloaded() ​

callUnloaded(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

closeModal() ​

closeModal(...args: any[]): void;

Defined in: ui/core/view-base/index.ts

Closes the current modal view that this page is showing.

Parameters ​

Returns ​

void

createNativeView() ​

createNativeView(): Object;

Defined in: ui/core/view-base/index.ts

Creates a native view. Returns either android.view.View or UIView.

Returns ​

Object

deletePseudoClass() ​

protected deletePseudoClass(name: string): void;

Defined in: ui/core/view-base/index.ts

Parameters ​

Returns ​

void

Unstable ​

A widget can call this method to discard matching css pseudo class.

destroyNode() ​

destroyNode(forceDestroyChildren?: boolean): void;

Defined in: ui/core/view-base/index.ts

Tears down the UI of a reusable node by making it no longer reusable.

Parameters ​

Returns ​

void

See ​

_tearDownUI

disposeNativeView() ​

disposeNativeView(): void;

Defined in: ui/core/view-base/index.ts

Clean up references to the native view.

Returns ​

void

eachChild() ​

eachChild(callback: (child: ViewBase) => boolean): void;

Defined in: ui/core/view-base/index.ts

Iterates over children of type ViewBase.

Parameters ​

Returns ​

void

ensureDomNode() ​

ensureDomNode(): void;

Defined in: ui/core/view-base/index.ts

Returns ​

void

Unstable ​

Ensures a dom-node for this view.

get() ​

get(name: string): any;

Defined in: data/observable/index.ts

Gets the value of the specified property.

Parameters ​

Returns ​

any

Inherited from ​

Observable.get

getEffectivePaddingShorthand() ​

getEffectivePaddingShorthand(): string;

Defined in: ui/core/view-base/index.ts

Returns ​

string

getViewByDomId() ​

getViewByDomId<T>(domId: number): T;

Defined in: ui/core/view-base/index.ts

Returns the child view with the specified domId.

Type Parameters ​

Parameters ​

Returns ​

T

getViewById() ​

getViewById<T>(id: string): T;

Defined in: ui/core/view-base/index.ts

Returns the child view with the specified id.

Type Parameters ​

Parameters ​

Returns ​

T

hasListeners() ​

hasListeners(eventName: string): boolean;

Defined in: data/observable/index.ts

Checks whether a listener is registered for the specified event name.

Parameters ​

Returns ​

boolean

Inherited from ​

Observable.hasListeners

initNativeView() ​

initNativeView(): void;

Defined in: ui/core/view-base/index.ts

Initializes properties/listeners of the native view.

Returns ​

void

loadView() ​

loadView(view: ViewBase): void;

Defined in: ui/core/view-base/index.ts

Load view.

Parameters ​

Returns ​

void

notify() ​

notify<T>(data: T): void;

Defined in: data/observable/index.ts

Notify this Observable instance with some data. This causes all event handlers on the Observable instance to be called, as well as any 'global' event handlers set on the instance's class.

Type Parameters ​

Parameters ​

Returns ​

void

Inherited from ​

Observable.notify

notifyPropertyChange() ​

notifyPropertyChange(
   name: string, 
   value: any, 
   oldValue?: any): void;

Defined in: data/observable/index.ts

Notifies all the registered listeners for the property change event.

Parameters ​

Returns ​

void

Inherited from ​

Observable.notifyPropertyChange

off() ​

off(
   eventName: string, 
   callback?: (data: EventData) => void, 
   thisArg?: any): void;

Defined in: data/observable/index.ts

Removes the listener(s) for the specified event name.

Parameters ​