Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EditableTextBase

Represents the base class for all editable text views.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional _androidContentDescriptionUpdated

_androidContentDescriptionUpdated: boolean

Internal use only. This is used to limit the number of updates to android.view.View.setContentDescription()

_automaticallyAdjustsScrollViewInsets

_automaticallyAdjustsScrollViewInsets: boolean

_context

_context: any

_cssState

_cssState: CssState

Private _currentHeightMeasureSpec

_currentHeightMeasureSpec: number

Private _currentWidthMeasureSpec

_currentWidthMeasureSpec: number

_defaultPaddingBottom

_defaultPaddingBottom: number

_defaultPaddingLeft

_defaultPaddingLeft: number

_defaultPaddingRight

_defaultPaddingRight: number

_defaultPaddingTop

_defaultPaddingTop: number

_domId

_domId: number

Private _gestureObservers

_gestureObservers: any

_ignoreFlexMinWidthHeightReset

_ignoreFlexMinWidthHeightReset: boolean

_isAddedToNativeVisualTree

_isAddedToNativeVisualTree: boolean

_isPaddingRelative

_isPaddingRelative: boolean

Private _isSingleLine

_isSingleLine: boolean

_isStyleScopeHost

_isStyleScopeHost: boolean

_isViewBase

_isViewBase: boolean

Private _manager

_manager: any

Optional Private _modalParent

_modalParent: View

_moduleName

_moduleName: string

_oldBottom

_oldBottom: number

_oldLeft

_oldLeft: number

_oldRight

_oldRight: number

_oldTop

_oldTop: number

_styleScope

_styleScope: StyleScope

_suspendNativeUpdatesCount

_suspendNativeUpdatesCount: number

_suspendedUpdates

_suspendedUpdates: object

Type declaration

accessibilityHidden

accessibilityHidden: boolean

Hide the view and its children from the a11y service

accessibilityHint

accessibilityHint: string

A hint describes the elements behavior. Example: 'Tap change playback speed'

accessibilityIdentifier

accessibilityIdentifier: string

The view's unique accessibilityIdentifier.

This is used for automated testing.

accessibilityLabel

accessibilityLabel: string

Short description of the element, ideally one word.

accessibilityLanguage

accessibilityLanguage: string

Sets the language in which to speak the element's label and value. Accepts language ID tags that follows the "BCP 47" specification.

accessibilityLiveRegion

accessibilityLiveRegion: AccessibilityLiveRegion

accessibilityMediaSession

accessibilityMediaSession: boolean

This view starts a media session. Equivalent to trait = startsMedia

accessibilityRole

accessibilityRole: AccessibilityRole

Which role should this view be treated by the a11y service?

accessibilityState

accessibilityState: AccessibilityState

Which state should this view be treated as by the a11y service?

accessibilityValue

accessibilityValue: string

Current value of the element in a localized string.

accessible

accessible: boolean

If true the element is an accessibility element and all the children will be treated as a single selectable component.

alignSelf

alignSelf: AlignSelf

android

android: any

Gets the android-specific native instance that lies behind this proxy. Will be available if running on an Android platform.

androidDynamicElevationOffset

androidDynamicElevationOffset: number

Gets or sets the dynamic elevation offset of the android view.

androidElevation

androidElevation: number

Gets or sets the elevation of the android view.

autocapitalizationType

autocapitalizationType: AutocapitalizationInputType

Gets or sets the autocapitalization type.

autocorrect

autocorrect: boolean

Enables or disables autocorrection.

automationText

automationText: string

background

background: string

Gets or sets the background style property.

backgroundColor

backgroundColor: string | Color

Gets or sets the background color of the view.

backgroundImage

backgroundImage: string | LinearGradient

Gets or sets the background image of the view.

bindingContext

bindingContext: any

Gets or sets the binding context of this instance. This object is used as a source for each Binding that does not have a source object specified.

borderBottomColor

