UNPKG

13.8 kBTypeScriptView Raw
1import { View as ViewDefinition, Point, Size } from '.';
2import { ShowModalOptions, ViewBase } from '../view-base';
3import { Color } from '../../../color';
4import { Property, InheritedProperty } from '../properties';
5import { EventData } from '../../../data/observable';
6import { CoreTypes } from '../../../core-types';
7import { GesturesObserver, GestureTypes, GestureEventData, TouchAnimationOptions, VisionHoverOptions } from '../../gestures';
8import { LinearGradient } from '../../styling/linear-gradient';
9import * as am from '../../animation';
10import { AccessibilityEventOptions, AccessibilityLiveRegion, AccessibilityRole, AccessibilityState } from '../../../accessibility/accessibility-types';
11import { ShadowCSSValues } from '../../styling/css-shadow';
12export * from './view-helper';
13export declare function CSSType(type: string): ClassDecorator;
14export declare function viewMatchesModuleContext(view: ViewDefinition, context: ModuleContext, types: ModuleType[]): boolean;
15export declare function PseudoClassHandler(...pseudoClasses: string[]): MethodDecorator;
16export declare const _rootModalViews: ViewBase[];
17export declare abstract class ViewCommon extends ViewBase implements ViewDefinition {
18 static layoutChangedEvent: string;
19 static shownModallyEvent: string;
20 static showingModallyEvent: string;
21 static accessibilityBlurEvent: string;
22 static accessibilityFocusEvent: string;
23 static accessibilityFocusChangedEvent: string;
24 static accessibilityPerformEscapeEvent: string;
25 accessibilityIdentifier: string;
26 accessibilityLabel: string;
27 accessibilityValue: string;
28 accessibilityHint: string;
29 testID: string;
30 touchAnimation: boolean | TouchAnimationOptions;
31 ignoreTouchAnimation: boolean;
32 touchDelay: number;
33 /**
34 * visionOS only
35 */
36 visionHoverStyle: string | VisionHoverOptions;
37 visionIgnoreHoverStyle: boolean;
38 protected _closeModalCallback: Function;
39 _manager: any;
40 _modalParent: ViewCommon;
41 private _modalContext;
42 private _modal;
43 /**
44 * Active transition instance id for tracking state
45 */
46 transitionId: number;
47 private _measuredWidth;
48 private _measuredHeight;
49 protected _isLayoutValid: boolean;
50 private _cssType;
51 private _localAnimations;
52 _currentWidthMeasureSpec: number;
53 _currentHeightMeasureSpec: number;
54 _setMinWidthNative: (value: CoreTypes.LengthType) => void;
55 _setMinHeightNative: (value: CoreTypes.LengthType) => void;
56 _gestureObservers: {};
57 _androidContentDescriptionUpdated?: boolean;
58 get css(): string;
59 set css(value: string);
60 addCss(cssString: string): void;
61 addCssFile(cssFileName: string): void;
62 changeCssFile(cssFileName: string): void;
63 _updateStyleScope(cssFileName?: string, cssString?: string, css?: string): void;
64 private setScopeProperty;
65 onLoaded(): void;
66 _closeAllModalViewsInternal(): boolean;
67 _getRootModalViews(): Array<ViewBase>;
68 _onLivesync(context?: ModuleContext): boolean;
69 _handleLivesync(context?: ModuleContext): boolean;
70 _setupAsRootView(context: any): void;
71 _observe(type: GestureTypes, callback: (args: GestureEventData) => void, thisArg?: any): void;
72 getGestureObservers(type: GestureTypes): Array<GesturesObserver>;
73 addEventListener(arg: string | GestureTypes, callback: (data: EventData) => void, thisArg?: any): void;
74 removeEventListener(arg: string | GestureTypes, callback?: (data: EventData) => void, thisArg?: any): void;
75 onBackPressed(): boolean;
76 _getFragmentManager(): any;
77 private getModalOptions;
78 showModal(...args: any[]): ViewDefinition;
79 closeModal(...args: any[]): void;
80 get modal(): ViewCommon;
81 protected _showNativeModalView(parent: ViewCommon, options: ShowModalOptions): void;
82 protected _hideNativeModalView(parent: ViewCommon, whenClosedCallback: () => void): void;
83 protected _raiseLayoutChangedEvent(): void;
84 protected _raiseShownModallyEvent(): void;
85 protected _raiseShowingModallyEvent(): void;
86 private _isEvent;
87 private _disconnectGestureObservers;
88 get borderColor(): string | Color;
89 set borderColor(value: string | Color);
90 get borderTopColor(): Color;
91 set borderTopColor(value: Color);
92 get borderRightColor(): Color;
93 set borderRightColor(value: Color);
94 get borderBottomColor(): Color;
95 set borderBottomColor(value: Color);
96 get borderLeftColor(): Color;
97 set borderLeftColor(value: Color);
98 get borderWidth(): string | CoreTypes.LengthType;
99 set borderWidth(value: string | CoreTypes.LengthType);
100 get borderTopWidth(): CoreTypes.LengthType;
101 set borderTopWidth(value: CoreTypes.LengthType);
102 get borderRightWidth(): CoreTypes.LengthType;
103 set borderRightWidth(value: CoreTypes.LengthType);
104 get borderBottomWidth(): CoreTypes.LengthType;
105 set borderBottomWidth(value: CoreTypes.LengthType);
106 get borderLeftWidth(): CoreTypes.LengthType;
107 set borderLeftWidth(value: CoreTypes.LengthType);
108 get borderRadius(): string | CoreTypes.LengthType;
109 set borderRadius(value: string | CoreTypes.LengthType);
110 get borderTopLeftRadius(): CoreTypes.LengthType;
111 set borderTopLeftRadius(value: CoreTypes.LengthType);
112 get borderTopRightRadius(): CoreTypes.LengthType;
113 set borderTopRightRadius(value: CoreTypes.LengthType);
114 get borderBottomRightRadius(): CoreTypes.LengthType;
115 set borderBottomRightRadius(value: CoreTypes.LengthType);
116 get borderBottomLeftRadius(): CoreTypes.LengthType;
117 set borderBottomLeftRadius(value: CoreTypes.LengthType);
118 get color(): Color;
119 set color(value: Color);
120 get background(): string;
121 set background(value: string);
122 get backgroundColor(): Color;
123 set backgroundColor(value: Color);
124 get backgroundImage(): string | LinearGradient;
125 set backgroundImage(value: string | LinearGradient);
126 get backgroundSize(): string;
127 set backgroundSize(value: string);
128 get backgroundPosition(): string;
129 set backgroundPosition(value: string);
130 get backgroundRepeat(): CoreTypes.BackgroundRepeatType;
131 set backgroundRepeat(value: CoreTypes.BackgroundRepeatType);
132 get boxShadow(): ShadowCSSValues;
133 set boxShadow(value: ShadowCSSValues);
134 get minWidth(): CoreTypes.LengthType;
135 set minWidth(value: CoreTypes.LengthType);
136 get minHeight(): CoreTypes.LengthType;
137 set minHeight(value: CoreTypes.LengthType);
138 get width(): CoreTypes.PercentLengthType;
139 set width(value: CoreTypes.PercentLengthType);
140 get height(): CoreTypes.PercentLengthType;
141 set height(value: CoreTypes.PercentLengthType);
142 get margin(): string | CoreTypes.PercentLengthType;
143 set margin(value: string | CoreTypes.PercentLengthType);
144 get marginLeft(): CoreTypes.PercentLengthType;
145 set marginLeft(value: CoreTypes.PercentLengthType);
146 get marginTop(): CoreTypes.PercentLengthType;
147 set marginTop(value: CoreTypes.PercentLengthType);
148 get marginRight(): CoreTypes.PercentLengthType;
149 set marginRight(value: CoreTypes.PercentLengthType);
150 get marginBottom(): CoreTypes.PercentLengthType;
151 set marginBottom(value: CoreTypes.PercentLengthType);
152 get horizontalAlignment(): CoreTypes.HorizontalAlignmentType;
153 set horizontalAlignment(value: CoreTypes.HorizontalAlignmentType);
154 get verticalAlignment(): CoreTypes.VerticalAlignmentType;
155 set verticalAlignment(value: CoreTypes.VerticalAlignmentType);
156 get visibility(): CoreTypes.VisibilityType;
157 set visibility(value: CoreTypes.VisibilityType);
158 get opacity(): number;
159 set opacity(value: number);
160 get rotate(): number;
161 set rotate(value: number);
162 get rotateX(): number;
163 set rotateX(value: number);
164 get rotateY(): number;
165 set rotateY(value: number);
166 get perspective(): number;
167 set perspective(value: number);
168 get textTransform(): CoreTypes.TextTransformType;
169 set textTransform(value: CoreTypes.TextTransformType);
170 get translateX(): CoreTypes.dip;
171 set translateX(value: CoreTypes.dip);
172 get translateY(): CoreTypes.dip;
173 set translateY(value: CoreTypes.dip);
174 get scaleX(): number;
175 set scaleX(value: number);
176 get scaleY(): number;
177 set scaleY(value: number);
178 get accessible(): boolean;
179 set accessible(value: boolean);
180 get accessibilityHidden(): boolean;
181 set accessibilityHidden(value: boolean);
182 get accessibilityRole(): AccessibilityRole;
183 set accessibilityRole(value: AccessibilityRole);
184 get accessibilityState(): AccessibilityState;
185 set accessibilityState(value: AccessibilityState);
186 get accessibilityLiveRegion(): AccessibilityLiveRegion;
187 set accessibilityLiveRegion(value: AccessibilityLiveRegion);
188 get accessibilityLanguage(): string;
189 set accessibilityLanguage(value: string);
190 get accessibilityMediaSession(): boolean;
191 set accessibilityMediaSession(value: boolean);
192 get iosAccessibilityAdjustsFontSize(): boolean;
193 set iosAccessibilityAdjustsFontSize(value: boolean);
194 get iosAccessibilityMinFontScale(): number;
195 set iosAccessibilityMinFontScale(value: number);
196 get iosAccessibilityMaxFontScale(): number;
197 set iosAccessibilityMaxFontScale(value: number);
198 get automationText(): string;
199 set automationText(value: string);
200 get androidElevation(): number;
201 set androidElevation(value: number);
202 get androidDynamicElevationOffset(): number;
203 set androidDynamicElevationOffset(value: number);
204 originX: number;
205 originY: number;
206 isEnabled: boolean;
207 isUserInteractionEnabled: boolean;
208 iosOverflowSafeArea: boolean;
209 iosOverflowSafeAreaEnabled: boolean;
210 iosIgnoreSafeArea: boolean;
211 get isLayoutValid(): boolean;
212 get cssType(): string;
213 set cssType(type: string);
214 get isLayoutRequired(): boolean;
215 measure(widthMeasureSpec: number, heightMeasureSpec: number): void;
216 layout(left: number, top: number, right: number, bottom: number): void;
217 getMeasuredWidth(): number;
218 getMeasuredHeight(): number;
219 getMeasuredState(): number;
220 setMeasuredDimension(measuredWidth: number, measuredHeight: number): void;
221 requestLayout(): void;
222 abstract onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void;
223 abstract onLayout(left: number, top: number, right: number, bottom: number): void;
224 abstract layoutNativeView(left: number, top: number, right: number, bottom: number): void;
225 static resolveSizeAndState(size: number, specSize: number, specMode: number, childMeasuredState: number): number;
226 static combineMeasuredStates(curState: number, newState: any): number;
227 static layoutChild(parent: ViewDefinition, child: ViewDefinition, left: number, top: number, right: number, bottom: number, setFrame?: boolean): void;
228 static measureChild(parent: ViewCommon, child: ViewCommon, widthMeasureSpec: number, heightMeasureSpec: number): {
229 measuredWidth: number;
230 measuredHeight: number;
231 };
232 _setCurrentMeasureSpecs(widthMeasureSpec: number, heightMeasureSpec: number): boolean;
233 _getCurrentLayoutBounds(): {
234 left: number;
235 top: number;
236 right: number;
237 bottom: number;
238 };
239 /**
240 * Returns two booleans - the first if "boundsChanged" the second is "sizeChanged".
241 */
242 _setCurrentLayoutBounds(left: number, top: number, right: number, bottom: number): {
243 boundsChanged: boolean;
244 sizeChanged: boolean;
245 };
246 eachChild(callback: (child: ViewBase) => boolean): void;
247 eachChildView(callback: (view: ViewDefinition) => boolean): void;
248 _getNativeViewsCount(): number;
249 _eachLayoutView(callback: (View: any) => void): void;
250 focus(): boolean;
251 getSafeAreaInsets(): {
252 left: any;
253 top: any;
254 right: any;
255 bottom: any;
256 };
257 getLocationInWindow(): Point;
258 getLocationOnScreen(): Point;
259 getLocationRelativeTo(otherView: ViewDefinition): Point;
260 getActualSize(): Size;
261 animate(animation: any): am.AnimationPromise;
262 createAnimation(animation: any): am.Animation;
263 _removeAnimation(animation: am.Animation): boolean;
264 resetNativeView(): void;
265 _setNativeViewFrame(nativeView: any, frame: any): void;
266 _getValue(): never;
267 _setValue(): never;
268 _updateEffectiveLayoutValues(parentWidthMeasureSize: number, parentWidthMeasureMode: number, parentHeightMeasureSize: number, parentHeightMeasureMode: number): void;
269 _setNativeClipToBounds(): void;
270 _redrawNativeBackground(value: any): void;
271 _applyBackground(background: any, isBorderDrawable: boolean, onlyColor: boolean, backgroundDrawable: any): void;
272 _onAttachedToWindow(): void;
273 _onDetachedFromWindow(): void;
274 _hasAncestorView(ancestorView: ViewDefinition): boolean;
275 sendAccessibilityEvent(options: Partial<AccessibilityEventOptions>): void;
276 accessibilityAnnouncement(msg?: string): void;
277 accessibilityScreenChanged(): void;
278 setAccessibilityIdentifier(view: any, value: string): void;
279}
280export declare const originXProperty: Property<ViewCommon, number>;
281export declare const originYProperty: Property<ViewCommon, number>;
282export declare const defaultVisualStateProperty: Property<ViewCommon, string>;
283export declare const isEnabledProperty: Property<ViewCommon, boolean>;
284export declare const isUserInteractionEnabledProperty: Property<ViewCommon, boolean>;
285export declare const iosOverflowSafeAreaProperty: Property<ViewCommon, boolean>;
286export declare const iosOverflowSafeAreaEnabledProperty: InheritedProperty<ViewCommon, boolean>;
287export declare const iosIgnoreSafeAreaProperty: InheritedProperty<ViewBase, boolean>;
288export declare const visionHoverStyleProperty: Property<ViewCommon, string | VisionHoverOptions>;
289export declare const testIDProperty: Property<ViewCommon, string>;