net.liftmodules.FoBoTB.snippet.FoBo.Bootstrap.scala Maven / Gradle / Ivy

Go to download
package net.liftmodules.FoBoTB.snippet.FoBo

import scala.xml.{ NodeSeq, Text }
import net.liftweb.util._
import net.liftweb.common._
import net.liftweb.http._
import net.liftweb._
import Helpers._
import net.liftmodules.FoBoTB.lib.{BootstrapSH=>sch}

/**
 * ==Bootstrap v2.x Snippet==
 * 
 * This snippet class contains functions for common transform operations useful when working 
 * with the Bootstrap toolkit.
 * '''Example''' Invoke with 
 * {{{ data-lift="FoBo.Bootstrap.functionName?paramName=paramValue&...." }}} 
 * For more examples see the individual transform functions.
 * @since v1.0
 */
class Bootstrap extends StatefulSnippet with Loggable {

  private lazy val sch = new sch()
  
  def dispatch = {
    case "popover" => popover
    case "tooltip" => tooltip
    case "popoverPreventDefault" => popoverPreventDefault
    case "activateDropdown" => activateDropdown
  }
  
  /**
   * This function sets a popover action on a element.
   *
   * '''Snippet Params:'''
   * 
   *  - '''Param''' ''id'' - The element id 
   *  - '''Param''' ''options'' - The option string see bootstrap documentation for available options.
   * 
   * '''Example''' 
   * {{{  }}}
   * 
   * '''Result:''' This example will result in the following being injected in place of the snippet invocation:
   * {{{
   *    
   * }}}
   */
  def popover = { 
    var id = S.attr("id") openOr "id: NOT DEFINED!?"
    var options = S.attr("options") openOr "" 
    " *" #> sch.popover(id, options)
  }
  
  /**
   * This function sets a tooltip action on a element.
   *
   * '''Snippet Params:'''
   * 
   *  - '''Param''' ''id'' - The element id 
   *  - '''Param''' ''options'' - The option string see bootstrap documentation for available options.
   * 
   * '''Example''' Showing a example element using the tooltip and the actual snippet invocation  
   * {{{
   *  Lift 
   *   
   * }}}
   * 
   * '''Result:''' The script tag with the snippet invocation will result in the following being injected in place of the snippet invocation:
   * {{{
   *    
   * }}}
   */
  def tooltip = { 
    var id = S.attr("id") openOr "id: NOT DEFINED!?"
    var options = S.attr("options") openOr "" 
    " *" #> sch.tooltip(id, options)
  }  
 
  /**
   * This function prevents the default action on a popover element.
   * 
   * '''Snippet Params:'''
   * 
   *  - '''Param''' ''on'' - The element id or something more general like the default value a[rel=popover]
   * 
   * '''Example''' 
   * {{{  }}}
   * 
   * '''Result:''' This example will result in the following being injected in place of the snippet invocation:
   * {{{
   *    
   * }}}
   */  
  def popoverPreventDefault = {
     var on = onTest(S.attr("on") openOr "a[rel=popover]")
    " *" #> sch.popoverPreventDefault(on)
  }

  /**
   * This function loads the dropdown activation
   * 
   * '''Snippet Param:'''
   * 
   * - '''Param''' ''on'' - The element id or class to activate dropdown on 
   * 
   * '''Example'''
   * {{{ 
   *     
   *       :
   *        
   *       
   *     
   * }}}
   * The load event factory has to be registered ones before any activation can be loaded. 
   * 
   * '''Result:''' This example will result in the following being injected in place of the snippet invocation:
   * {{{
   *  
   *  
   * }}}
   * 
   */
  def activateDropdown = {
    var on = S.attr("on") openOr "on: ELEMENT CLASS or ID NOT DEFINED!?"
    " *" #> sch.activateDropdown(on)
  }
  
  private def onTest(on:String):String = on match {
    case  "arelpop" => "a[rel=popover]"
    case  "a[rel" => "a[rel=popover]"
    case _ => on  
  }  
  
}