borderBottomColor: Color

Gets or sets the bottom border color of the view.

borderBottomLeftRadius

borderBottomLeftRadius: LengthType

Gets or sets the bottom left border radius of the view.

borderBottomRightRadius

borderBottomRightRadius: LengthType

Gets or sets the bottom right border radius of the view.

borderBottomWidth

borderBottomWidth: LengthType

Gets or sets the bottom border width of the view.

borderColor

borderColor: string | Color

Gets or sets the border color of the view.

borderLeftColor

borderLeftColor: Color

Gets or sets the left border color of the view.

borderLeftWidth

borderLeftWidth: LengthType

Gets or sets the left border width of the view.

borderRadius

borderRadius: string | number | LengthDipUnit | LengthPxUnit

Gets or sets the border radius of the view.

borderRightColor

borderRightColor: Color

Gets or sets the right border color of the view.

borderRightWidth

borderRightWidth: LengthType

Gets or sets the right border width of the view.

borderTopColor

borderTopColor: Color

Gets or sets the top border color of the view.

borderTopLeftRadius

borderTopLeftRadius: LengthType

Gets or sets the top left border radius of the view.

borderTopRightRadius

borderTopRightRadius: LengthType

Gets or sets the top right border radius of the view.

borderTopWidth

borderTopWidth: LengthType

Gets or sets the top border width of the view.

borderWidth

borderWidth: string | number | LengthDipUnit | LengthPxUnit

Gets or sets the border width of the view.

boxShadow

boxShadow: string | CSSShadow

Gets or sets the box shadow of the view.

className

className: string

col

col: number

colSpan

colSpan: number

color

color: Color

Gets or sets the color of the view.

column

column: number

columnSpan

columnSpan: number

Private css

css: string

cssClasses

cssClasses: Set<string>

cssPseudoClasses

cssPseudoClasses: Set<string>

cssType

cssType: string

Gets the CSS fully qualified type name. Using this as element type should allow for PascalCase and kebap-case selectors, when fully qualified, to match the element.

dock

dock: DockType

domNode

domNode: DOMNode

editable

editable: boolean

Gets or sets whether the instance is editable.

effectiveBorderBottomWidth

effectiveBorderBottomWidth: number

effectiveBorderLeftWidth

effectiveBorderLeftWidth: number

effectiveBorderRightWidth

effectiveBorderRightWidth: number

effectiveBorderTopWidth

effectiveBorderTopWidth: number

effectiveHeight

effectiveHeight: number

effectiveLeft

effectiveLeft: number

effectiveMarginBottom

effectiveMarginBottom: number

effectiveMarginLeft

effectiveMarginLeft: number

effectiveMarginRight

effectiveMarginRight: number

effectiveMarginTop

effectiveMarginTop: number

effectiveMinHeight

effectiveMinHeight: number

effectiveMinWidth

effectiveMinWidth: number

effectivePaddingBottom

effectivePaddingBottom: number

effectivePaddingLeft

effectivePaddingLeft: number

effectivePaddingRight

effectivePaddingRight: number

effectivePaddingTop

effectivePaddingTop: number

effectiveTop

effectiveTop: number

effectiveWidth

effectiveWidth: number

flexGrow

flexGrow: number

flexShrink

flexShrink: number

flexWrapBefore

flexWrapBefore: boolean

fontSize

fontSize: number

Gets or sets font-size style property.

formattedText

formattedText: FormattedString

Gets or sets a formatted string.

height

Gets or sets the desired height of the view.

hint

hint: string

Gets or sets the placeholder text.

horizontalAlignment

horizontalAlignment: HorizontalAlignmentType

Gets or sets the alignment of this view within its parent along the Horizontal axis.

id

id: string

ios

ios: any

Gets the ios-specific native instance that lies behind this proxy. Will be available if running on an iOS platform.

iosIgnoreSafeArea

iosIgnoreSafeArea: boolean

