YLPagesScrollView Class Reference
Inherits from | YLScrollView : UIScrollView |
Declared in | YLPagesScrollView.h YLPagesScrollView.m |
Overview
Subclass of YLScrollView which is used when page-curl animations are enabled. Unlike YLScrollView there’s only one instance of YLPagesScrollView which manages all page views.
Tasks
Other Methods
-
pagesViewController
Reference to YLPagesViewController which is a subclass of UIPageViewController.
property
Initialization
-
– initWithFrame:pdfController:
Initializes a YLPagesScrollView instance and returns it to the caller.
Display Methods
-
– showPage:animated:
Used to navigate to a specific page.
Other Methods
-
– setDocumentMode:
Document mode of the parent YLPDFViewController instance.
-
– setDocumentLead:
Document lead of the parent YLPDFViewController instance.
-
– displayDocument:withPage:
Use this function to setup this YLScrollView instance.
-
– updateForSearchResults
See YLPageView for the description of this function.
-
– zoomInAnimated:
Zooms in. The amount of zoom is calculated dynamically when minimum and maximum zoom levels are calculated. The ZOOM_LEVELS value defined in YLGlobal.h determines the amount of zoom levels.
-
– zoomOutAnimated:
Zooms out. The amount of zoom is calculated dynamically when minimum and maximum zoom levels are calculated. The ZOOM_LEVELS value defined in YLGlobal.h determines the amount of zoom levels.
-
– updateContentViewsWithFrame:
Called by the parent YLPDFViewController to change the frame of this view.
Properties
pagesViewController
Reference to YLPagesViewController which is a subclass of UIPageViewController.
@property (nonatomic, readonly) YLPagesViewController *pagesViewController
Discussion
Reference to YLPagesViewController which is a subclass of UIPageViewController.
Declared In
YLPagesScrollView.h
Instance Methods
displayDocument:withPage:
Use this function to setup this YLScrollView instance.
- (void)displayDocument:(YLDocument *)document withPage:(NSUInteger)page
Parameters
- document
Reference to the document.
- page
Page number starting from 0.
Discussion
Use this function to setup this YLScrollView instance.
Declared In
YLScrollView.h
initWithFrame:pdfController:
Initializes a YLPagesScrollView instance and returns it to the caller.
- (id)initWithFrame:(CGRect)frame pdfController:(YLPDFViewController *)controller
Parameters
- frame
Frame of this view.
- controller
Reference to the parent YLPDFViewController instance.
Return Value
An initialized YLPagesScrollView instance.
Discussion
Initializes a YLPagesScrollView instance and returns it to the caller.
Declared In
YLPagesScrollView.h
setDocumentLead:
Document lead of the parent YLPDFViewController instance.
- (void)setDocumentLead:(YLDocumentLead)documentLead
Discussion
Document lead of the parent YLPDFViewController instance.
Declared In
YLScrollView.h
setDocumentMode:
Document mode of the parent YLPDFViewController instance.
- (void)setDocumentMode:(YLDocumentMode)documentMode
Discussion
Document mode of the parent YLPDFViewController instance.
Declared In
YLScrollView.h
showPage:animated:
Used to navigate to a specific page.
- (void)showPage:(NSUInteger)page animated:(BOOL)animated
Parameters
- page
Page number starting from 0.
- animated
Boolean value that enables/disables animation.
Discussion
Used to navigate to a specific page.
Declared In
YLPagesScrollView.h
updateContentViewsWithFrame:
Called by the parent YLPDFViewController to change the frame of this view.
- (void)updateContentViewsWithFrame:(CGRect)frame
Parameters
- frame
New frame for this view.
Discussion
Called by the parent YLPDFViewController to change the frame of this view.
Declared In
YLScrollView.h
updateForSearchResults
See YLPageView for the description of this function.
- (void)updateForSearchResults
See Also
See YLPageView for the description of this function.
Declared In
YLScrollView.h
zoomInAnimated:
Zooms in. The amount of zoom is calculated dynamically when minimum and maximum zoom levels are calculated. The ZOOM_LEVELS value defined in YLGlobal.h determines the amount of zoom levels.
- (void)zoomInAnimated:(BOOL)animated
Parameters
- animated
Boolean value that enables/disables animation.
Discussion
Zooms in. The amount of zoom is calculated dynamically when minimum and maximum zoom levels are calculated. The ZOOM_LEVELS value defined in YLGlobal.h determines the amount of zoom levels.
Declared In
YLScrollView.h
zoomOutAnimated:
Zooms out. The amount of zoom is calculated dynamically when minimum and maximum zoom levels are calculated. The ZOOM_LEVELS value defined in YLGlobal.h determines the amount of zoom levels.
- (void)zoomOutAnimated:(BOOL)animated
Parameters
- animated
Boolean value that enables/disables animation.
Discussion
Zooms out. The amount of zoom is calculated dynamically when minimum and maximum zoom levels are calculated. The ZOOM_LEVELS value defined in YLGlobal.h determines the amount of zoom levels.
Declared In
YLScrollView.h