A <h1> to <h6> tag.

Not really a Bootstrap component but used in other components that it required its own abstraction.

Example:

var h1 = new Header(1, "Title")
assert h1.write_to_string == "<h1>Title</h1>"

With subtext:

var h6 = new Header(6, "Title", "with subtext")
assert h6.write_to_string == "<h6>Title<small>with subtext</small></h6>"

Introduced properties

init defaultinit(level: Int, text: Writable, subtext: nullable Writable, id: nullable String, css_classes: nullable Array[String])

html :: Header :: defaultinit

fun id: nullable String

html :: Header :: id

Optional id.
fun id=(id: nullable String)

html :: Header :: id=

Optional id.
fun level: Int

html :: Header :: level

Header level between 1 and 6.
protected fun level=(level: Int)

html :: Header :: level=

Header level between 1 and 6.
fun subtext: nullable Writable

html :: Header :: subtext

Optional subtext.
fun subtext=(subtext: nullable Writable)

html :: Header :: subtext=

Optional subtext.
fun text: Writable

html :: Header :: text

Displayed text.
protected fun text=(text: Writable)

html :: Header :: text=

Displayed text.

Redefined properties

redef type SELF: Header

html $ Header :: SELF

Type of this instance, automatically specialized in every class
redef fun rendering

html $ Header :: rendering

Service used to render the content of the template.

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(level: Int, text: Writable, subtext: nullable Writable, id: nullable String, css_classes: nullable Array[String])

html :: Header :: defaultinit

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.
fun id: nullable String

html :: Header :: id

Optional id.
fun id=(id: nullable String)

html :: Header :: id=

Optional id.
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 level: Int

html :: Header :: level

Header level between 1 and 6.
protected fun level=(level: Int)

html :: Header :: level=

Header level between 1 and 6.
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
fun subtext: nullable Writable

html :: Header :: subtext

Optional subtext.
fun subtext=(subtext: nullable Writable)

html :: Header :: subtext=

Optional subtext.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun text: Writable

html :: Header :: text

Displayed text.
protected fun text=(text: Writable)

html :: Header :: text=

Displayed text.
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::Header Header html::BSComponent BSComponent html::Header->html::BSComponent template::Template Template html::BSComponent->template::Template ...template::Template ... ...template::Template->template::Template

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
class Template

template :: Template

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

core :: Writable

Things that can be efficienlty written to a Writer

Parents

abstract class BSComponent

html :: BSComponent

Bootstrap component abstraction.

Class definitions

html $ Header
# A `<h1>` to `<h6>` tag.
#
# Not really a Bootstrap component but used in other components
# that it required its own abstraction.
#
# Example:
# ~~~
# var h1 = new Header(1, "Title")
# assert h1.write_to_string == "<h1>Title</h1>"
# ~~~
#
# With subtext:
# ~~~
# var h6 = new Header(6, "Title", "with subtext")
# assert h6.write_to_string == "<h6>Title<small>with subtext</small></h6>"
# ~~~
class Header
	super BSComponent
	autoinit(level, text, subtext, id, css_classes)

	# Header level between 1 and 6.
	var level: Int

	# Displayed text.
	var text: Writable

	# Optional subtext.
	var subtext: nullable Writable = null is optional, writable

	# Optional id.
	var id: nullable String = null is optional, writable

	redef fun rendering do
		add "<h{level}{render_css_classes}>{text.write_to_string}"
		var subtext = self.subtext
		if subtext != null then add "<small>{subtext.write_to_string}</small>"
		add "</h{level}>"
	end
end
lib/html/bootstrap.nit:80,1--118,3