PSPDFOutlineCell


@interface PSPDFOutlineCell : PSPDFTableViewCell

Single cell for the outline controller.


                        
                        
                        -configureWithOutlineElement:documentProvider:

Configures the cell. The documentProvider is required to resolve the outline actions to page labels.

Declaration

Objective-C

- (void)
configureWithOutlineElement:(nonnull PSPDFOutlineElement *)outlineElement
           documentProvider:(nullable PSPDFDocumentProvider *)documentProvider;

Swift

func configure(with outlineElement: PSPDFOutlineElement, documentProvider: PSPDFDocumentProvider?)


                        
                        
                        outlineElement

Single outline element.

Declaration

Objective-C

@property (readonly, nonatomic, nullable) PSPDFOutlineElement *outlineElement;

Swift

var outlineElement: PSPDFOutlineElement? { get }


                        
                        
                        pageLabelString

The resolved page label.

Declaration

Objective-C

@property (readonly, copy, nonatomic, nullable) NSString *pageLabelString;

Swift

var pageLabelString: String? { get }


                        
                        
                        delegate

Delegate for cell button.

Declaration

Objective-C

@property (readwrite, nonatomic) id<PSPDFOutlineCellDelegate> _Nullable delegate;

Swift

@IBOutlet weak var delegate: PSPDFOutlineCellDelegate? { get set }


                        
                        
                        showExpandCollapseButton

Shows the expand/collapse button.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) BOOL showExpandCollapseButton;

Swift

var showExpandCollapseButton: Bool { get set }


                        
                        
                        showPageLabel

Enables the page label on the right side of the cell.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) BOOL showPageLabel;

Swift

var showPageLabel: Bool { get set }

SubclassingHooks


                        
                        
                        disclosureButton

Button that controls expanding and collapsing of cells.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) UIButton *_Nonnull disclosureButton;

Swift

var disclosureButton: UIButton { get set }


                        
                        
                        nameLabel

The label displayed containing the outline name.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) UILabel *_Nonnull nameLabel;

Swift

var nameLabel: UILabel { get set }


                        
                        
                        pageLabel

The page label displayed on the right side. Only valid if showPageLabel is set.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) UILabel *_Nonnull pageLabel;

Swift

var pageLabel: UILabel { get set }

+fontForOutlineElement:
Subclass to change the font of nameLabel. Default is UIFontTextStyleSubheadline for level 0 and UIFontTextStyleBody for level > 0. This also respects the fontTraits of outlineElement.
Declaration
Objective-C

+ (nonnull UIFont *)fontForOutlineElement: (nullable PSPDFOutlineElement *)outlineElement;
Swift

class func font(for outlineElement: PSPDFOutlineElement?) -> UIFont


                        
                        
                        +pageLabelFontForOutlineElement:

Subclass to change the font of pageLabel. Default is UIFontTextStyleSubheadline.

Declaration

Objective-C

+ (nonnull UIFont *)pageLabelFontForOutlineElement:
    (nullable PSPDFOutlineElement *)outlineElement;

Swift

class func pageLabelFont(for outlineElement: PSPDFOutlineElement?) -> UIFont

-updateDisclosureButton
Set transform according to expansion state.
Declaration
Objective-C

- (void)updateDisclosureButton;
Swift

func updateDisclosureButton()
-expandOrCollapse
Button action. Animates and calls the delegate.
Declaration
Objective-C

- (void)expandOrCollapse;
Swift

func expandOrCollapse()


                        
                        
                        maximumNumberOfLines

Should be changed in PSPDFOutlineViewController.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) NSUInteger maximumNumberOfLines;

Swift

var maximumNumberOfLines: UInt { get set }


                        
                        
                        outlineIntentLeftOffset

Should be changed in PSPDFOutlineViewController.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) CGFloat outlineIntentLeftOffset;

Swift

var outlineIntentLeftOffset: CGFloat { get set }


                        
                        
                        outlineIndentMultiplier

Should be changed in PSPDFOutlineViewController.

Declaration

Objective-C

@property (assign, readwrite, nonatomic) CGFloat outlineIndentMultiplier;

Swift

var outlineIndentMultiplier: CGFloat { get set }

Deprecated


                        
                        
                        +heightForCellWithOutlineElement:documentProvider:constrainedToSize:outlineIntentLeftOffset:outlineIntentMultiplier:showPageLabel:

Dynamically calculates the height for a cell.

Declaration

Objective-C

+ (CGFloat)heightForCellWithOutlineElement:
               (nonnull PSPDFOutlineElement *)outlineElement
                          documentProvider:
                              (nullable PSPDFDocumentProvider *)documentProvider
                         constrainedToSize:(CGSize)constraintSize
                   outlineIntentLeftOffset:(CGFloat)leftOffset
                   outlineIntentMultiplier:(CGFloat)multiplier
                             showPageLabel:(BOOL)showPageLabel;

Swift

class func heightForCell(with outlineElement: PSPDFOutlineElement, documentProvider: PSPDFDocumentProvider?, constrainedTo constraintSize: CGSize, outlineIntentLeftOffset leftOffset: CGFloat, outlineIntentMultiplier multiplier: CGFloat, showPageLabel: Bool) -> CGFloat