Bootstrap component abstraction.

Mainly used to factoryze CSS treatments. Can be used in the future to handle generic stuff like attributes or escaping.

TODO merge with html::HTMTag without init conflict?

HTMLTag requires the main init to pass a tagname, this was so much verbose here.

Introduced properties

fun css_classes: Array[String]

html :: BSComponent :: css_classes

CSS classes to add on this element.
protected fun css_classes=(css_classes: nullable Array[String])

html :: BSComponent :: css_classes=

CSS classes to add on this element.
init defaultinit(css_classes: nullable Array[String])

html :: BSComponent :: defaultinit

fun render_css_classes: String

html :: BSComponent :: render_css_classes

Render self css clases as a class attribute.

Redefined properties

redef type SELF: BSComponent

html $ BSComponent :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun add(element: Writable)

template :: Template :: add

Append an element (String, other Template, etc.) at the end of the template.
fun add_all(elements: Collection[Writable])

template :: Template :: add_all

Append a bunch of elements at the end of the template.
fun add_list(elements: Collection[Writable], sep: Writable, last_sep: Writable)

template :: Template :: add_list

Append a bunch of elements at the end of the template with separations.
fun addn(element: Writable)

template :: Template :: addn

Append element and the end of the template then append a "\n".
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun css_classes: Array[String]

html :: BSComponent :: css_classes

CSS classes to add on this element.
protected fun css_classes=(css_classes: nullable Array[String])

html :: BSComponent :: css_classes=

CSS classes to add on this element.
init defaultinit(css_classes: nullable Array[String])

html :: BSComponent :: defaultinit

fun force_render

template :: Template :: force_render

Call rendering, if not already done
fun freeze

template :: Template :: freeze

Disable further modification: no more add is allowed
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
fun is_frozen: Bool

template :: Template :: is_frozen

Is the template allowing more modification (add)
protected fun is_frozen=(is_frozen: Bool)

template :: Template :: is_frozen=

Is the template allowing more modification (add)
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun new_sub: Template

template :: Template :: new_sub

Return a new basic template that is automatically added in self (using add)
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun render_css_classes: String

html :: BSComponent :: render_css_classes

Render self css clases as a class attribute.
protected fun rendering

template :: Template :: rendering

Service used to render the content of the template.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun write_to(stream: Writer)

core :: Writable :: write_to

Write itself to a stream
fun write_to_bytes: Bytes

core :: Writable :: write_to_bytes

Like write_to but return a new Bytes (may be quite large)
fun write_to_file(filepath: String)

core :: Writable :: write_to_file

Like write_to but take care of creating the file
fun write_to_string: String

core :: Writable :: write_to_string

Like write_to but return a new String (may be quite large).
package_diagram html::BSComponent BSComponent template::Template Template html::BSComponent->template::Template core::Writable Writable template::Template->core::Writable ...core::Writable ... ...core::Writable->core::Writable html::Link Link html::Link->html::BSComponent html::Header Header html::Header->html::BSComponent html::HTMLList HTMLList html::HTMLList->html::BSComponent html::ListItem ListItem html::ListItem->html::BSComponent html::BSIcon BSIcon html::BSIcon->html::BSComponent html::BSLabel BSLabel html::BSLabel->html::BSComponent html::BSBadge BSBadge html::BSBadge->html::BSComponent html::BSPageHeader BSPageHeader html::BSPageHeader->html::BSComponent html::BSAlert BSAlert html::BSAlert->html::BSComponent html::BSPanel BSPanel html::BSPanel->html::BSComponent html::OrderedList OrderedList html::OrderedList->html::HTMLList html::UnorderedList UnorderedList html::UnorderedList->html::HTMLList html::OrderedList... ... html::OrderedList...->html::OrderedList html::UnorderedList... ... html::UnorderedList...->html::UnorderedList

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Writable

core :: Writable

Things that can be efficienlty written to a Writer

Parents

class Template

template :: Template

Templates are simple hierarchical pieces of text used for efficient stream writing.

Children

class BSAlert

html :: BSAlert

A Bootstrap alert component.
class BSBadge

html :: BSBadge

A Bootstrap badge component.
class BSIcon

html :: BSIcon

A Boostrap icon.
class BSLabel

html :: BSLabel

A Bootstrap label component.
class BSPageHeader

html :: BSPageHeader

A Bootstrap page header component.
class BSPanel

html :: BSPanel

A Bootstrap panel component.
abstract class HTMLList

html :: HTMLList

An abstract HTML list.
class Header

html :: Header

A <h1> to <h6> tag.
class ListItem

html :: ListItem

A <li> tag.

Descendants

class BSBreadCrumbs

html :: BSBreadCrumbs

A Bootstrap breadcrumbs component.
class OrderedList

html :: OrderedList

A <ol> list tag.
class UnorderedList

html :: UnorderedList

A <ul> list tag.

Class definitions

html $ BSComponent
# Bootstrap component abstraction.
#
# Mainly used to factoryze CSS treatments.
# Can be used in the future to handle generic stuff like attributes or escaping.
#
# TODO merge with html::HTMTag without init conflict?
# HTMLTag requires the main init to pass a tagname,
# this was so much verbose here.
abstract class BSComponent
	super Template

	# CSS classes to add on this element.
	var css_classes = new Array[String] is optional

	# Render `self` css clases as a `class` attribute.
	fun render_css_classes: String do
		if css_classes.is_empty then return ""
		return " class=\"{css_classes.join(" ")}\""
	end
end
lib/html/bootstrap.nit:22,1--41,3