Merge branch 'issue/132' of github.com:smartmobilefactory/FolioReaderKit into issue/133

Author: Hans Seiffert

Example/StoryboardExample/ExampleFolioReaderContainer.swift

@@ -21,7 +21,7 @@ class ExampleFolioReaderContainer: FolioReaderContainer {
 		// Print the chapter ID if one was clicked
 		// A chapter in "The Silver Chair" looks like this "<section class="chapter" title="Chapter I" epub:type="chapter" id="id70364673704880">"
 		// To knwo if a user tapped on a chapter we can listen to events on the class "chapter" and receive the id value
-		let listener = ClassBasedOnClickListener(schemeName: "chaptertapped", className: "chapter", parameterName: "id", onClickAction: { (parameterContent: String?) in
+		let listener = ClassBasedOnClickListener(schemeName: "chaptertapped", querySelector: ".chapter", attributeName: "id", onClickAction: { (parameterContent: String?) in
 			print("chapter with id: " + (parameterContent ?? "-") + " clicked")
 		})
 		config.classBasedOnClickListeners.append(listener)

Source/FolioReaderCenter.swift

@@ -21,6 +21,9 @@ var isScrolling = false
 
 public class FolioReaderCenter: UIViewController, UICollectionViewDelegate, UICollectionViewDataSource {
 
+	/// This delegate receives the events from the current `FolioReaderPage`s delegate.
+	public weak var pageDelegate: FolioReaderPageDelegate?
+
     var collectionView: UICollectionView!
     let collectionViewLayout = UICollectionViewFlowLayout()
     var loadingView: UIActivityIndicatorView!
@@ -1056,7 +1059,7 @@ public class FolioReaderCenter: UIViewController, UICollectionViewDelegate, UICo
 
 extension FolioReaderCenter: FolioReaderPageDelegate {
 
-    func pageDidLoad(page: FolioReaderPage) {
+    public func pageDidLoad(page: FolioReaderPage) {
 
         if let position = FolioReader.defaults.valueForKey(kBookId) as? NSDictionary {
             let pageNumber = position["pageNumber"]! as! Int
@@ -1088,6 +1091,8 @@ extension FolioReaderCenter: FolioReaderPageDelegate {
 			let offsetPoint = self.currentWebViewScrollPositions[page.pageNumber - 1] {
 				page.webView.scrollView.setContentOffset(offsetPoint, animated: false)
 		}
+
+		self.pageDelegate?.pageDidLoad(page)
     }
 }
 

Source/FolioReaderConfig.swift

@@ -52,20 +52,24 @@ public struct ClassBasedOnClickListener {
 	/// The name of the URL scheme which should be used. Note: Make sure that the given `String` is a valid as scheme name.
 	public var schemeName			: String
 
-	/// The HTML class name to which the listener should be added.
-	public var className			: String
+	/// The query selector for the elements which the listener should be added to. See https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector for further information about query selectors.
+	public var querySelector		: String
 
-	/// The name of the parameter whose content should be passed to the `onClickAction` action
-	public var parameterName		: String
+	/// The name of the attribute whose content should be passed to the `onClickAction` action.
+	public var attributeName		: String
+
+	/// Whether the listener should be added to all found elements or only to the first one. See https://developer.mozilla.org/en-US/docs/Web/API/Element/querySelectorAll for further information. The default value is `true`.
+	public var selectAll			: Bool
 
 	/// The closure which will be called if the specified class was clicked.
 	public var onClickAction		: ((parameterContent: String?) -> Void)
 
-	/// Initializes a `ClassBasedOnClickListener` instance. Append it to the `classBasedOnClickListeners` property from the `FolioReaderConfig` to receive on click events.
-	public init(schemeName: String, className: String, parameterName: String, onClickAction: ((parameterContent: String?) -> Void)) {
+	/// Initializes a `ClassBasedOnClickListener` instance. Append it to the `classBasedOnClickListeners` property from the `FolioReaderConfig` to receive on click events. The default `selectAll` value is `true`.
+	public init(schemeName: String, querySelector: String, attributeName: String, selectAll: Bool = true, onClickAction: ((attributeContent: String?) -> Void)) {
 		self.schemeName = schemeName.lowercaseString
-		self.className = className
-		self.parameterName = parameterName
+		self.querySelector = querySelector
+		self.attributeName = attributeName
+		self.selectAll = selectAll
 		self.onClickAction = onClickAction
 	}
 }
@@ -174,6 +178,7 @@ public class FolioReaderConfig: NSObject {
     public var localizedShareAllExcerptsFrom = NSLocalizedString("All excerpts from", comment: "")
     public var localizedShareBy = NSLocalizedString("by", comment: "")
     public var localizedCancel = NSLocalizedString("Cancel", comment: "")
+    public var localizedShare = NSLocalizedString("Share", comment: "")
     public var localizedChooseExisting = NSLocalizedString("Choose existing", comment: "")
     public var localizedTakePhoto = NSLocalizedString("Take Photo", comment: "")
     public var localizedShareImageQuote = NSLocalizedString("Share image quote", comment: "")

Source/FolioReaderPage.swift

@@ -11,7 +11,8 @@ import SafariServices
 import UIMenuItem_CXAImageSupport
 import JSQWebViewController
 
-protocol FolioReaderPageDelegate: class {
+/// Protocol which is used from `FolioReaderPage`s.
+public protocol FolioReaderPageDelegate: class {
     /**
      Notify that page did loaded
 
@@ -23,8 +24,9 @@ protocol FolioReaderPageDelegate: class {
 public class FolioReaderPage: UICollectionViewCell, UIWebViewDelegate, UIGestureRecognizerDelegate {
 
     weak var delegate: FolioReaderPageDelegate?
-    var pageNumber: Int!
-    var webView: UIWebView!
+	/// The index of the current page. Note: The index start at 1!
+	public var pageNumber: Int!
+	var webView: UIWebView!
     private var colorView: UIView!
     private var shouldShowBar = true
     private var menuIsVisible = false
@@ -418,7 +420,7 @@ public class FolioReaderPage: UICollectionViewCell, UIWebViewDelegate, UIGesture
 	private func setupClassBasedOnClickListeners() {
 
 		for listener in readerConfig.classBasedOnClickListeners {
-			self.webView.js("addClassBasedOnClickListener(\"\(listener.schemeName)\", \"\(listener.className)\", \"\(listener.parameterName)\")");
+			self.webView.js("addClassBasedOnClickListener(\"\(listener.schemeName)\", \"\(listener.querySelector)\", \"\(listener.attributeName)\", \"\(listener.selectAll)\")");
 		}
 	}
 }

Source/FolioReaderQuoteShare.swift

@@ -46,7 +46,7 @@ class FolioReaderQuoteShare: UIViewController {
         configureNavBar()
 
         let titleAttrs = [NSForegroundColorAttributeName: readerConfig.tintColor]
-        let share = UIBarButtonItem(title: "Share", style: .Plain, target: self, action: #selector(shareQuote(_:)))
+        let share = UIBarButtonItem(title: readerConfig.localizedShare, style: .Plain, target: self, action: #selector(shareQuote(_:)))
         share.setTitleTextAttributes(titleAttrs, forState: .Normal)
         navigationItem.rightBarButtonItem = share
 

Source/Resources/Bridge.js

@@ -145,7 +145,8 @@ var getRectForSelectedText = function(elm) {
 // Method that call that a hightlight was clicked
 // with URL scheme and rect informations
 var callHighlightURL = function(elm) {
-    var URLBase = "highlight://";
+	event.stopPropagation();
+	var URLBase = "highlight://";
     var currentHighlightRect = getRectForSelectedText(elm);
     thisHighlight = elm;
 
@@ -582,18 +583,28 @@ function wrappingSentencesWithinPTags(){
 
 // Class based onClick listener
 
-function addClassBasedOnClickListener(schemeName, className, parameterName) {
-	// Get all elements with the given className
-	var elements = document.getElementsByClassName(className);
-	for (elementIndex = 0; elementIndex < elements.length; elementIndex++) {
-		var element = elements[elementIndex];
-		// Get the content from the given parameterName
-		var parameterContent = element.getAttribute(parameterName);
-		// Add the on click logic
-		element.setAttribute("onclick", "onClassBasedListenerClick(\"" + schemeName + "\", \"" + parameterContent + "\");");
+function addClassBasedOnClickListener(schemeName, querySelector, attributeName, selectAll) {
+	if (selectAll) {
+		// Get all elements with the given query selector
+		var elements = document.querySelectorAll(querySelector);
+		for (elementIndex = 0; elementIndex < elements.length; elementIndex++) {
+			var element = elements[elementIndex];
+			addClassBasedOnClickListenerToElement(element, schemeName, attributeName);
+		}
+	} else {
+		// Get the first element with the given query selector
+		var element = document.querySelector(querySelector);
+		addClassBasedOnClickListenerToElement(element, schemeName, attributeName);
 	}
 }
 
+function addClassBasedOnClickListenerToElement(element, schemeName, attributeName) {
+	// Get the content from the given attribute name
+	var attributeContent = element.getAttribute(attributeName);
+	// Add the on click logic
+	element.setAttribute("onclick", "onClassBasedListenerClick(\"" + schemeName + "\", \"" + encodeURIComponent(attributeContent) + "\");");
+}
+
 var onClassBasedListenerClick = function(schemeName, parameterContent) {
-	window.location = schemeName + "://" + encodeURIComponent(parameterContent);
+	window.location = schemeName + "://" + parameterContent;
 }