Gets or sets a value indicating whether the the view should totally ignore safe areas computation. This property is iOS specific. Default value: false

iosOverflowSafeArea

iosOverflowSafeArea: boolean

Instruct container view to expand beyond the safe area. This property is iOS specific. Default value: false

iosOverflowSafeAreaEnabled

iosOverflowSafeAreaEnabled: boolean

Enables or disables the iosOverflowSafeArea property for all children. This property is iOS specific. Default value: true

isCollapsed

isCollapsed: any

isEnabled

isEnabled: boolean

Gets or sets a value indicating whether the the view is enabled. This affects the appearance of the view.

Private isLayoutRequired

isLayoutRequired: boolean

isLayoutValid

isLayoutValid: boolean

Gets is layout is valid. This is a read-only property.

isUserInteractionEnabled

isUserInteractionEnabled: boolean

Gets or sets a value indicating whether the user can interact with the view. This does not affect the appearance of the view.

keyboardType

keyboardType: KeyboardInputType

Gets or sets the soft keyboard type.

left

letterSpacing

letterSpacing: number

Gets or sets letterSpace style property.

lineHeight

lineHeight: number

Gets or sets lineHeight style property.

margin

margin: string | number | LengthDipUnit | LengthPxUnit | LengthPercentUnit

Gets or sets margin style property.

marginBottom

marginBottom: PercentLengthType

Specifies extra space on the bottom side of this view.

marginLeft

marginLeft: PercentLengthType

Specifies extra space on the left side of this view.

marginRight

marginRight: PercentLengthType

Specifies extra space on the right side of this view.

marginTop

Specifies extra space on the top side of this view.

maxLength

maxLength: number

Limits input to a certain number of characters.

minHeight

minHeight: LengthType

Gets or sets the minimum height the view may grow to.

minWidth

minWidth: LengthType

Gets or sets the minimum width the view may grow to.

modal

modal: View

Returns the current modal view that this page is showing (is parent of), if any.

Readonly nativeTextViewProtected

nativeTextViewProtected: any

Gets of the text widget. In some cases(android TextInputLayout) the TextView is made of 2 views: the layout and the text view So we need a different getter for the layout and text functions

nativeViewProtected

nativeViewProtected: any

opacity

opacity: number

Gets or sets the opacity style property.

order

order: number

originX

originX: number

Gets or sets the X component of the origin point around which the view will be transformed. The default value is 0.5 representing the center of the view.

originY

originY: number

Gets or sets the Y component of the origin point around which the view will be transformed. The default value is 0.5 representing the center of the view.

padding

padding: string | number | LengthDipUnit | LengthPxUnit

Gets or sets padding style property.

paddingBottom

paddingBottom: LengthType

Specify the bottom padding of this layout.

paddingLeft

paddingLeft: LengthType

Specify the left padding of this layout.

paddingRight

paddingRight: LengthType

Specify the right padding of this layout.

paddingTop

paddingTop: LengthType

Specify the top padding of this layout.

parent

parent: ViewBase

perspective

perspective: number

Gets or sets the distance of the camera form the view perspective. Usually needed when rotating the view over the X or Y axis.

recycleNativeView

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

returnKeyType

returnKeyType: ReturnKeyButtonType

Gets or sets the soft keyboard return key flavor.

reusable

reusable: boolean

rotate

rotate: number

Gets or sets the rotate affine transform of the view along the Z axis.

rotateX

rotateX: number

Gets or sets the rotate affine transform of the view along the X axis.

rotateY

rotateY: number

Gets or sets the rotate affine transform of the view along the Y axis.

row

row: number

rowSpan

rowSpan: number

scaleX

scaleX: number

Gets or sets the scaleX affine transform of the view.

scaleY

scaleY: number

Gets or sets the scaleY affine transform of the view.

text

text: string

Gets or sets the text.

textAlignment

textAlignment: TextAlignmentType

