-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathUIView+AutoLayout.m
executable file
·1303 lines (1144 loc) · 56 KB
/
UIView+AutoLayout.m
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
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// UIView+AutoLayout.m
// v1.3.0
// https://github.com/smileyborg/UIView-AutoLayout
//
// Copyright (c) 2012 Richard Turton
// Copyright (c) 2013 Tyler Fox
//
// This code is distributed under the terms and conditions of the MIT license.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//
#import "UIView+AutoLayout.h"
#pragma mark - UIView+AutoLayout
@implementation UIView (AutoLayout)
#pragma mark Factory & Initializer Methods
/**
Creates and returns a new view that does not convert the autoresizing mask into constraints.
*/
+ (instancetype)newAutoLayoutView
{
UIView *view = [self new];
view.translatesAutoresizingMaskIntoConstraints = NO;
return view;
}
/**
Initializes and returns a new view that does not convert the autoresizing mask into constraints.
*/
- (instancetype)initForAutoLayout
{
self = [self init];
if (self) {
self.translatesAutoresizingMaskIntoConstraints = NO;
}
return self;
}
#pragma mark Set Constraint Priority
/**
A global variable that determines the priority of all constraints created and added by this category.
Defaults to Required, will only be a different value while executing a constraints block passed into the
+[UIView autoSetPriority:forConstraints:] method (as that method will reset the value back to Required
before returning).
NOTE: As UIKit is not thread safe, access to this variable is not synchronized (and should only be done
on the main thread).
*/
static UILayoutPriority _al_globalConstraintPriority = UILayoutPriorityRequired;
/**
A global variable that is set to YES while the constraints block passed in to the
+[UIView autoSetPriority:forConstraints:] method is executing.
NOTE: As UIKit is not thread safe, access to this variable is not synchronized (and should only be done
on the main thread).
*/
static BOOL _al_isExecutingConstraintsBlock = NO;
/**
Sets the constraint priority to the given value for all constraints created using the UIView+AutoLayout
category API within the given constraints block.
NOTE: This method will have no effect (and will NOT set the priority) on constraints created or added
using the SDK directly within the block!
@param priority The layout priority to be set on all constraints in the constraints block.
@param block A block of method calls to the UIView+AutoLayout API that create and add constraints.
*/
+ (void)autoSetPriority:(UILayoutPriority)priority forConstraints:(ALConstraintsBlock)block
{
NSAssert(block, @"The constraints block cannot be nil.");
if (block) {
_al_globalConstraintPriority = priority;
_al_isExecutingConstraintsBlock = YES;
block();
_al_isExecutingConstraintsBlock = NO;
_al_globalConstraintPriority = UILayoutPriorityRequired;
}
}
#pragma mark Remove Constraints
/**
Removes the given constraint from the view it has been added to.
@param constraint The constraint to remove.
*/
+ (void)autoRemoveConstraint:(NSLayoutConstraint *)constraint
{
if (constraint.secondItem) {
UIView *commonSuperview = [constraint.firstItem al_commonSuperviewWithView:constraint.secondItem];
while (commonSuperview) {
if ([commonSuperview.constraints containsObject:constraint]) {
[commonSuperview removeConstraint:constraint];
return;
}
commonSuperview = commonSuperview.superview;
}
}
else {
[constraint.firstItem removeConstraint:constraint];
return;
}
NSAssert(nil, @"Failed to remove constraint: %@", constraint);
}
/**
Removes the given constraints from the views they have been added to.
@param constraints The constraints to remove.
*/
+ (void)autoRemoveConstraints:(NSArray *)constraints
{
for (id object in constraints) {
if ([object isKindOfClass:[NSLayoutConstraint class]]) {
[self autoRemoveConstraint:((NSLayoutConstraint *)object)];
} else {
NSAssert(nil, @"All constraints to remove must be instances of NSLayoutConstraint.");
}
}
}
/**
Removes all explicit constraints that affect the view.
WARNING: Apple's constraint solver is not optimized for large-scale constraint removal; you may encounter major performance issues after using this method.
It is not recommended to use this method to "reset" a view for reuse in a different way with new constraints. Create a new view instead.
NOTE: This method preserves implicit constraints, such as intrinsic content size constraints, which you usually do not want to remove.
*/
- (void)autoRemoveConstraintsAffectingView
{
[self autoRemoveConstraintsAffectingViewIncludingImplicitConstraints:NO];
}
/**
Removes all constraints that affect the view, optionally including implicit constraints.
WARNING: Apple's constraint solver is not optimized for large-scale constraint removal; you may encounter major performance issues after using this method.
It is not recommended to use this method to "reset" a view for reuse in a different way with new constraints. Create a new view instead.
NOTE: Implicit constraints are auto-generated lower priority constraints (such as those that attempt to keep a view at
its intrinsic content size by hugging its content & resisting compression), and you usually do not want to remove these.
@param shouldRemoveImplicitConstraints Whether implicit constraints should be removed or skipped.
*/
- (void)autoRemoveConstraintsAffectingViewIncludingImplicitConstraints:(BOOL)shouldRemoveImplicitConstraints
{
NSMutableArray *constraintsToRemove = [NSMutableArray new];
UIView *startView = self;
do {
for (NSLayoutConstraint *constraint in startView.constraints) {
BOOL isImplicitConstraint = [NSStringFromClass([constraint class]) isEqualToString:@"NSContentSizeLayoutConstraint"];
if (shouldRemoveImplicitConstraints || !isImplicitConstraint) {
if (constraint.firstItem == self || constraint.secondItem == self) {
[constraintsToRemove addObject:constraint];
}
}
}
startView = startView.superview;
} while (startView);
[UIView autoRemoveConstraints:constraintsToRemove];
}
/**
Recursively removes all explicit constraints that affect the view and its subviews.
WARNING: Apple's constraint solver is not optimized for large-scale constraint removal; you may encounter major performance issues after using this method.
It is not recommended to use this method to "reset" views for reuse in a different way with new constraints. Create a new view instead.
NOTE: This method preserves implicit constraints, such as intrinsic content size constraints, which you usually do not want to remove.
*/
- (void)autoRemoveConstraintsAffectingViewAndSubviews
{
[self autoRemoveConstraintsAffectingViewAndSubviewsIncludingImplicitConstraints:NO];
}
/**
Recursively removes all constraints that affect the view and its subviews, optionally including implicit constraints.
WARNING: Apple's constraint solver is not optimized for large-scale constraint removal; you may encounter major performance issues after using this method.
It is not recommended to use this method to "reset" views for reuse in a different way with new constraints. Create a new view instead.
NOTE: Implicit constraints are auto-generated lower priority constraints (such as those that attempt to keep a view at
its intrinsic content size by hugging its content & resisting compression), and you usually do not want to remove these.
@param shouldRemoveImplicitConstraints Whether implicit constraints should be removed or skipped.
*/
- (void)autoRemoveConstraintsAffectingViewAndSubviewsIncludingImplicitConstraints:(BOOL)shouldRemoveImplicitConstraints
{
[self autoRemoveConstraintsAffectingViewIncludingImplicitConstraints:shouldRemoveImplicitConstraints];
for (UIView *subview in self.subviews) {
[subview autoRemoveConstraintsAffectingViewAndSubviewsIncludingImplicitConstraints:shouldRemoveImplicitConstraints];
}
}
#pragma mark Center in Superview
/**
Centers the view in its superview.
@return An array of constraints added.
*/
- (NSArray *)autoCenterInSuperview
{
NSMutableArray *constraints = [NSMutableArray new];
[constraints addObject:[self autoAlignAxisToSuperviewAxis:ALAxisHorizontal]];
[constraints addObject:[self autoAlignAxisToSuperviewAxis:ALAxisVertical]];
return constraints;
}
/**
Aligns the view to the same axis of its superview.
@param axis The axis of this view and of its superview to align.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoAlignAxisToSuperviewAxis:(ALAxis)axis
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = self.superview;
NSAssert(superview, @"View's superview must not be nil.\nView: %@", self);
NSLayoutAttribute attribute = [UIView al_attributeForAxis:axis];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:NSLayoutRelationEqual toItem:superview attribute:attribute multiplier:1.0f constant:0.0f];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
#pragma mark Pin Edges to Superview
/**
Pins the given edge of the view to the same edge of the superview with an inset.
@param edge The edge of this view and the superview to pin.
@param inset The amount to inset this view's edge from the superview's edge.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinEdgeToSuperviewEdge:(ALEdge)edge withInset:(CGFloat)inset
{
return [self autoPinEdgeToSuperviewEdge:edge withInset:inset relation:NSLayoutRelationEqual];
}
/**
Pins the given edge of the view to the same edge of the superview with an inset as a maximum or minimum.
@param edge The edge of this view and the superview to pin.
@param inset The amount to inset this view's edge from the superview's edge.
@param relation Whether the inset should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinEdgeToSuperviewEdge:(ALEdge)edge withInset:(CGFloat)inset relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = self.superview;
NSAssert(superview, @"View's superview must not be nil.\nView: %@", self);
if (edge == ALEdgeBottom || edge == ALEdgeRight || edge == ALEdgeTrailing) {
// The bottom, right, and trailing insets (and relations, if an inequality) are inverted to become offsets
inset = -inset;
if (relation == NSLayoutRelationLessThanOrEqual) {
relation = NSLayoutRelationGreaterThanOrEqual;
} else if (relation == NSLayoutRelationGreaterThanOrEqual) {
relation = NSLayoutRelationLessThanOrEqual;
}
}
return [self autoPinEdge:edge toEdge:edge ofView:superview withOffset:inset relation:relation];
}
/**
Pins the edges of the view to the edges of its superview with the given edge insets.
The insets.left corresponds to a leading edge constraint, and insets.right corresponds to a trailing edge constraint.
@param insets The insets for this view's edges from the superview's edges.
@return An array of constraints added.
*/
- (NSArray *)autoPinEdgesToSuperviewEdgesWithInsets:(UIEdgeInsets)insets
{
NSMutableArray *constraints = [NSMutableArray new];
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:insets.top]];
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeLeading withInset:insets.left]];
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeBottom withInset:insets.bottom]];
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeTrailing withInset:insets.right]];
return constraints;
}
/**
Pins 3 of the 4 edges of the view to the edges of its superview with the given edge insets, excluding one edge.
The insets.left corresponds to a leading edge constraint, and insets.right corresponds to a trailing edge constraint.
@param insets The insets for this view's edges from the superview's edges. The inset corresponding to the excluded edge
will be ignored.
@param edge The edge of this view to exclude in pinning to the superview; this method will not apply any constraint to it.
@return An array of constraints added.
*/
- (NSArray *)autoPinEdgesToSuperviewEdgesWithInsets:(UIEdgeInsets)insets excludingEdge:(ALEdge)edge
{
NSMutableArray *constraints = [NSMutableArray new];
if (edge != ALEdgeTop) {
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeTop withInset:insets.top]];
}
if (edge != ALEdgeLeading && edge != ALEdgeLeft) {
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeLeading withInset:insets.left]];
}
if (edge != ALEdgeBottom) {
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeBottom withInset:insets.bottom]];
}
if (edge != ALEdgeTrailing && edge != ALEdgeRight) {
[constraints addObject:[self autoPinEdgeToSuperviewEdge:ALEdgeTrailing withInset:insets.right]];
}
return constraints;
}
#pragma mark Pin Edges
/**
Pins an edge of the view to a given edge of another view.
@param edge The edge of this view to pin.
@param toEdge The edge of the peer view to pin to.
@param peerView The peer view to pin to. Must be in the same view hierarchy as this view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toEdge:(ALEdge)toEdge ofView:(UIView *)peerView
{
return [self autoPinEdge:edge toEdge:toEdge ofView:peerView withOffset:0.0f];
}
/**
Pins an edge of the view to a given edge of another view with an offset.
@param edge The edge of this view to pin.
@param toEdge The edge of the peer view to pin to.
@param peerView The peer view to pin to. Must be in the same view hierarchy as this view.
@param offset The offset between the edge of this view and the edge of the peer view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toEdge:(ALEdge)toEdge ofView:(UIView *)peerView withOffset:(CGFloat)offset
{
return [self autoPinEdge:edge toEdge:toEdge ofView:peerView withOffset:offset relation:NSLayoutRelationEqual];
}
/**
Pins an edge of the view to a given edge of another view with an offset as a maximum or minimum.
@param edge The edge of this view to pin.
@param toEdge The edge of the peer view to pin to.
@param peerView The peer view to pin to. Must be in the same view hierarchy as this view.
@param offset The offset between the edge of this view and the edge of the peer view.
@param relation Whether the offset should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinEdge:(ALEdge)edge toEdge:(ALEdge)toEdge ofView:(UIView *)peerView withOffset:(CGFloat)offset relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = [self al_commonSuperviewWithView:peerView];
NSLayoutAttribute attribute = [UIView al_attributeForEdge:edge];
NSLayoutAttribute toAttribute = [UIView al_attributeForEdge:toEdge];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:relation toItem:peerView attribute:toAttribute multiplier:1.0f constant:offset];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
#pragma mark Align Axes
/**
Aligns an axis of the view to the same axis of another view.
@param axis The axis of this view and the peer view to align.
@param peerView The peer view to align to. Must be in the same view hierarchy as this view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoAlignAxis:(ALAxis)axis toSameAxisOfView:(UIView *)peerView
{
return [self autoAlignAxis:axis toSameAxisOfView:peerView withOffset:0.0f];
}
/**
Aligns an axis of the view to the same axis of another view with an offset.
@param axis The axis of this view and the peer view to align.
@param peerView The peer view to align to. Must be in the same view hierarchy as this view.
@param offset The offset between the axis of this view and the axis of the peer view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoAlignAxis:(ALAxis)axis toSameAxisOfView:(UIView *)peerView withOffset:(CGFloat)offset
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = [self al_commonSuperviewWithView:peerView];
NSLayoutAttribute attribute = [UIView al_attributeForAxis:axis];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:NSLayoutRelationEqual toItem:peerView attribute:attribute multiplier:1.0f constant:offset];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
#pragma mark Match Dimensions
/**
Matches a dimension of the view to a given dimension of another view.
@param dimension The dimension of this view to pin.
@param toDimension The dimension of the peer view to pin to.
@param peerView The peer view to match to. Must be in the same view hierarchy as this view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView
{
return [self autoMatchDimension:dimension toDimension:toDimension ofView:peerView withOffset:0.0f];
}
/**
Matches a dimension of the view to a given dimension of another view with an offset.
@param dimension The dimension of this view to pin.
@param toDimension The dimension of the peer view to pin to.
@param peerView The peer view to match to. Must be in the same view hierarchy as this view.
@param offset The offset between the dimension of this view and the dimension of the peer view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView withOffset:(CGFloat)offset
{
return [self autoMatchDimension:dimension toDimension:toDimension ofView:peerView withOffset:offset relation:NSLayoutRelationEqual];
}
/**
Matches a dimension of the view to a given dimension of another view with an offset as a maximum or minimum.
@param dimension The dimension of this view to pin.
@param toDimension The dimension of the peer view to pin to.
@param peerView The peer view to match to. Must be in the same view hierarchy as this view.
@param offset The offset between the dimension of this view and the dimension of the peer view.
@param relation Whether the offset should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView withOffset:(CGFloat)offset relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = [self al_commonSuperviewWithView:peerView];
NSLayoutAttribute attribute = [UIView al_attributeForDimension:dimension];
NSLayoutAttribute toAttribute = [UIView al_attributeForDimension:toDimension];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:relation toItem:peerView attribute:toAttribute multiplier:1.0f constant:offset];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
/**
Matches a dimension of the view to a multiple of a given dimension of another view.
@param dimension The dimension of this view to pin.
@param toDimension The dimension of the peer view to pin to.
@param peerView The peer view to match to. Must be in the same view hierarchy as this view.
@param multiplier The multiple of the peer view's given dimension that this view's given dimension should be.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier
{
return [self autoMatchDimension:dimension toDimension:toDimension ofView:peerView withMultiplier:multiplier relation:NSLayoutRelationEqual];
}
/**
Matches a dimension of the view to a multiple of a given dimension of another view as a maximum or minimum.
@param dimension The dimension of this view to pin.
@param toDimension The dimension of the peer view to pin to.
@param peerView The peer view to match to. Must be in the same view hierarchy as this view.
@param multiplier The multiple of the peer view's given dimension that this view's given dimension should be.
@param relation Whether the multiple should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoMatchDimension:(ALDimension)dimension toDimension:(ALDimension)toDimension ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = [self al_commonSuperviewWithView:peerView];
NSLayoutAttribute attribute = [UIView al_attributeForDimension:dimension];
NSLayoutAttribute toAttribute = [UIView al_attributeForDimension:toDimension];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:relation toItem:peerView attribute:toAttribute multiplier:multiplier constant:0.0f];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
#pragma mark Set Dimensions
/**
Sets the view to a specific size.
@param size The size to set this view's dimensions to.
@return An array of constraints added.
*/
- (NSArray *)autoSetDimensionsToSize:(CGSize)size
{
NSMutableArray *constraints = [NSMutableArray new];
[constraints addObject:[self autoSetDimension:ALDimensionWidth toSize:size.width]];
[constraints addObject:[self autoSetDimension:ALDimensionHeight toSize:size.height]];
return constraints;
}
/**
Sets the given dimension of the view to a specific size.
@param dimension The dimension of this view to set.
@param size The size to set the given dimension to.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoSetDimension:(ALDimension)dimension toSize:(CGFloat)size
{
return [self autoSetDimension:dimension toSize:size relation:NSLayoutRelationEqual];
}
/**
Sets the given dimension of the view to a specific size as a maximum or minimum.
@param dimension The dimension of this view to set.
@param size The size to set the given dimension to.
@param relation Whether the size should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoSetDimension:(ALDimension)dimension toSize:(CGFloat)size relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
NSLayoutAttribute attribute = [UIView al_attributeForDimension:dimension];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:relation toItem:nil attribute:NSLayoutAttributeNotAnAttribute multiplier:0.0f constant:size];
[self al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
#pragma mark Set Content Compression Resistance & Hugging
/**
Sets the priority of content compression resistance for an axis.
NOTE: This method must only be called from within the block passed into the method +[UIView autoSetPriority:forConstraints:]
@param axis The axis to set the content compression resistance priority for.
*/
- (void)autoSetContentCompressionResistancePriorityForAxis:(ALAxis)axis
{
NSAssert(_al_isExecutingConstraintsBlock, @"%@ should only be called from within the block passed into the method +[UIView autoSetPriority:forConstraints:]", NSStringFromSelector(_cmd));
if (_al_isExecutingConstraintsBlock) {
self.translatesAutoresizingMaskIntoConstraints = NO;
UILayoutConstraintAxis constraintAxis = [UIView al_constraintAxisForAxis:axis];
[self setContentCompressionResistancePriority:_al_globalConstraintPriority forAxis:constraintAxis];
}
}
/**
Sets the priority of content hugging for an axis.
NOTE: This method must only be called from within the block passed into the method +[UIView autoSetPriority:forConstraints:]
@param axis The axis to set the content hugging priority for.
*/
- (void)autoSetContentHuggingPriorityForAxis:(ALAxis)axis
{
NSAssert(_al_isExecutingConstraintsBlock, @"%@ should only be called from within the block passed into the method +[UIView autoSetPriority:forConstraints:]", NSStringFromSelector(_cmd));
if (_al_isExecutingConstraintsBlock) {
self.translatesAutoresizingMaskIntoConstraints = NO;
UILayoutConstraintAxis constraintAxis = [UIView al_constraintAxisForAxis:axis];
[self setContentHuggingPriority:_al_globalConstraintPriority forAxis:constraintAxis];
}
}
#pragma mark Constrain Any Attributes
/**
Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view.
This method can be used to constrain different types of attributes across two views.
@param ALAttribute Any ALEdge, ALAxis, or ALDimension of this view to constrain.
@param toALAttribute Any ALEdge, ALAxis, or ALDimension of the peer view to constrain to.
@param peerView The peer view to constrain to. Must be in the same view hierarchy as this view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)ALAttribute toAttribute:(NSInteger)toALAttribute ofView:(UIView *)peerView
{
return [self autoConstrainAttribute:ALAttribute toAttribute:toALAttribute ofView:peerView withOffset:0.0f];
}
/**
Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with an offset.
This method can be used to constrain different types of attributes across two views.
@param ALAttribute Any ALEdge, ALAxis, or ALDimension of this view to constrain.
@param toALAttribute Any ALEdge, ALAxis, or ALDimension of the peer view to constrain to.
@param peerView The peer view to constrain to. Must be in the same view hierarchy as this view.
@param offset The offset between the attribute of this view and the attribute of the peer view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)ALAttribute toAttribute:(NSInteger)toALAttribute ofView:(UIView *)peerView withOffset:(CGFloat)offset
{
return [self autoConstrainAttribute:ALAttribute toAttribute:toALAttribute ofView:peerView withOffset:offset relation:NSLayoutRelationEqual];
}
/**
Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with an offset as a maximum or minimum.
This method can be used to constrain different types of attributes across two views.
@param ALAttribute Any ALEdge, ALAxis, or ALDimension of this view to constrain.
@param toALAttribute Any ALEdge, ALAxis, or ALDimension of the peer view to constrain to.
@param peerView The peer view to constrain to. Must be in the same view hierarchy as this view.
@param offset The offset between the attribute of this view and the attribute of the peer view.
@param relation Whether the offset should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)ALAttribute toAttribute:(NSInteger)toALAttribute ofView:(UIView *)peerView withOffset:(CGFloat)offset relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = [self al_commonSuperviewWithView:peerView];
NSLayoutAttribute attribute = [UIView al_attributeForALAttribute:ALAttribute];
NSLayoutAttribute toAttribute = [UIView al_attributeForALAttribute:toALAttribute];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:relation toItem:peerView attribute:toAttribute multiplier:1.0f constant:offset];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
/**
Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with a multiplier.
This method can be used to constrain different types of attributes across two views.
@param ALAttribute Any ALEdge, ALAxis, or ALDimension of this view to constrain.
@param toALAttribute Any ALEdge, ALAxis, or ALDimension of the peer view to constrain to.
@param peerView The peer view to constrain to. Must be in the same view hierarchy as this view.
@param multiplier The multiplier between the attribute of this view and the attribute of the peer view.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)ALAttribute toAttribute:(NSInteger)toALAttribute ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier
{
return [self autoConstrainAttribute:ALAttribute toAttribute:toALAttribute ofView:peerView withMultiplier:multiplier relation:NSLayoutRelationEqual];
}
/**
Constrains an attribute (any ALEdge, ALAxis, or ALDimension) of the view to a given attribute of another view with a multiplier as a maximum or minimum.
This method can be used to constrain different types of attributes across two views.
@param ALAttribute Any ALEdge, ALAxis, or ALDimension of this view to constrain.
@param toALAttribute Any ALEdge, ALAxis, or ALDimension of the peer view to constrain to.
@param peerView The peer view to constrain to. Must be in the same view hierarchy as this view.
@param multiplier The multiplier between the attribute of this view and the attribute of the peer view.
@param relation Whether the multiplier should be at least, at most, or exactly equal to the given value.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoConstrainAttribute:(NSInteger)ALAttribute toAttribute:(NSInteger)toALAttribute ofView:(UIView *)peerView withMultiplier:(CGFloat)multiplier relation:(NSLayoutRelation)relation
{
self.translatesAutoresizingMaskIntoConstraints = NO;
UIView *superview = [self al_commonSuperviewWithView:peerView];
NSLayoutAttribute attribute = [UIView al_attributeForALAttribute:ALAttribute];
NSLayoutAttribute toAttribute = [UIView al_attributeForALAttribute:toALAttribute];
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:attribute relatedBy:relation toItem:peerView attribute:toAttribute multiplier:multiplier constant:0.0f];
[superview al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
#pragma mark Pin to Layout Guides
/**
Pins the top edge of the view to the top layout guide of the given view controller with an inset.
For compatibility with iOS 6 (where layout guides do not exist), this method will simply pin the top edge of
the view to the top edge of the given view controller's view with an inset.
@param viewController The view controller whose topLayoutGuide should be used to pin to.
@param inset The amount to inset this view's top edge from the layout guide.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinToTopLayoutGuideOfViewController:(UIViewController *)viewController withInset:(CGFloat)inset
{
if (floor(NSFoundationVersionNumber) <= NSFoundationVersionNumber_iOS_6_1) {
return [self autoPinEdge:ALEdgeTop toEdge:ALEdgeTop ofView:viewController.view withOffset:inset];
} else {
self.translatesAutoresizingMaskIntoConstraints = NO;
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:NSLayoutAttributeTop relatedBy:NSLayoutRelationEqual toItem:viewController.topLayoutGuide attribute:NSLayoutAttributeBottom multiplier:1.0f constant:inset];
[viewController.view al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
}
/**
Pins the bottom edge of the view to the bottom layout guide of the given view controller with an inset.
For compatibility with iOS 6 (where layout guides do not exist), this method will simply pin the bottom edge of
the view to the bottom edge of the given view controller's view with an inset.
@param viewController The view controller whose bottomLayoutGuide should be used to pin to.
@param inset The amount to inset this view's bottom edge from the layout guide.
@return The constraint added.
*/
- (NSLayoutConstraint *)autoPinToBottomLayoutGuideOfViewController:(UIViewController *)viewController withInset:(CGFloat)inset
{
if (floor(NSFoundationVersionNumber) <= NSFoundationVersionNumber_iOS_6_1) {
return [self autoPinEdge:ALEdgeBottom toEdge:ALEdgeBottom ofView:viewController.view withOffset:-inset];
} else {
self.translatesAutoresizingMaskIntoConstraints = NO;
NSLayoutConstraint *constraint = [NSLayoutConstraint constraintWithItem:self attribute:NSLayoutAttributeBottom relatedBy:NSLayoutRelationEqual toItem:viewController.bottomLayoutGuide attribute:NSLayoutAttributeTop multiplier:1.0f constant:-inset];
[viewController.view al_addConstraintUsingGlobalPriority:constraint];
return constraint;
}
}
#pragma mark Internal Helper Methods
/**
Adds the given constraint to this view after setting the constraint's priority to the global constraint priority.
This method is the only one that calls the SDK addConstraint: method directly; all other instances in this category
should use this method to add constraints so that the global priority is correctly set on constraints.
@param constraint The constraint to set the global priority on and then add to this view.
*/
- (void)al_addConstraintUsingGlobalPriority:(NSLayoutConstraint *)constraint
{
constraint.priority = _al_globalConstraintPriority;
[self addConstraint:constraint];
}
/**
Returns the corresponding NSLayoutAttribute for the given ALEdge.
@return The layout attribute for the given edge.
*/
+ (NSLayoutAttribute)al_attributeForEdge:(ALEdge)edge
{
NSLayoutAttribute attribute = NSLayoutAttributeNotAnAttribute;
switch (edge) {
case ALEdgeLeft:
attribute = NSLayoutAttributeLeft;
break;
case ALEdgeRight:
attribute = NSLayoutAttributeRight;
break;
case ALEdgeTop:
attribute = NSLayoutAttributeTop;
break;
case ALEdgeBottom:
attribute = NSLayoutAttributeBottom;
break;
case ALEdgeLeading:
attribute = NSLayoutAttributeLeading;
break;
case ALEdgeTrailing:
attribute = NSLayoutAttributeTrailing;
break;
default:
NSAssert(nil, @"Not a valid ALEdge.");
break;
}
return attribute;
}
/**
Returns the corresponding NSLayoutAttribute for the given ALAxis.
@return The layout attribute for the given axis.
*/
+ (NSLayoutAttribute)al_attributeForAxis:(ALAxis)axis
{
NSLayoutAttribute attribute = NSLayoutAttributeNotAnAttribute;
switch (axis) {
case ALAxisVertical:
attribute = NSLayoutAttributeCenterX;
break;
case ALAxisHorizontal:
attribute = NSLayoutAttributeCenterY;
break;
case ALAxisBaseline:
attribute = NSLayoutAttributeBaseline;
break;
default:
NSAssert(nil, @"Not a valid ALAxis.");
break;
}
return attribute;
}
/**
Returns the corresponding NSLayoutAttribute for the given ALDimension.
@return The layout attribute for the given dimension.
*/
+ (NSLayoutAttribute)al_attributeForDimension:(ALDimension)dimension
{
NSLayoutAttribute attribute = NSLayoutAttributeNotAnAttribute;
switch (dimension) {
case ALDimensionWidth:
attribute = NSLayoutAttributeWidth;
break;
case ALDimensionHeight:
attribute = NSLayoutAttributeHeight;
break;
default:
NSAssert(nil, @"Not a valid ALDimension.");
break;
}
return attribute;
}
/**
Returns the corresponding NSLayoutAttribute for the given ALAttribute.
@return The layout attribute for the given ALAttribute.
*/
+ (NSLayoutAttribute)al_attributeForALAttribute:(NSInteger)ALAttribute
{
NSLayoutAttribute attribute = NSLayoutAttributeNotAnAttribute;
switch (ALAttribute) {
case ALEdgeLeft:
attribute = NSLayoutAttributeLeft;
break;
case ALEdgeRight:
attribute = NSLayoutAttributeRight;
break;
case ALEdgeTop:
attribute = NSLayoutAttributeTop;
break;
case ALEdgeBottom:
attribute = NSLayoutAttributeBottom;
break;
case ALEdgeLeading:
attribute = NSLayoutAttributeLeading;
break;
case ALEdgeTrailing:
attribute = NSLayoutAttributeTrailing;
break;
case ALDimensionWidth:
attribute = NSLayoutAttributeWidth;
break;
case ALDimensionHeight:
attribute = NSLayoutAttributeHeight;
break;
case ALAxisVertical:
attribute = NSLayoutAttributeCenterX;
break;
case ALAxisHorizontal:
attribute = NSLayoutAttributeCenterY;
break;
case ALAxisBaseline:
attribute = NSLayoutAttributeBaseline;
break;
default:
NSAssert(nil, @"Not a valid ALAttribute.");
break;
}
return attribute;
}
/**
Returns the corresponding UILayoutConstraintAxis for the given ALAxis.
@return The constraint axis for the given axis.
*/
+ (UILayoutConstraintAxis)al_constraintAxisForAxis:(ALAxis)axis
{
UILayoutConstraintAxis constraintAxis;
switch (axis) {
case ALAxisVertical:
constraintAxis = UILayoutConstraintAxisVertical;
break;
case ALAxisHorizontal:
case ALAxisBaseline:
constraintAxis = UILayoutConstraintAxisHorizontal;
break;
default:
NSAssert(nil, @"Not a valid ALAxis.");
break;
}
return constraintAxis;
}
/**
Returns the common superview for this view and the given peer view.
Raises an exception if this view and the peer view do not share a common superview.
@return The common superview for the two views.
*/
- (UIView *)al_commonSuperviewWithView:(UIView *)peerView
{
UIView *commonSuperview = nil;
UIView *startView = self;
do {
if ([peerView isDescendantOfView:startView]) {
commonSuperview = startView;
}
startView = startView.superview;
} while (startView && !commonSuperview);
NSAssert(commonSuperview, @"Can't constrain two views that do not share a common superview. Make sure that both views have been added into the same view hierarchy.");
return commonSuperview;
}
/**
Aligns this view to a peer view with an alignment option.
@param peerView The peer view to align to.
@param alignment The alignment option to apply to the two views.
@param axis The axis along which the views are distributed, used to validate the alignment option.
@return The constraint added.
*/
- (NSLayoutConstraint *)al_alignToView:(UIView *)peerView withOption:(NSLayoutFormatOptions)alignment forAxis:(ALAxis)axis
{
NSLayoutConstraint *constraint = nil;
switch (alignment) {
case NSLayoutFormatAlignAllCenterX:
NSAssert(axis == ALAxisVertical, @"Cannot align views that are distributed horizontally with NSLayoutFormatAlignAllCenterX.");
constraint = [self autoAlignAxis:ALAxisVertical toSameAxisOfView:peerView];
break;
case NSLayoutFormatAlignAllCenterY:
NSAssert(axis != ALAxisVertical, @"Cannot align views that are distributed vertically with NSLayoutFormatAlignAllCenterY.");
constraint = [self autoAlignAxis:ALAxisHorizontal toSameAxisOfView:peerView];
break;
case NSLayoutFormatAlignAllBaseline:
NSAssert(axis != ALAxisVertical, @"Cannot align views that are distributed vertically with NSLayoutFormatAlignAllBaseline.");
constraint = [self autoAlignAxis:ALAxisBaseline toSameAxisOfView:peerView];
break;
case NSLayoutFormatAlignAllTop:
NSAssert(axis != ALAxisVertical, @"Cannot align views that are distributed vertically with NSLayoutFormatAlignAllTop.");
constraint = [self autoPinEdge:ALEdgeTop toEdge:ALEdgeTop ofView:peerView];
break;
case NSLayoutFormatAlignAllLeft:
NSAssert(axis == ALAxisVertical, @"Cannot align views that are distributed horizontally with NSLayoutFormatAlignAllLeft.");
constraint = [self autoPinEdge:ALEdgeLeft toEdge:ALEdgeLeft ofView:peerView];
break;
case NSLayoutFormatAlignAllBottom:
NSAssert(axis != ALAxisVertical, @"Cannot align views that are distributed vertically with NSLayoutFormatAlignAllBottom.");
constraint = [self autoPinEdge:ALEdgeBottom toEdge:ALEdgeBottom ofView:peerView];
break;
case NSLayoutFormatAlignAllRight:
NSAssert(axis == ALAxisVertical, @"Cannot align views that are distributed horizontally with NSLayoutFormatAlignAllRight.");
constraint = [self autoPinEdge:ALEdgeRight toEdge:ALEdgeRight ofView:peerView];
break;
case NSLayoutFormatAlignAllLeading:
NSAssert(axis == ALAxisVertical, @"Cannot align views that are distributed horizontally with NSLayoutFormatAlignAllLeading.");
constraint = [self autoPinEdge:ALEdgeLeading toEdge:ALEdgeLeading ofView:peerView];
break;
case NSLayoutFormatAlignAllTrailing:
NSAssert(axis == ALAxisVertical, @"Cannot align views that are distributed horizontally with NSLayoutFormatAlignAllTrailing.");
constraint = [self autoPinEdge:ALEdgeTrailing toEdge:ALEdgeTrailing ofView:peerView];
break;
default:
NSAssert(nil, @"Unsupported alignment option.");
break;
}
return constraint;
}
@end
#pragma mark - NSArray+AutoLayout
@implementation NSArray (AutoLayout)
#pragma mark Constrain Multiple Views
/**
Aligns views in this array to one another along a given edge.
Note: This array must contain at least 2 views, and all views must share a common superview.
@param edge The edge to which the subviews will be aligned.
@return An array of constraints added.
*/
- (NSArray *)autoAlignViewsToEdge:(ALEdge)edge
{
NSAssert([self al_containsMinimumNumberOfViews:2], @"This array must contain at least 2 views.");
NSMutableArray *constraints = [NSMutableArray new];
UIView *previousView = nil;
for (id object in self) {
if ([object isKindOfClass:[UIView class]]) {
UIView *view = (UIView *)object;
view.translatesAutoresizingMaskIntoConstraints = NO;
if (previousView) {
[constraints addObject:[view autoPinEdge:edge toEdge:edge ofView:previousView]];
}
previousView = view;
}
}
return constraints;
}
/**
Aligns views in this array to one another along a given axis.
Note: This array must contain at least 2 views, and all views must share a common superview.