Files
Pariece McKinney b14e5cfcb0 Public Release 3.0
2024-03-28 19:39:04 -04:00

447 lines
25 KiB
Objective-C

/*
Copyright (c) 2015, Apple Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. Neither the name of the copyright holder(s) nor the names of any contributors
may be used to endorse or promote products derived from this software without
specific prior written permission. No license is granted to the trademarks of
the copyright holders even if such marks are included in this software.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "ORKStepHeaderView.h"
#import "ORKStepHeaderView_Internal.h"
#import "ORKHelpers_Internal.h"
#import "ORKSkin.h"
#define ORKVerticalContainerLog(...)
@implementation ORKStepHeaderView {
NSLayoutConstraint *_captionMinBottomSpacingConstraint;
NSLayoutConstraint *_captionToInstructionConstraint;
NSLayoutConstraint *_headerZeroHeightConstraint;
NSLayoutConstraint *_illustrationToCaptionBaselineConstraint;
NSLayoutConstraint *_illustrationToCaptionTopConstraint;
NSLayoutConstraint *_instructionMinBottomSpacingConstraint;
NSLayoutConstraint *_instructionToLearnMoreConstraint;
NSLayoutConstraint *_learnMoreToStepViewConstraint;
NSLayoutConstraint *_topToIconImageViewConstraint;
}
- (void)updateCaptionLabelPreferredWidth {
CGFloat sideMargin = ORKGetMetricForWindow(ORKScreenMetricHeadlineSideMargin, self.window);
UIEdgeInsets layoutMargins = self.layoutMargins;
// If we don't do this, sometimes the label doesn't split onto two lines properly.
CGFloat maxLabelLayoutWidth = MAX(self.bounds.size.width - sideMargin * 2 - layoutMargins.left - layoutMargins.right, 0);
_captionLabel.preferredMaxLayoutWidth = maxLabelLayoutWidth;
_instructionLabel.preferredMaxLayoutWidth = maxLabelLayoutWidth;
[self setNeedsUpdateConstraints];
}
- (void)setFrame:(CGRect)frame {
[super setFrame:frame];
[self updateCaptionLabelPreferredWidth];
}
- (void)setBounds:(CGRect)bounds {
[super setBounds:bounds];
[self updateCaptionLabelPreferredWidth];
}
- (void)setLayoutMargins:(UIEdgeInsets)layoutMargins {
[super setLayoutMargins:layoutMargins];
[self updateCaptionLabelPreferredWidth];
}
- (instancetype)initWithFrame:(CGRect)frame {
self = [super initWithFrame:frame];
if (self) {
{
_iconImageView = [UIImageView new];
_iconImageView.contentMode = UIViewContentModeScaleAspectFit;
[self addSubview:_iconImageView];
}
// Text Label
{
_captionLabel = [ORKHeadlineLabel new];
_captionLabel.numberOfLines = 0;
_captionLabel.textAlignment = NSTextAlignmentNatural;
[self addSubview:_captionLabel];
}
{
_learnMoreButton = [ORKTextButton new];
_learnMoreButton.contentHorizontalAlignment = UIControlContentHorizontalAlignmentLeading;
_learnMoreButton.contentEdgeInsets = (UIEdgeInsets){10,0,10,10};
[_learnMoreButton setTitle:nil forState:UIControlStateNormal];
[_learnMoreButton addTarget:self action:@selector(learnMoreAction:) forControlEvents:UIControlEventTouchUpInside];
_learnMoreButton.exclusiveTouch = YES;
_learnMoreButton.titleLabel.lineBreakMode = NSLineBreakByWordWrapping;
_learnMoreButton.titleLabel.textAlignment = NSTextAlignmentNatural;
[self addSubview:_learnMoreButton];
self.learnMoreButtonItem = nil;
}
{
_instructionLabel = [ORKSubheadlineLabel new];
_instructionLabel.numberOfLines = 0;
_instructionLabel.textAlignment = NSTextAlignmentNatural;
[self addSubview:_instructionLabel];
}
[_learnMoreButton setContentHuggingPriority:UILayoutPriorityRequired forAxis:UILayoutConstraintAxisVertical];
[_learnMoreButton setContentCompressionResistancePriority:UILayoutPriorityRequired forAxis:UILayoutConstraintAxisVertical];
#ifdef LAYOUT_DEBUG
_captionLabel.backgroundColor = [[UIColor yellowColor] colorWithAlphaComponent:0.2];
_captionLabel.layer.borderColor = [UIColor yellowColor].CGColor;
_captionLabel.layer.borderWidth = 1.0;
_learnMoreButton.backgroundColor = [[UIColor blueColor] colorWithAlphaComponent:0.2];
_learnMoreButton.layer.borderColor = [UIColor blueColor].CGColor;
_learnMoreButton.layer.borderWidth = 1.0;
_instructionLabel.backgroundColor = [[UIColor greenColor] colorWithAlphaComponent:0.2];
_instructionLabel.layer.borderColor = [UIColor greenColor].CGColor;
_instructionLabel.layer.borderWidth = 1.0;
self.backgroundColor = [[UIColor purpleColor] colorWithAlphaComponent:0.2];
#endif
[self setUpConstraints];
[self setNeedsUpdateConstraints];
}
return self;
}
- (void)willMoveToWindow:(UIWindow *)newWindow {
[super willMoveToWindow:newWindow];
[self updateConstraintConstantsForWindow:newWindow];
[self updateCaptionLabelPreferredWidth];
}
- (void)learnMoreAction:(id)sender {
ORKSuppressPerformSelectorWarning(
(void)[_learnMoreButtonItem.target performSelector:_learnMoreButtonItem.action withObject:self];
);
}
- (void)setLearnMoreButtonItem:(UIBarButtonItem *)learnMoreButtonItem {
_learnMoreButtonItem = learnMoreButtonItem;
[_learnMoreButton setTitle:learnMoreButtonItem.title forState:UIControlStateNormal];
_learnMoreButton.alpha = (learnMoreButtonItem.title.length > 0) ? 1 : 0;
[self updateConstraintConstantsForWindow:self.window];
}
- (void)layoutSubviews {
[super layoutSubviews];
CGRect bounds = self.bounds;
CGRect insetBounds = UIEdgeInsetsInsetRect(bounds, self.layoutMargins);
CGFloat sideMargin = ORKGetMetricForWindow(ORKScreenMetricLearnMoreButtonSideMargin, self.window);
_learnMoreButton.titleLabel.preferredMaxLayoutWidth = insetBounds.size.width - sideMargin * 2;
}
const CGFloat IconHeight = 60;
- (void)updateConstraintConstantsForWindow:(UIWindow *)window {
static const CGFloat AssumedNavBarHeight = 44;
static const CGFloat AssumedStatusBarHeight = 20;
const CGFloat IconBottomToCaptionBaseline = ORKGetMetricForWindow(ORKScreenMetricIconImageViewToCaptionBaseline, window);;
const CGFloat TopToIconTop = ORKGetMetricForWindow(ORKScreenMetricTopToIconImageViewTop, window);
BOOL hasIconView = _iconImageView.image != nil;
const CGFloat IllustrationToCaptionBaseline = ORKGetMetricForWindow(ORKScreenMetricIllustrationToCaptionBaseline, window);
const CGFloat TopToCaptionBaseline = hasIconView ? (IconBottomToCaptionBaseline + IconHeight + TopToIconTop) : (ORKGetMetricForWindow(ORKScreenMetricTopToCaptionBaseline, window) - AssumedStatusBarHeight - AssumedNavBarHeight);
const CGFloat CaptionBaselineToInstructionBaseline_WithInstruction = ORKGetMetricForWindow(ORKScreenMetricCaptionBaselineToInstructionBaseline, window);
const CGFloat CaptionBaselineToInstructionBaseline_NoInstruction = MIN(26, CaptionBaselineToInstructionBaseline_WithInstruction); // Not part of spec
const CGFloat InstructionBaselineToLearnMoreBaseline = ORKGetMetricForWindow(ORKScreenMetricInstructionBaselineToLearnMoreBaseline, window);
const CGFloat LearnMoreBaselineToStepViewTop = ORKGetMetricForWindow(ORKScreenMetricLearnMoreBaselineToStepViewTop, window);
const CGFloat InstructionBaselineToStepViewTopWithNoLearnMore = ORKGetMetricForWindow(ORKScreenMetricLearnMoreBaselineToStepViewTopWithNoLearnMore, window);
BOOL hasCaptionLabel = _captionLabel.text.length > 0 || hasIconView;
BOOL hasInstructionLabel = _instructionLabel.text.length > 0;
BOOL hasLearnMoreButton = (_learnMoreButton.alpha > 0);
ORKVerticalContainerLog(@"hasCaption=%@ hasInstruction=%@ hasLearnMore=%@", @(hasCaption), @(hasInstruction), @(hasLearnMore));
// If one label is empty and the other is not, then allow the empty label to shrink to nothing
// and the other label to grow to fill
UILayoutPriority captionVerticalHugging = hasCaptionLabel && !hasInstructionLabel ? UILayoutPriorityDefaultLow - 1 : UILayoutPriorityDefaultLow;
UILayoutPriority instructionVerticalHugging = hasInstructionLabel && !hasCaptionLabel ? UILayoutPriorityDefaultLow - 1 : UILayoutPriorityDefaultLow;
[_captionLabel setContentHuggingPriority:captionVerticalHugging forAxis:UILayoutConstraintAxisVertical];
[_instructionLabel setContentHuggingPriority:instructionVerticalHugging forAxis:UILayoutConstraintAxisVertical];
{
_headerZeroHeightConstraint.active = !(hasCaptionLabel || hasInstructionLabel || hasLearnMoreButton || hasIconView);
}
{
_illustrationToCaptionBaselineConstraint.constant = _hasContentAbove ? IllustrationToCaptionBaseline : TopToCaptionBaseline;
_illustrationToCaptionBaselineConstraint.active = hasCaptionLabel;
_illustrationToCaptionTopConstraint.constant = 0;
_illustrationToCaptionTopConstraint.active = !hasCaptionLabel;
}
{
_topToIconImageViewConstraint.active = hasIconView;
_topToIconImageViewConstraint.constant = TopToIconTop;
}
{
_captionToInstructionConstraint.constant = hasInstructionLabel ? CaptionBaselineToInstructionBaseline_WithInstruction : CaptionBaselineToInstructionBaseline_NoInstruction;
}
{
_instructionToLearnMoreConstraint.constant = hasLearnMoreButton ? InstructionBaselineToLearnMoreBaseline : 0;
}
{
_learnMoreToStepViewConstraint.constant = LearnMoreBaselineToStepViewTop;
_learnMoreToStepViewConstraint.active = hasLearnMoreButton;
}
{
_captionMinBottomSpacingConstraint.active = hasCaptionLabel && !(hasLearnMoreButton || hasInstructionLabel);
}
{
_instructionMinBottomSpacingConstraint.constant = InstructionBaselineToStepViewTopWithNoLearnMore;
_instructionMinBottomSpacingConstraint.active = hasInstructionLabel && !(hasLearnMoreButton);
}
}
- (void)setHasContentAbove:(BOOL)hasContentAbove {
_hasContentAbove = hasContentAbove;
[self setNeedsUpdateConstraints];
}
- (void)setUpConstraints {
NSMutableArray *constraints = [NSMutableArray array];
// Fill all available horizontal space
NSLayoutConstraint *widthConstraint = [NSLayoutConstraint constraintWithItem:self
attribute:NSLayoutAttributeWidth
relatedBy:NSLayoutRelationEqual
toItem:nil
attribute:NSLayoutAttributeNotAnAttribute
multiplier:1.0
constant:ORKScreenMetricMaxDimension];
widthConstraint.priority = UILayoutPriorityDefaultLow - 1;
[constraints addObject:widthConstraint];
NSArray *views = @[_iconImageView, _captionLabel, _instructionLabel, _learnMoreButton];
[_iconImageView setContentHuggingPriority:UILayoutPriorityFittingSizeLevel forAxis:UILayoutConstraintAxisHorizontal];
[_captionLabel setContentHuggingPriority:UILayoutPriorityFittingSizeLevel forAxis:UILayoutConstraintAxisHorizontal];
[_instructionLabel setContentHuggingPriority:UILayoutPriorityFittingSizeLevel forAxis:UILayoutConstraintAxisHorizontal];
[_learnMoreButton setContentHuggingPriority:UILayoutPriorityFittingSizeLevel forAxis:UILayoutConstraintAxisHorizontal];
ORKEnableAutoLayoutForViews(views);
{
_topToIconImageViewConstraint = [NSLayoutConstraint constraintWithItem:_iconImageView
attribute:NSLayoutAttributeTop
relatedBy:NSLayoutRelationEqual
toItem:self
attribute:NSLayoutAttributeTop
multiplier:1.0
constant:40.0];
[constraints addObject:_topToIconImageViewConstraint];
[constraints addObject:[NSLayoutConstraint constraintWithItem:_iconImageView
attribute:NSLayoutAttributeWidth
relatedBy:NSLayoutRelationEqual
toItem:_iconImageView
attribute:NSLayoutAttributeHeight
multiplier:1.0
constant:0.0]];
[constraints addObject:[NSLayoutConstraint constraintWithItem:_iconImageView
attribute:NSLayoutAttributeLeft
relatedBy:NSLayoutRelationEqual
toItem:self
attribute:NSLayoutAttributeLeft
multiplier:1.0
constant:0.0]];
[constraints addObject:[NSLayoutConstraint constraintWithItem:_iconImageView
attribute:NSLayoutAttributeWidth
relatedBy:NSLayoutRelationLessThanOrEqual
toItem:nil
attribute:NSLayoutAttributeNotAnAttribute
multiplier:1.0
constant:IconHeight]];
}
{
_captionToInstructionConstraint = [NSLayoutConstraint constraintWithItem:_instructionLabel
attribute:NSLayoutAttributeFirstBaseline
relatedBy:NSLayoutRelationEqual
toItem:_captionLabel
attribute:NSLayoutAttributeLastBaseline
multiplier:1.0
constant:36.0];
[constraints addObject:_captionToInstructionConstraint];
}
{
_instructionToLearnMoreConstraint = [NSLayoutConstraint constraintWithItem:_learnMoreButton
attribute:NSLayoutAttributeFirstBaseline
relatedBy:NSLayoutRelationEqual
toItem:_instructionLabel
attribute:NSLayoutAttributeLastBaseline
multiplier:1.0
constant:30.0];
[constraints addObject:_instructionToLearnMoreConstraint];
}
{
_illustrationToCaptionBaselineConstraint = [NSLayoutConstraint constraintWithItem:_captionLabel
attribute:NSLayoutAttributeFirstBaseline
relatedBy:NSLayoutRelationEqual
toItem:self
attribute:NSLayoutAttributeTop
multiplier:1.0
constant:44.0];
_illustrationToCaptionBaselineConstraint.priority = UILayoutPriorityRequired - 1;
[constraints addObject:_illustrationToCaptionBaselineConstraint];
}
{
_illustrationToCaptionTopConstraint = [NSLayoutConstraint constraintWithItem:_captionLabel
attribute:NSLayoutAttributeTop
relatedBy:NSLayoutRelationEqual
toItem:self
attribute:NSLayoutAttributeTop
multiplier:1.0
constant:0.0];
_illustrationToCaptionTopConstraint.priority = UILayoutPriorityRequired - 1;
[constraints addObject:_illustrationToCaptionTopConstraint];
}
{
_learnMoreToStepViewConstraint = [NSLayoutConstraint constraintWithItem:self
attribute:NSLayoutAttributeBottom
relatedBy:NSLayoutRelationEqual
toItem:_learnMoreButton
attribute:NSLayoutAttributeLastBaseline
multiplier:1.0
constant:44.0];
_learnMoreToStepViewConstraint.priority = UILayoutPriorityRequired - 1;
[constraints addObject:_learnMoreToStepViewConstraint];
}
{
_captionMinBottomSpacingConstraint = [NSLayoutConstraint constraintWithItem:self
attribute:NSLayoutAttributeBottom
relatedBy:NSLayoutRelationEqual
toItem:_captionLabel
attribute:NSLayoutAttributeLastBaseline
multiplier:1.0
constant:44.0];
_captionMinBottomSpacingConstraint.priority = UILayoutPriorityDefaultHigh - 1;
[constraints addObject:_captionMinBottomSpacingConstraint];
}
{
_instructionMinBottomSpacingConstraint = [NSLayoutConstraint constraintWithItem:self
attribute:NSLayoutAttributeBottom
relatedBy:NSLayoutRelationEqual
toItem:_instructionLabel
attribute:NSLayoutAttributeLastBaseline
multiplier:1.0
constant:44.0];
_instructionMinBottomSpacingConstraint.priority = UILayoutPriorityDefaultHigh - 2;
[constraints addObject:_instructionMinBottomSpacingConstraint];
}
for (UIView *view in views) {
if (view != _iconImageView) {
[constraints addObject:[NSLayoutConstraint constraintWithItem:view
attribute:NSLayoutAttributeLeft
relatedBy:NSLayoutRelationEqual
toItem:self
attribute:NSLayoutAttributeLeftMargin
multiplier:1.0
constant:0.0]];
[constraints addObject:[NSLayoutConstraint constraintWithItem:view
attribute:NSLayoutAttributeRight
relatedBy:NSLayoutRelationEqual
toItem:self
attribute:NSLayoutAttributeRightMargin
multiplier:1.0
constant:0.0]];
}
NSLayoutConstraint *bottomConstraint = [NSLayoutConstraint constraintWithItem:view
attribute:NSLayoutAttributeBottom
relatedBy:NSLayoutRelationLessThanOrEqual
toItem:self
attribute:NSLayoutAttributeBottom
multiplier:1.0
constant:0.0];
bottomConstraint.priority = UILayoutPriorityDefaultHigh;
// All views must fit inside, vertically
[constraints addObject:bottomConstraint];
[constraints addObject:[NSLayoutConstraint constraintWithItem:view
attribute:NSLayoutAttributeTop
relatedBy:NSLayoutRelationGreaterThanOrEqual
toItem:self
attribute:NSLayoutAttributeTop
multiplier:1.0
constant:0.0]];
}
{
// This constraint will only be set active if there is no content.
// Priority is less than required, so that if it is temporarily active it doesn't cause an
// exception.
_headerZeroHeightConstraint = [NSLayoutConstraint constraintWithItem:self
attribute:NSLayoutAttributeHeight
relatedBy:NSLayoutRelationEqual
toItem:nil
attribute:NSLayoutAttributeNotAnAttribute
multiplier:1.0
constant:0.0];
_headerZeroHeightConstraint.priority = UILayoutPriorityRequired - 1;
[constraints addObject:_headerZeroHeightConstraint];
}
[NSLayoutConstraint activateConstraints:constraints];
}
- (void)updateConstraints {
[self updateConstraintConstantsForWindow:self.window];
[super updateConstraints];
}
@end