Gets or sets text-alignment style property.

textDecoration

textDecoration: TextDecorationType

Gets or sets text decorations style property.

textShadow

textShadow: CSSShadow

Gets or sets text shadow style property.

textTransform

textTransform: TextTransformType

Gets or sets text transform style property.

top

translateX

translateX: number

Gets or sets the translateX affine transform of the view in device independent pixels.

translateY

translateY: number

Gets or sets the translateY affine transform of the view in device independent pixels.

updateTextTrigger

updateTextTrigger: UpdateTextTriggerType

Gets or sets a value indicating when the text property will be updated.

verticalAlignment

verticalAlignment: VerticalAlignmentType

Gets or sets the alignment of this view within its parent along the Vertical axis.

viewController

viewController: any

visibility

visibility: VisibilityType

Gets or sets the visibility of the view.

whiteSpace

whiteSpace: WhiteSpaceType

Gets or sets white space style property.

width

Gets or sets the desired width of the view.

Static accessibilityBlurEvent

accessibilityBlurEvent: string

String value used when hooking to accessibilityBlur event.

Static accessibilityFocusChangedEvent

accessibilityFocusChangedEvent: string

String value used when hooking to accessibilityFocusChanged event.

Static accessibilityFocusEvent

accessibilityFocusEvent: string

String value used when hooking to accessibilityFocus event.

Static blurEvent

blurEvent: string

Static createdEvent

createdEvent: string

Static focusEvent

focusEvent: string

Static layoutChangedEvent

layoutChangedEvent: string

String value used when hooking to layoutChanged event.

Static loadedEvent

loadedEvent: string

Static propertyChangeEvent

propertyChangeEvent: string

Static showingModallyEvent

showingModallyEvent: string

String value used when hooking to showingModally event.

Static shownModallyEvent

shownModallyEvent: string

String value used when hooking to shownModally event.

Static textChangeEvent

textChangeEvent: string

Static unloadedEvent

unloadedEvent: string

Accessors

class

  • get (): string
  • set (v: string): void

isLoaded

  • get (): boolean

nativeView

  • get (): any
  • set (value: any): void

page

parentNode

style

typeName

  • get (): string

Methods

Private _addChildFromBuilder

  • _addChildFromBuilder(name: string, value: any): void
  • Called for every child element declared in xml. This method will add a child element (value) to current element.

    Parameters

    • name: string

      Name of the element.

    • value: any

      Value of the element.

    Returns void

_addView

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

_addViewCore

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

_addViewToNativeVisualTree

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

_applyXmlAttribute

  • _applyXmlAttribute(attribute: string, value: string): 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.

    Parameters

    • attribute: string
    • value: string

    Returns boolean

_batchUpdate

  • _batchUpdate<T>(callback: function): T

_childIndexToNativeChildIndex

  • _childIndexToNativeChildIndex(index?: number): number

_closeAllModalViewsInternal

  • _closeAllModalViewsInternal(): boolean

_createPropertyChangeData

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

_dialogClosed

  • _dialogClosed(): void

_eachLayoutView

  • _eachLayoutView(callback: function): void

_emit

  • _emit(eventNames: string): void

Private _getCurrentLayoutBounds

  • _getCurrentLayoutBounds(): object

Private _getFragmentManager

  • _getFragmentManager(): any

_getNativeViewsCount

  • _getNativeViewsCount(): number

_getRootModalViews

  • _getRootModalViews(): ViewBase[]

_getValue

  • _getValue(property: any): never

Private _goToVisualState

  • _goToVisualState(state: string): any

_handleLivesync

  • _handleLivesync(context?: object): boolean

_hasAncestorView

  • _hasAncestorView(ancestorView: View): boolean

_inheritStyleScope

  • _inheritStyleScope(styleScope: StyleScope): void

_layoutParent

  • _layoutParent(): void

_onAttachedToWindow

  • _onAttachedToWindow(): void

