RBBaseExtendView Class Reference

Inherits from UIView
Declared in RBBaseExtendView.h

Overview

A base class for extend views for RBExtendContainerView.

  position

The position of the extend view.

@property (nonatomic, readonly) RBExtendViewPosition position

Declared In

RBBaseExtendView.h

  revealFactor

The current factor by which the extend view is revealed (0 - 1). This takes into account the insetBy value. Reveal factor 1 = (dimension - insetBy) where dimension = width or height depending on the position of the extend view.

@property (nonatomic, readonly) CGFloat revealFactor

Declared In

RBBaseExtendView.h

  openRevealFactor

The reveal factor at which to consider the extend view opened. Default = 1. If you set a openRevealFactor greater than 1 essentially the extend view can never acheive the ‘opened’ state. Setting an extend view openRevealFactor greater than 1 can be useful in certain cicrumstances. For certain scenarios and types of extend views it might be useful to have the open state at a different value e.g. 0.75 (75%).

@property (nonatomic) CGFloat openRevealFactor

Declared In

RBBaseExtendView.h

  state

The state of the extend view

@property (nonatomic, readonly) RBExtendViewState state

Declared In

RBBaseExtendView.h

  animator

The animator to use when opening and closing the extend view. Default = [RBAnimator defaultAnimator].

@property (nonatomic, nonnull) RBAnimator *animator

Declared In

RBBaseExtendView.h

  delegate

A delegate to receive events.

@property (nonatomic, weak, nullable) id<RBExtendViewDelegate> delegate

Declared In

RBBaseExtendView.h

  enabled

Whether or not the extend view is enabled. If it is not enabled then it is hidden and cannot be revealed or opened. Default = YES.

@property (nonatomic) BOOL enabled

Declared In

RBBaseExtendView.h

  closeOnDrag

Whether or not the extend view should close if it is in the open state and the scroll view is dragged in the closing direction. Default = NO.

@property (nonatomic) BOOL closeOnDrag

Declared In

RBBaseExtendView.h

– open

Opens the extend view.

- (void)open

Declared In

RBBaseExtendView.h

– close

Closes the extend view.

- (void)close

Declared In

RBBaseExtendView.h

– exposedFrameForRevealFactor:

Calculates the exposed area of the extend view for the given reveal factor.

- (CGRect)exposedFrameForRevealFactor:(CGFloat)revealFactor

Parameters

revealFactor

The reveal factor.

Return Value

The exposed region of the extend view.

Declared In

RBBaseExtendView.h

– insetBy

How much to inset the extend view by. Default = 0. (The view is placed with no inset and so appears hidden). If you would like the extend view to be partially or fully visible provide an inset > 0. The inset value will show the partial/full extend view by the amount provided in the given position.

- (CGFloat)insetBy

Declared In

RBBaseExtendView.h

– keepExtendedWhenOpen

Whether or not to allow the extend view to remain opened and extended when the opened state is first set. Default = YES.

- (BOOL)keepExtendedWhenOpen

Declared In

RBBaseExtendView.h

– shouldOpen

Called to determine if the extend view may open. Default = YES.

- (BOOL)shouldOpen

Declared In

RBBaseExtendView.h

– willOpen

Called when the extend view will open.

- (void)willOpen

Declared In

RBBaseExtendView.h

– didOpen

Called when the extend view did open.

- (void)didOpen

Declared In

RBBaseExtendView.h

– willClose

Called when the extend view will close.

- (void)willClose

Declared In

RBBaseExtendView.h

– didClose

Called when the extend view did close.

- (void)didClose

Declared In

RBBaseExtendView.h

– positionDidChange

Called when the extend view has been added to indicate the side that is was added to.

- (void)positionDidChange

Declared In

RBBaseExtendView.h

– revealFactorDidChange:from:

Called when the reveal factor has changed.

- (void)revealFactorDidChange:(CGFloat)to from:(CGFloat)from

Parameters

to

The new reveal factor.

from

The previous reveal factor.

Declared In

RBBaseExtendView.h