net.liftmodules.fobobs.fobobs.scala Maven / Gradle / Ivy
package net.liftmodules
import _root_.net.liftweb._
import common._
/**
* ==FoBo Bootstrap 3 Toolkit Module==
*
* This FoBo toolkit module provides Bootstrap v3.x API and Resource components to the
* FoBo / FoBo Module, but can also be used as-is, see below for setup information.
*
* If you are using this module via the FoBo/FoBo artifact module see also [[net.liftmodules.fobo]] for setup information.
*
*
* @example To initiate this module for usage in your Lift project set something like the following in
* your projects Lift bootstrap.liftweb.Boot boot method.
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* :
* fobo.Toolkit.init=fobo.Toolkit.Bootstrap336 //or any other companion toolkit object
* }}}
* You may substitute Toolkit for Resource or API and if you wish also adjust the artifact dependencies
* accordingly to include just the FoBo modules you use.
*/
package object fobobs {
override def toString() = {
fobobs.Toolkit.toString() + " " + fobobs.Resource
.toString() + " " + fobobs.API.toString()
}
/**
* Initiate FoBo's Bootstrap 3 Toolkit(s) in you bootstrap liftweb Boot.
* Using the Toolkit initiation you will bring in both the
* toolkit's resources and FoBo/Lift API associated
* with the toolkit.
*
* @example
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Toolkit.init=fobo.Toolkit.[Toolkit Object]
* }}}
* '''Note:''' To see available objects click on the round trait icon in the header of this page.
*/
sealed trait Toolkit
/**
* Initiate FoBo's Bootstrap 3 Resource(s) in you bootstrap liftweb Boot.
*
* @example
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Resource.init=fobo.Resource.[Resource Object]
* }}}
* '''Note:''' To see available objects click on the round trait icon in the header of this page.
*/
sealed trait Resource
/**
* Initiate FoBo's Bootstrap 3 API in you bootstrap liftweb Boot.
*
* @example
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.API.init=fobo.API.[API Object]
* }}}
* '''Note:''' To see available objects click on the round trait icon in the header of this page.
*/
sealed trait API
/*=== Toolkit ============================================*/
object Toolkit extends Toolkit {
//we don't actually need to store the objects (for now) so lets just save
//the object name, we can easily change this if we need to
private type Store = List[String] //List[Toolkit]
private var store: Store = List()
def init: Store = store
def init_=(t: Toolkit): Store = {
store = if (store contains t.toString) store else t.toString :: store
store
}
override def toString() = "fobobs.Toolkit = " + store.toString()
/**
* Enable usage of Bootstrap API and resources version 3․3․7 resource files in your bootstrap liftweb Boot.
* @version 3.3.7
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Toolkit.init=fobo.Toolkit.Bootstrap337
* }}}
* @since v1.7
*/
case object Bootstrap337 extends Toolkit {
net.liftmodules.fobobsapi.API.Bootstrap3
net.liftmodules.fobobsres.Resource.Bootstrap337
}
/**
* Enable usage of Bootstrap API and resources version 3․2․0 resource files in your bootstrap liftweb Boot.
* @version 3.2.0
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Toolkit.init=fobo.Toolkit.Bootstrap320
* }}}
*
*/
case object Bootstrap320 extends Toolkit {
net.liftmodules.fobobsapi.API.Bootstrap3
net.liftmodules.fobobsres.Resource.Bootstrap320
}
/**
* Enable usage of Bootstrap API and resources version 3․1․1 resource files in your bootstrap liftweb Boot.
* @version 3.1.1
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Toolkit.init=fobo.Toolkit.Bootstrap311
* }}}
*
*/
case object Bootstrap311 extends Toolkit {
net.liftmodules.fobobsapi.API.Bootstrap3
net.liftmodules.fobobsres.Resource.Bootstrap311
}
/**
* Enable usage of Bootstrap API and resources version 3․0․1 resource files in your bootstrap liftweb Boot.
* @version 3.0.1
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Toolkit.init=fobo.Toolkit.Bootstrap301
* }}}
*
*/
case object Bootstrap301 extends Toolkit {
net.liftmodules.fobobsapi.API.Bootstrap3
net.liftmodules.fobobsres.Resource.Bootstrap301
}
}
/*=== Resource ============================================*/
object Resource extends Resource {
//we don't actually need to store the objects (for now) so lets just save
//the object name, we can easily change this if we need to
private type Store = List[String] //List[Resource]
private var store: Store = List()
def init: Store = store
def init_=(t: Resource): Store = {
store = if (store contains t.toString) store else t.toString :: store
store
}
override def toString() = "fobobs.Resource = " + store.toString()
/**
* Enable usage of Bootstrap version 3․3․7 resource files in your bootstrap liftweb Boot.
* @version 3.3.7
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Resource.init=fobo.Resource.Bootstrap337
* }}}
* @since v1.7
*/
case object Bootstrap337 extends Resource {
fobobsres.Resource.Bootstrap337
}
/**
* Enable usage of Bootstrap version 3․2․0 resource files in your bootstrap liftweb Boot.
* @version 3.2.0
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Resource.init=fobo.Resource.Bootstrap320
* }}}
*
*/
case object Bootstrap320 extends Resource {
fobobsres.Resource.Bootstrap320
}
/**
* Enable usage of Bootstrap version 3․1․1 resource files in your bootstrap liftweb Boot.
* @version 3.1.1
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Resource.init=fobo.Resource.Bootstrap311
* }}}
*
*/
case object Bootstrap311 extends Resource {
fobobsres.Resource.Bootstrap311
}
/**
* Enable usage of Bootstrap version 3․0․1 resource files in your bootstrap liftweb Boot.
* @version 3.0.1
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.Resource.init=fobo.Resource.Bootstrap301
* }}}
*
*/
case object Bootstrap301 extends Resource {
fobobsres.Resource.Bootstrap301
}
}
/*=== API ============================================*/
object API extends API {
//we don't actually need to store the objects (for now) so lets just save
//the object name, we can easily change this if we need to
private type Store = List[String] //List[API]
private var store: Store = List()
def init: Store = store
def init_=(t: API): Store = {
store = if (store contains t.toString) store else t.toString :: store
store
}
override def toString() = "fobobs.API = " + store.toString()
/**
* Enable usage of FoBo's Bootstrap API 3․x․x in your bootstrap liftweb Boot.
* @version 3.x.x
*
* @example
*
* {{{
* import net.liftmodules.{fobobs => fobo}
* :
* fobo.API.init=fobo.API.Bootstrap3
* }}}
*
*/
case object Bootstrap3 extends API {
fobobsapi.API.Bootstrap3
}
}
/**
* Extends your Lift SiteMap with various common bootstrap menu manipulations such
* as horizontal and vertical menu dividers and menu labels (labels coming soon).
*
* This object should be used in conjunction with the TB* menu builder objects in [[net.liftmodules.fobo.snippet.FoBo]] snippet's.
*
* @example
* {{{
* :
* //add a horizontal menu divider
* divider1 >> LocGroup(...) >> fobobs.BsLocInfo.Divider,
* :
* //add a vertical menu divider
* divider2 >> LocGroup(...) >> fobobs.BsLocInfo.DividerVertical,
* :
* }}}
*/
object BSLocInfo {
private val hd: Box[String] = Full("divider")
private val vd: Box[String] = Full("divider-vertical")
private val nh: Box[String] = Full("nav-header")
private val ltb: Box[String] = Full("_blank")
private val lts: Box[String] = Full("_self")
private val ltp: Box[String] = Full("_parent")
private val ltt: Box[String] = Full("_top")
/**
* Provides a way to specify a horizontal divider for your bootstrap menu in Lift's SiteMap.
*
* @example
* {{{
* val index = Menu.i("Home") / "index"
* :
* val about = Menu.i("About") / "about"
* val divider2 = Menu("divider2") / "divider2" //dummy entry only showing a menu divider
* val navHeader1 = Menu.i("navHeader1") / "navHeader1" //Adds a header (label) to your FoBo.NavList
*
* def sitemap = SiteMap(
* navHeader1 >> LocGroup("nl1") >> fobobs.BSLocInfo.NavHeader,
* index >> LocGroup("top","nl1",...),
* :
* ddLabel >> LocGroup("top",...) >> PlaceHolder submenus(
* about ,
* divider2 >> fobobs.BSLocInfo.Divider,
* contact,
* feedback
* )
* )
* }}}
*/
val Divider = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = hd.map(x => () => x)
}
/**
* Add a vertical divider in your bootstrap menu.
* For a usage example see the Divider val above.
*/
val DividerVertical = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = vd.map(x => () => x)
}
/**
* Add nav header(s) to your bootstrap nav list.
* For a usage example see the NavHeader val above.
*/
val NavHeader = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = nh.map(x => () => x)
}
/**
* Adds target="_blank" to the link
* @since v1.2
*/
val LinkTargetBlank = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = ltb.map(x => () => x)
}
/**
* Adds target="_self" to the link
* @since v1.2
*/
val LinkTargetSelf = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = lts.map(x => () => x)
}
/**
* Adds target="_parent" to the link
* @since v1.2
*/
val LinkTargetParent = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = ltp.map(x => () => x)
}
/**
* Adds target="_top" to the link
* @since v1.2
*/
val LinkTargetTop = new net.liftweb.sitemap.Loc.LocInfo[String] {
def apply() = ltt.map(x => () => x)
}
}
}