_onCssStateChange

  • _onCssStateChange(): void

_onDetachedFromWindow

  • _onDetachedFromWindow(): void

Private _onLivesync

  • _onLivesync(context?: object): boolean

_onRootViewReset

  • _onRootViewReset(): void

Optional _onSizeChanged

  • _onSizeChanged(): void

_parentChanged

  • _parentChanged(oldParent: ViewBase): void

Private _redrawNativeBackground

  • _redrawNativeBackground(value: any): void

Private _removeAnimation

  • _removeAnimation(animation: Animation): boolean

_removeView

  • 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

_removeViewFromNativeVisualTree

  • _removeViewFromNativeVisualTree(view: ViewBase): void

Private _requestLayoutOnTextChanged

  • _requestLayoutOnTextChanged(): void

_resumeNativeUpdates

  • _resumeNativeUpdates(type: SuspendType): void

Private _setCurrentLayoutBounds

  • _setCurrentLayoutBounds(left: number, top: number, right: number, bottom: number): object

Private _setCurrentMeasureSpecs

  • _setCurrentMeasureSpecs(widthMeasureSpec: number, heightMeasureSpec: number): boolean

Private _setInputType

  • _setInputType(inputType: number): void

Private _setMinHeightNative

Private _setMinWidthNative

Private _setNativeClipToBounds

  • _setNativeClipToBounds(): void

Private _setNativeText

  • _setNativeText(reset?: boolean): void

Private _setNativeViewFrame

  • _setNativeViewFrame(nativeView: any, frame: any): void

_setValue

  • _setValue(property: any, value: any): never

_setupAsRootView

  • _setupAsRootView(context: any): void

_setupUI

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

_shouldDelayLayout

  • _shouldDelayLayout(): boolean

_suspendNativeUpdates

  • _suspendNativeUpdates(type: SuspendType): void

_tearDownUI

  • _tearDownUI(force?: boolean): void

Private _updateEffectiveLayoutValues

  • _updateEffectiveLayoutValues(parentWidthMeasureSize: number, parentWidthMeasureMode: number, parentHeightMeasureSize: number, parentHeightMeasureMode: number): void

_updateStyleScope

  • _updateStyleScope(cssFileName?: string, cssString?: string, css?: string): void

accessibilityAnnouncement

  • accessibilityAnnouncement(msg?: string): void

accessibilityScreenChanged

  • accessibilityScreenChanged(): void

Private addCss

  • addCss(cssString: string): void

Private addCssFile

  • addCssFile(cssFileName: string): void

addEventListener

  • addEventListener(eventNames: string, callback: function, thisArg?: any): void

addPseudoClass

  • addPseudoClass(name: string): void

animate

bind

callLoaded

  • callLoaded(): void

callUnloaded

  • callUnloaded(): void

Private changeCssFile

  • changeCssFile(cssFileName: string): void

closeModal

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

createAnimation

createNativeView

  • createNativeView(): Object

deletePseudoClass

  • deletePseudoClass(name: string): void

destroyNode

  • destroyNode(forceDestroyChildren?: boolean): void

dismissSoftInput

  • dismissSoftInput(): void

disposeNativeView

  • disposeNativeView(): void

eachChild

  • eachChild(callback: function): void

eachChildView

  • eachChildView(callback: function): void
  • Iterates over children of type View.

    Parameters

    • callback: function

      Called for each child of type View. Iteration stops if this method returns falsy value.

        • (view: View): boolean
        • Parameters

          Returns boolean

    Returns void

ensureDomNode

  • ensureDomNode(): void

focus

  • focus(): boolean
  • Tries to focus the view. Returns a value indicating whether this view or one of its descendants actually took focus.

    Returns boolean

get

  • get(name: string): any

getActualSize

  • getActualSize(): Size

getGestureObservers

  • getGestureObservers(type: GestureTypes): GesturesObserver[]

