forked from TextureGroup/Texture
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathASLayoutElementStyle.html
More file actions
executable file
·796 lines (388 loc) · 19.3 KB
/
Copy pathASLayoutElementStyle.html
File metadata and controls
executable file
·796 lines (388 loc) · 19.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASLayoutElementStyle Class Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html"> </a>
</h1>
<p id="developer-home">
<a href="../index.html">AsyncDisplayKit</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To…</option>
<option value="tasks">Tasks</option>
<optgroup label="Properties">
<option value="//api/name/delegate">delegate</option>
<option value="//api/name/height">height</option>
<option value="//api/name/maxHeight">maxHeight</option>
<option value="//api/name/maxLayoutSize">maxLayoutSize</option>
<option value="//api/name/maxSize">maxSize</option>
<option value="//api/name/maxWidth">maxWidth</option>
<option value="//api/name/minHeight">minHeight</option>
<option value="//api/name/minLayoutSize">minLayoutSize</option>
<option value="//api/name/minSize">minSize</option>
<option value="//api/name/minWidth">minWidth</option>
<option value="//api/name/preferredLayoutSize">preferredLayoutSize</option>
<option value="//api/name/preferredSize">preferredSize</option>
<option value="//api/name/width">width</option>
</optgroup>
<optgroup label="Instance Methods">
<option value="//api/name/initWithDelegate:">- initWithDelegate:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASLayoutElementStyle Class Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td>NSObject</td>
</tr><tr>
<th>Conforms to</th>
<td><a href="../Protocols/ASAbsoluteLayoutElement.html">ASAbsoluteLayoutElement</a><br /><a href="../Protocols/ASStackLayoutElement.html">ASStackLayoutElement</a></td>
</tr><tr>
<th>Declared in</th>
<td>ASLayoutElement.h</td>
</tr>
</tbody></table></div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/initWithDelegate:" title="initWithDelegate:"></a>
<h3 class="method-title"><code><a href="#//api/name/initWithDelegate:">– initWithDelegate:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Initializes the layoutElement style with a specified delegate</p>
</div>
<div class="method-subsection method-declaration"><code>- (instancetype)initWithDelegate:(id<ASLayoutElementStyleDelegate>)<em>delegate</em></code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/delegate" title="delegate"></a>
<h3 class="method-title"><code><a href="#//api/name/delegate"> delegate</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The object that acts as the delegate of the style.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, weak, readonly) id<ASLayoutElementStyleDelegate> delegate</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The delegate must adopt the ASLayoutElementStyleDelegate protocol. The delegate is not retained.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/width" title="width"></a>
<h3 class="method-title"><code><a href="#//api/name/width"> width</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The width property specifies the height of the content area of an ASLayoutElement.
The minWidth and maxWidth properties override width.
Defaults to ASDimensionAuto</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASDimension width</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/height" title="height"></a>
<h3 class="method-title"><code><a href="#//api/name/height"> height</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The height property specifies the height of the content area of an ASLayoutElement
The minHeight and maxHeight properties override height.
Defaults to ASDimensionAuto</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASDimension height</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/minHeight" title="minHeight"></a>
<h3 class="method-title"><code><a href="#//api/name/minHeight"> minHeight</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The minHeight property is used to set the minimum height of a given element. It prevents the used value
of the height property from becoming smaller than the value specified for minHeight.
The value of minHeight overrides both maxHeight and height.
Defaults to ASDimensionAuto</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASDimension minHeight</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/maxHeight" title="maxHeight"></a>
<h3 class="method-title"><code><a href="#//api/name/maxHeight"> maxHeight</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The maxHeight property is used to set the maximum height of an element. It prevents the used value of the
height property from becoming larger than the value specified for maxHeight.
The value of maxHeight overrides height, but minHeight overrides maxHeight.
Defaults to ASDimensionAuto</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASDimension maxHeight</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/minWidth" title="minWidth"></a>
<h3 class="method-title"><code><a href="#//api/name/minWidth"> minWidth</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The minWidth property is used to set the minimum width of a given element. It prevents the used value of
the width property from becoming smaller than the value specified for minWidth.
The value of minWidth overrides both maxWidth and width.
Defaults to ASDimensionAuto</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASDimension minWidth</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/maxWidth" title="maxWidth"></a>
<h3 class="method-title"><code><a href="#//api/name/maxWidth"> maxWidth</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The maxWidth property is used to set the maximum width of a given element. It prevents the used value of
the width property from becoming larger than the value specified for maxWidth.
The value of maxWidth overrides width, but minWidth overrides maxWidth.
Defaults to ASDimensionAuto</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASDimension maxWidth</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/preferredSize" title="preferredSize"></a>
<h3 class="method-title"><code><a href="#//api/name/preferredSize"> preferredSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Provides a suggested size for a layout element. If the optional minSize or maxSize are provided,
and the preferredSize exceeds these, the minSize or maxSize will be enforced. If this optional value is not
provided, the layout element’s size will default to it’s intrinsic content size provided calculateSizeThatFits:</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGSize preferredSize</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is optional, but one of either preferredSize or preferredLayoutSize is required
for nodes that either have no intrinsic content size or
should be laid out at a different size than its intrinsic content size. For example, this property could be
set on an ASImageNode to display at a size different from the underlying image size.</p><div class="warning"><p><strong>Warning:</strong> Calling the getter when the size’s width or height are relative will cause an assert.</p></div>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/minSize" title="minSize"></a>
<h3 class="method-title"><code><a href="#//api/name/minSize"> minSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An optional property that provides a minimum size bound for a layout element. If provided, this restriction will
always be enforced. If a parent layout element’s minimum size is smaller than its child’s minimum size, the child’s
minimum size will be enforced and its size will extend out of the layout spec’s.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGSize minSize</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>For example, if you set a preferred relative width of 50% and a minimum width of 200 points on an
element in a full screen container, this would result in a width of 160 points on an iPhone screen. However,
since 160 pts is lower than the minimum width of 200 pts, the minimum width would be used.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/maxSize" title="maxSize"></a>
<h3 class="method-title"><code><a href="#//api/name/maxSize"> maxSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An optional property that provides a maximum size bound for a layout element. If provided, this restriction will
always be enforced. If a child layout element’s maximum size is smaller than its parent, the child’s maximum size will
be enforced and its size will extend out of the layout spec’s.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGSize maxSize</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>For example, if you set a preferred relative width of 50% and a maximum width of 120 points on an
element in a full screen container, this would result in a width of 160 points on an iPhone screen. However,
since 160 pts is higher than the maximum width of 120 pts, the maximum width would be used.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/preferredLayoutSize" title="preferredLayoutSize"></a>
<h3 class="method-title"><code><a href="#//api/name/preferredLayoutSize"> preferredLayoutSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Provides a suggested RELATIVE size for a layout element. An ASLayoutSize uses percentages rather
than points to specify layout. E.g. width should be 50% of the parent’s width. If the optional minLayoutSize or
maxLayoutSize are provided, and the preferredLayoutSize exceeds these, the minLayoutSize or maxLayoutSize
will be enforced. If this optional value is not provided, the layout element’s size will default to its intrinsic content size
provided calculateSizeThatFits:</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASLayoutSize preferredLayoutSize</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/minLayoutSize" title="minLayoutSize"></a>
<h3 class="method-title"><code><a href="#//api/name/minLayoutSize"> minLayoutSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An optional property that provides a minimum RELATIVE size bound for a layout element. If provided, this
restriction will always be enforced. If a parent layout element’s minimum relative size is smaller than its child’s minimum
relative size, the child’s minimum relative size will be enforced and its size will extend out of the layout spec’s.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASLayoutSize minLayoutSize</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/maxLayoutSize" title="maxLayoutSize"></a>
<h3 class="method-title"><code><a href="#//api/name/maxLayoutSize"> maxLayoutSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An optional property that provides a maximum RELATIVE size bound for a layout element. If provided, this
restriction will always be enforced. If a parent layout element’s maximum relative size is smaller than its child’s maximum
relative size, the child’s maximum relative size will be enforced and its size will extend out of the layout spec’s.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) ASLayoutSize maxLayoutSize</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASLayoutElement.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright © 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>