net.liftmodules.FoBoTB.lib.BootstrapSH.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fobo-twitter-bootstrap_2.6_2.11 Show documentation
fobo-twitter-bootstrap
The newest version!
package net.liftmodules.FoBoTB.lib

import _root_.net.liftweb._
import util.{ Props }
import http._
import common._
import net.liftweb.http._
import net.liftweb.http.js._
import net.liftweb.http.js.JsCmds._
import net.liftweb.http.js.JE.JsRaw
import net.liftweb.http.js.JsCmd


/**
 * ==Script Helper Bootstrap v2.x==
 * Bootstrap script helper is a helper class that implements some commonly 
 * used bootstrap component init/usage script functions. 
 * This convenience script functions is used in the [[net.liftmodules.FoBoTB.snippet.FoBo.Bootstrap]] 
 * snippet but can also be used as a convenience helper in your own customized snippets.
 *  
 * @example If you find that the [[net.liftmodules.FoBoTB.snippet.FoBo.Bootstrap]] snippet dose not fit you exact needs 
 * your can still use the BootstrapSH class to customize your own project snippets.
 * {{{
 *   import net.liftmodules.FoBo.lib.{BootstrapSH=>sch}
 *    :
 *   class MySnippet {
 *     
 *     lazy val sch = new sch()
 *     
 *     def someFunc = {
 *       :
 *       sch.fobohelper(...)
 *       :
 *     }
 *     :
 *   }
 * }}}
 *  
 */
class BootstrapSH() extends ScriptHelper {

    
  /**
   * This function sets a modal action on a element.
   * 
   * @param id - The id of the element for which the modal should occur 
   * @param options - A string list of modal options 
   * 
   */
  def modal(id:String,options:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').modal({%s}); }); """.format(id,options)).cmd
    JsCmds.Script(sc)  
  }  
  
  /**
   * This function sets a manual modal action on a element.
   * 
   * @param id - The id of the element for which the modal should occur 
   * @param action - toggle || show || hide  
   * 
   */
  def modalManualAction(id:String,action:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').modal('%s'); }); """.format(id,action)).cmd
    JsCmds.Script(sc)  
  }    
  
  /**
   * This function will add a load event to activate the dropdown component for a given id.
   * 
   * @param on - The class or id of the element for which the dropdown component should be activated.
   * 
   */
  def activateDropdown(on:String):scala.xml.Node = {
    this.addLoadEvent(JsRaw("""$('%s').dropdown()""".format(on)).cmd)
  }
  
  /**
   * This function sets a scrollspy action on a element.
   * 
   * @param id - The id of the element for which the scrollspy should occur 
   * @param options - A string list of scrollspy options 
   * 
   */
  def scrollspy(id:String,options:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').scrollspy({%s}); }); """.format(id,options)).cmd
    JsCmds.Script(sc)  
  }
  
  /**
   * This function sets a tooltip action on a element.
   * 
   * @param id - The id of the element for which the tooltip should occur 
   * @param options - A string list of tooltip options 
   * 
   */
  def tooltip(id:String,options:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').tooltip({%s}); }); """.format(id,options)).cmd
    JsCmds.Script(sc)  
  }
  
  /**
   * This function sets a manual tooltip action on a element.
   * 
   * @param id - The id of the element for which the tooltip should occur 
   * @param action - toggle || show || hide  
   * 
   */
  def tooltipManualAction(id:String,action:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').tooltip('%s'); }); """.format(id,action)).cmd
    JsCmds.Script(sc)  
  }  
  
  /**
   * This function sets a popover action on a element.
   * 
   * @param id - The id of the element for which the popover should occur 
   * @param options - A string list of popover options 
   * 
   */
  def popover(id:String,options:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').popover({%s}); }); """.format(id,options)).cmd
    JsCmds.Script(sc)  
  } 
  
  /**
   * This function sets a manual popover action on a element.
   * 
   * @param id - The id of the element for which the popover should occur 
   * @param action - toggle || show || hide  
   * 
   */
  def popoverManualAction(id:String,action:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').popover('%s'); }); """.format(id,action)).cmd
    JsCmds.Script(sc)  
  }    
  
  /**
   * This function prevents default action for a click on a popover. 
   * @param on - Can be a id attribute or something more general like the default a[rel=popover] 
   */
  def popoverPreventDefault(on:String="a[rel=popover]"):scala.xml.Node = {
      var sc = JsRaw("""$(function(){$('%s').popover().click(function(e){e.preventDefault()});});""".format(on)).cmd
      JsCmds.Script(sc)  
  }
  
  /**
   * This function sets a collapse action on a element.
   * 
   * @param id - The id of the element for which the collapse should occur 
   * @param options - A string list of collapse options 
   * 
   */
  def collapse(id:String,options:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').collapse({%s}); }); """.format(id,options)).cmd
    JsCmds.Script(sc)  
  } 
  
  /**
   * This function sets a manual collapse action on a element.
   * 
   * @param id - The id of the element for which the collapse should occur 
   * @param action - toggle || show || hide  
   * 
   */
  def collapseManualAction(id:String,action:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').collapse('%s'); }); """.format(id,action)).cmd
    JsCmds.Script(sc)  
  }   
  
  
  /**
   * This function sets a carousel action on a element.
   * 
   * @param id - The id of the element for which the carousel should occur 
   * @param options - A string list of carousel options 
   * 
   */
  def carousel(id:String,options:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').collapse({%s}); }); """.format(id,options)).cmd
    JsCmds.Script(sc)  
  }   
  
  /**
   * This function sets a manual carousel action on a element.
   * 
   * @param id - The id of the element for which the carousel should occur 
   * @param action - cycle || pause || prev || next || number  
   * 
   */
  def carouselManualAction(id:String,action:String=""):scala.xml.Node = {
    var sc = JsRaw("""$(function () { $('%s').collapse('%s'); }); """.format(id,action)).cmd
    JsCmds.Script(sc)  
  }   
  
  /*
   * Generate script block 200
   */
  //def generateScriptBlock020(...)
}