getLocationInWindow

  • getLocationInWindow(): Point

getLocationOnScreen

  • getLocationOnScreen(): Point

getLocationRelativeTo

  • getLocationRelativeTo(otherView: View): Point

getMeasuredHeight

  • getMeasuredHeight(): number

getMeasuredState

  • getMeasuredState(): number

getMeasuredWidth

  • getMeasuredWidth(): number

getSafeAreaInsets

  • getSafeAreaInsets(): object

getViewByDomId

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

getViewById

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

Optional hasGestureObservers

  • hasGestureObservers(): boolean

hasListeners

  • hasListeners(eventName: string): boolean

initNativeView

  • initNativeView(): void

layout

  • layout(left: number, top: number, right: number, bottom: number, setFrame?: boolean): void
  • Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism. (The first is measuring). In this phase, each parent calls layout on all of its children to position them. This is typically done using the child measurements that were stored in the measure pass(). Derived classes should not override this method. Derived classes with children should override onLayout. In that method, they should call layout on each of their children.

    Parameters

    • left: number
    • top: number
    • right: number
    • bottom: number
    • Optional setFrame: boolean

    Returns void

layoutNativeView

  • layoutNativeView(left: number, top: number, right: number, bottom: number): void
  • Called from onLayout when native view position is about to be changed.

    Parameters

    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

loadView

measure

  • measure(widthMeasureSpec: number, heightMeasureSpec: number): void
  • This is called to find out how big a view should be. The parent supplies constraint information in the width and height parameters. The actual measurement work of a view is performed in onMeasure(int, int), called by this method. Therefore, only onMeasure(int, int) can and must be overridden by subclasses.

    Parameters

    • widthMeasureSpec: number

      Horizontal space requirements as imposed by the parent

    • heightMeasureSpec: number

      Vertical space requirements as imposed by the parent

    Returns void

notify

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

notifyPropertyChange

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

off

  • off(eventNames: string | GestureTypes, callback?: function, thisArg?: any): any
  • Removes listener(s) for the specified event name.

    Parameters

    • eventNames: string | GestureTypes

      Comma delimited names of the events or gesture types the specified listener is associated with.

    • Optional callback: function

      An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.

    • Optional thisArg: any

      An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.

    Returns any

on

  • on(eventNames: string | GestureTypes, callback: function, thisArg?: any): any
  • on(event: "loaded", callback: function, thisArg?: any): any
  • on(event: "unloaded", callback: function, thisArg?: any): any
  • on(event: "androidBackPressed", callback: function, thisArg?: any): any
  • on(event: "showingModally", callback: function, thisArg?: any): void
  • on(event: "shownModally", callback: function, thisArg?: any): any
  • A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

    Parameters

    • eventNames: string | GestureTypes

      String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change") or you can use gesture types.

    • callback: function

      Callback function which will be executed when event is raised.

    • Optional thisArg: any

      An optional parameter which will be used as this context for callback execution.

    Returns any

  • Raised when a loaded event occurs.

    Parameters

    • event: "loaded"
    • callback: function
    • Optional thisArg: any

    Returns any

  • Raised when an unloaded event occurs.

    Parameters

    • event: "unloaded"
    • callback: function
    • Optional thisArg: any

    Returns any

  • Raised when a back button is pressed. This event is raised only for android.

    Parameters

    • event: "androidBackPressed"
    • callback: function
    • Optional thisArg: any

    Returns any

  • Raised before the view is shown as a modal dialog.

    Parameters

    Returns void

  • Raised after the view is shown as a modal dialog.

    Parameters

    Returns any

onBackPressed

  • onBackPressed(): boolean

onLayout

  • onLayout(left: number, top: number, right: number, bottom: number): void
  • Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

    Parameters

    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

onLoaded

  • onLoaded(): void

onMeasure

  • onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void
  • Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents. When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an exception, thrown by measure(int, int).

    Parameters

    • widthMeasureSpec: number

      horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

    • heightMeasureSpec: number

      vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

    Returns void

onResumeNativeUpdates

  • onResumeNativeUpdates(): void

onUnloaded

  • onUnloaded(): void

once

  • once(event: string, callback: function, thisArg?: any): void

removeEventListener

  • removeEventListener(eventNames: string, callback?: any, thisArg?: any): void

requestLayout

  • requestLayout(): void

resetNativeView

  • resetNativeView(): void

sendAccessibilityEvent

  • sendAccessibilityEvent(options: Partial<AccessibilityEventOptions>): void
  • Send accessibility event

    params

    options AccessibilityEventOptions androidAccessibilityEvent: AndroidAccessibilityEvent; iosNotificationType: IOSPostAccessibilityNotificationType; message: string;

    iOS Notes: type = 'announcement' will announce args via VoiceOver. If no args element will be announced instead. type = 'layout' used when the layout of a screen changes. type = 'screen' large change made to the screen.

    Parameters

    • options: Partial<AccessibilityEventOptions>

    Returns void

set

  • set(name: string, value: any): void

setInlineStyle

  • setInlineStyle(style: string): void

setMeasuredDimension

  • setMeasuredDimension(measuredWidth: number, measuredHeight: number): void
  • This method must be called by onMeasure(int, int) to store the measured width and measured height. Failing to do so will trigger an exception at measurement time.

    Parameters

    • measuredWidth: number

      The measured width of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

    • measuredHeight: number

      The measured height of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

    Returns void

setNativeView

  • setNativeView(value: any): void

Optional setOnTouchListener

  • setOnTouchListener(): void

setProperty

  • setProperty(name: string, value: any): void

setSelection

  • setSelection(start: number, stop?: number): any

showModal

toString

  • toString(): string

unbind

  • unbind(property: string): void

unloadView

Static addEventListener

  • addEventListener(eventName: string, callback: any, thisArg?: any): void

Static combineMeasuredStates

  • combineMeasuredStates(curState: number, newState: any): number

Static layoutChild

  • layoutChild(parent: View, child: View, left: number, top: number, right: number, bottom: number): void
  • Layout a child by taking into account its margins, horizontal and vertical alignments and a given bounds.

    Parameters

    • parent: View

      This parameter is not used. You can pass null.

    • child: View
    • left: number

      Left position, relative to parent

    • top: number

      Top position, relative to parent

    • right: number

      Right position, relative to parent

    • bottom: number

      Bottom position, relative to parent

    Returns void

Static measureChild

  • measureChild(parent: View, child: View, widthMeasureSpec: number, heightMeasureSpec: number): object
  • Measure a child by taking into account its margins and a given measureSpecs.

    Parameters

    • parent: View

      This parameter is not used. You can pass null.

    • child: View

      The view to be measured.

    • widthMeasureSpec: number
    • heightMeasureSpec: number

    Returns object

    • measuredHeight: number

      The measured height that the parent layout specifies for this view.

    • measuredWidth: number

      The measured width that the parent layout specifies for this view.

Static off

  • off(eventName: string, callback?: any, thisArg?: any): void

Static on

  • on(eventName: string, callback: any, thisArg?: any): void

Static once

  • once(eventName: string, callback: any, thisArg?: any): void

Static removeEventListener

  • removeEventListener(eventName: string, callback?: any, thisArg?: any): void

Static resolveSizeAndState

  • resolveSizeAndState(size: number, specSize: number, specMode: number, childMeasuredState: number): number
  • Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec. Will take the desired size, unless a different size is imposed by the constraints. The returned value is a compound integer, with the resolved size in the MEASURED_SIZE_MASK bits and optionally the bit MEASURED_STATE_TOO_SMALL set if the resulting size is smaller than the size the view wants to be.

    Parameters

    • size: number
    • specSize: number
    • specMode: number
    • childMeasuredState: number

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method